Class EquirectangularTilesAdapter

Adapter for tiled panoramas

Hierarchy

AbstractAdapter<EquirectangularTilesPanorama | EquirectangularMultiTilesPanorama, Texture, PanoData>
- EquirectangularTilesAdapter

Index

Constructors

constructor

new EquirectangularTilesAdapter(viewer, config): EquirectangularTilesAdapter
Parameters
- viewer: Viewer
- config: EquirectangularTilesAdapterConfig
Returns EquirectangularTilesAdapter
Overrides AbstractAdapter.constructor
- Defined in equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts:128

Properties

`Readonly` SPHERE_HORIZONTAL_SEGMENTS

SPHERE_HORIZONTAL_SEGMENTS: number

`Readonly` SPHERE_SEGMENTS

SPHERE_SEGMENTS: number

`Protected` `Readonly` viewer

viewer: Viewer

`Static` `Readonly` VERSION

VERSION: string = PKG_VERSION

Expected version of the core DO NOT USE on custom adapters

`Static` `Readonly` id

id: "equirectangular-tiles" = 'equirectangular-tiles'

Unique identifier of the adapter

`Static` `Readonly` supportsDownload

supportsDownload: false = false

Indicates if the adapter supports panorama download natively

Methods

createMesh

createMesh(scale?): EquirectangularMesh
Creates the mesh
Parameters
- scale: number = 1
Returns EquirectangularMesh
Overrides AbstractAdapter.createMesh
- Defined in equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts:239

destroy

destroy(): void
Destroys the adapter

Returns void
Overrides AbstractAdapter.destroy
- Defined in equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts:154

disposeTexture

disposeTexture(textureData): void
Clear a loaded texture from memory
Parameters
- textureData: TextureData<Texture>
Returns void
Overrides AbstractAdapter.disposeTexture
- Defined in equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts:316

init

init(): void
Initializes the adapter

Returns void
Overrides AbstractAdapter.init
- Defined in equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts:147

loadTexture

loadTexture(panorama, loader?): Promise<EquirectangularTexture>
Loads the panorama texture
Parameters
- panorama: EquirectangularTilesPanorama | EquirectangularMultiTilesPanorama
- loader: boolean = true
Returns Promise<EquirectangularTexture>
Overrides AbstractAdapter.loadTexture
- Defined in equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts:196

setTexture

setTexture(mesh, textureData, transition): void
Applies the base texture and starts the loading of tiles
Parameters
- mesh: EquirectangularMesh
- textureData: EquirectangularTexture
- transition: boolean
Returns void
Overrides AbstractAdapter.setTexture
- Defined in equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts:273

setTextureOpacity

setTextureOpacity(mesh, opacity): void
Changes the opacity of the mesh
Parameters
- mesh: EquirectangularMesh
- opacity: number
Returns void
Overrides AbstractAdapter.setTextureOpacity
- Defined in equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts:311

sphericalCoordsToTextureCoords

sphericalCoordsToTextureCoords(position, data): PanoramaPosition
Converts spherical radians coordinates to pixel texture coordinates
Parameters
- position: Position
- data: PanoData
Returns PanoramaPosition

Throws
PSVError when the current adapter does not support texture coordinates
Overrides AbstractAdapter.sphericalCoordsToTextureCoords
- Defined in equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts:192

supportsPreload

supportsPreload(panorama): boolean
Indicates if the adapter supports preload of a panorama
Parameters
- panorama: EquirectangularTilesPanorama | EquirectangularMultiTilesPanorama
Returns boolean
Overrides AbstractAdapter.supportsPreload
- Defined in equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts:184

supportsTransition

supportsTransition(panorama): boolean
Indicates if the adapter supports transitions between panoramas
Parameters
- panorama: EquirectangularTilesPanorama | EquirectangularMultiTilesPanorama
Returns boolean
Overrides AbstractAdapter.supportsTransition
- Defined in equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts:180

textureCoordsToSphericalCoords

textureCoordsToSphericalCoords(point, data): Position
Converts pixel texture coordinates to spherical radians coordinates
Parameters
- point: PanoramaPosition
- data: PanoData
Returns Position

Throws
PSVError when the current adapter does not support texture coordinates
Overrides AbstractAdapter.textureCoordsToSphericalCoords
- Defined in equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts:188

Class EquirectangularTilesAdapter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

viewer: Viewer

config: EquirectangularTilesAdapterConfig

Returns EquirectangularTilesAdapter

Properties

Readonly SPHERE_HORIZONTAL_SEGMENTS

Readonly SPHERE_SEGMENTS

Protected Readonly viewer

Static Readonly VERSION

Static Readonly id

Static Readonly supportsDownload

Methods

createMesh

Parameters

scale: number = 1

Returns EquirectangularMesh

destroy

Returns void

disposeTexture

Parameters

textureData: TextureData<Texture>

Returns void

init

Returns void

loadTexture

Parameters

panorama: EquirectangularTilesPanorama | EquirectangularMultiTilesPanorama

loader: boolean = true

Returns Promise<EquirectangularTexture>

setTexture

Parameters

mesh: EquirectangularMesh

textureData: EquirectangularTexture

transition: boolean

Returns void

setTextureOpacity

Parameters

mesh: EquirectangularMesh

opacity: number

Returns void

sphericalCoordsToTextureCoords

Parameters

position: Position

data: PanoData

Returns PanoramaPosition

Throws

supportsPreload

Parameters

panorama: EquirectangularTilesPanorama | EquirectangularMultiTilesPanorama

Returns boolean

supportsTransition

Parameters

panorama: EquirectangularTilesPanorama | EquirectangularMultiTilesPanorama

Returns boolean

textureCoordsToSphericalCoords

Parameters

point: PanoramaPosition

data: PanoData

Returns Position

Throws

Settings

Member Visibility

Theme

On This Page

`Readonly` SPHERE_HORIZONTAL_SEGMENTS

`Readonly` SPHERE_SEGMENTS

`Protected` `Readonly` viewer

`Static` `Readonly` VERSION

`Static` `Readonly` id

`Static` `Readonly` supportsDownload