Class AbstractAdapter<TPanorama, TData, TTexture, TMesh>`Abstract`

Base class for adapters

Type Parameters

TPanorama
type of the panorama object
TData
type of the panorama metadata
TTexture
type of the loaded texture
TMesh extends Object3D
type of the mesh

Hierarchy (view full)

AbstractAdapter
- EquirectangularAdapter

Index

Constructors

Properties

viewer id supportsDownload VERSION

Methods

createMesh destroy disposeMesh disposeTexture init loadTexture setTexture setTextureOpacity sphericalCoordsToTextureCoords supportsPreload supportsTransition textureCoordsToSphericalCoords

Constructors

constructor

new AbstractAdapter<TPanorama, TData, TTexture, TMesh>(viewer): AbstractAdapter<TPanorama, TData, TTexture, TMesh>
Type Parameters
- TPanorama
- TData
- TTexture
- TMesh extends Object3D<Object3DEventMap>
Parameters
- viewer: Viewer
Returns AbstractAdapter<TPanorama, TData, TTexture, TMesh>
- Defined in packages/core/src/adapters/AbstractAdapter.ts:30

Properties

`Protected` `Readonly`viewer

viewer: Viewer

`Static` `Readonly`id

id: string

Unique identifier of the adapter

`Static` `Readonly`supportsDownload

supportsDownload: boolean = false

Indicates if the adapter supports panorama download natively

`Static` `Readonly`VERSION

VERSION: string

Expected version of the core DO NOT USE on custom adapters

Methods

`Abstract`createMesh

createMesh(panoData): TMesh
Creates the mesh
Parameters
- panoData: TData
Returns TMesh
- Defined in packages/core/src/adapters/AbstractAdapter.ts:95

destroy

destroy(): void
Destroys the adapter

Returns void
- Defined in packages/core/src/adapters/AbstractAdapter.ts:42

`Abstract`disposeMesh

disposeMesh(mesh): void
Cleanup a mesh from memory
Parameters
- mesh: TMesh
Returns void
- Defined in packages/core/src/adapters/AbstractAdapter.ts:115

`Abstract`disposeTexture

disposeTexture(textureData): void
Clear a loaded texture from memory
Parameters
- textureData: TextureData<TTexture, TPanorama, TData>
Returns void
- Defined in packages/core/src/adapters/AbstractAdapter.ts:110

init

init(): void
Initializes the adapter

Returns void
- Defined in packages/core/src/adapters/AbstractAdapter.ts:36

`Abstract`loadTexture

loadTexture(panorama, loader?, newPanoData?, useXmpPanoData?): Promise<TextureData<TTexture, TPanorama, TData>>
Loads the panorama texture
Parameters
- panorama: TPanorama
- Optionalloader: boolean
- OptionalnewPanoData: PanoData | PanoDataProvider
- OptionaluseXmpPanoData: boolean
Returns Promise<TextureData<TTexture, TPanorama, TData>>
- Defined in packages/core/src/adapters/AbstractAdapter.ts:85

`Abstract`setTexture

setTexture(mesh, textureData, transition): void
Applies the texture to the mesh
Parameters
- mesh: TMesh
- textureData: TextureData<TTexture, TPanorama, TData>
- transition: boolean
Returns void
- Defined in packages/core/src/adapters/AbstractAdapter.ts:100

`Abstract`setTextureOpacity

setTextureOpacity(mesh, opacity): void
Changes the opacity of the mesh
Parameters
- mesh: TMesh
- opacity: number
Returns void
- Defined in packages/core/src/adapters/AbstractAdapter.ts:105

sphericalCoordsToTextureCoords

sphericalCoordsToTextureCoords(position, data): PanoramaPosition
Converts spherical radians coordinates to pixel texture coordinates
Parameters
- position: Position
- data: TData
Returns PanoramaPosition
Throws
PSVError when the current adapter does not support texture coordinates
- Defined in packages/core/src/adapters/AbstractAdapter.ts:78

supportsPreload

supportsPreload(panorama): boolean
Indicates if the adapter supports preload of a panorama
Parameters
- panorama: TPanorama
Returns boolean
- Defined in packages/core/src/adapters/AbstractAdapter.ts:58

supportsTransition

supportsTransition(panorama): boolean
Indicates if the adapter supports transitions between panoramas
Parameters
- panorama: TPanorama
Returns boolean
- Defined in packages/core/src/adapters/AbstractAdapter.ts:49

textureCoordsToSphericalCoords

textureCoordsToSphericalCoords(point, data): Position
Converts pixel texture coordinates to spherical radians coordinates
Parameters
- point: PanoramaPosition
- data: TData
Returns Position
Throws
PSVError when the current adapter does not support texture coordinates
- Defined in packages/core/src/adapters/AbstractAdapter.ts:68