Class EquirectangularTilesAdapter

Adapter for tiled panoramas

Hierarchy (View Summary)

AbstractAdapter<
    EquirectangularTilesPanorama
    | EquirectangularMultiTilesPanorama,
    EquirectangularTilesPanoData,
    Texture,
    Group,
>
- EquirectangularTilesAdapter

Constructors

constructor

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

Properties

adapter

adapter: EquirectangularAdapter

`Readonly`SPHERE_HORIZONTAL_SEGMENTS

SPHERE_HORIZONTAL_SEGMENTS: number

`Readonly`SPHERE_SEGMENTS

SPHERE_SEGMENTS: number

`Protected` `Readonly`viewer

viewer: Viewer

`Static` `Readonly`id

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

Unique identifier of the adapter

`Static` `Readonly`supportsDownload

supportsDownload: false

Indicates if the adapter supports panorama download natively

`Static` `Readonly`VERSION

VERSION: string = PKG_VERSION

Expected version of the core DO NOT USE on custom adapters

Methods

createMesh

createMesh(panoData: EquirectangularTilesPanoData): Group
Creates the mesh
Parameters
- panoData: EquirectangularTilesPanoData
Returns Group
Overrides AbstractAdapter.createMesh
- Defined in equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts:255

destroy

destroy(): void
Destroys the adapter

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

disposeMesh

disposeMesh(group: Group): void
Cleanup a mesh from memory
Parameters
- group: Group
Returns void
Overrides AbstractAdapter.disposeMesh
- Defined in equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts:337

disposeTexture

disposeTexture(__namedParameters: EquirectangularTilesTextureData): void
Clear a loaded texture from memory
Parameters
- __namedParameters: EquirectangularTilesTextureData
Returns void
Overrides AbstractAdapter.disposeTexture
- Defined in equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts:333

init

init(): void
Initializes the adapter

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

loadTexture

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

setTexture

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

setTextureOpacity

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

sphericalCoordsToTextureCoords

sphericalCoordsToTextureCoords(
position: Position,
data: EquirectangularTilesPanoData,
): PanoramaPosition
Converts spherical radians coordinates to pixel texture coordinates
Parameters
- position: Position
- data: EquirectangularTilesPanoData
Returns PanoramaPosition
Throws
PSVError when the current adapter does not support texture coordinates
Overrides AbstractAdapter.sphericalCoordsToTextureCoords
- Defined in equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts:206

supportsPreload

supportsPreload(
    panorama:
        | EquirectangularTilesPanorama
        | EquirectangularMultiTilesPanorama,
): 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:198

supportsTransition

supportsTransition(
    panorama:
        | EquirectangularTilesPanorama
        | EquirectangularMultiTilesPanorama,
): 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:194

textureCoordsToSphericalCoords

textureCoordsToSphericalCoords(
point: PanoramaPosition,
data: EquirectangularTilesPanoData,
): Position
Converts pixel texture coordinates to spherical radians coordinates
Parameters
- point: PanoramaPosition
- data: EquirectangularTilesPanoData
Returns Position
Throws
PSVError when the current adapter does not support texture coordinates
Overrides AbstractAdapter.textureCoordsToSphericalCoords
- Defined in equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts:202

Class EquirectangularTilesAdapter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EquirectangularTilesAdapter

Properties

adapter

ReadonlySPHERE_HORIZONTAL_SEGMENTS

ReadonlySPHERE_SEGMENTS

Protected Readonlyviewer

Static Readonlyid

Static ReadonlysupportsDownload

Static ReadonlyVERSION

Methods

createMesh

Parameters

Returns Group

destroy

Returns void

disposeMesh

Parameters

Returns void

disposeTexture

Parameters

Returns void

init

Returns void

loadTexture

Parameters

Returns Promise<EquirectangularTilesTextureData>

setTexture

Parameters

Returns void

setTextureOpacity

Parameters

Returns void

sphericalCoordsToTextureCoords

Parameters

Returns PanoramaPosition

Throws

supportsPreload

Parameters

Returns boolean

supportsTransition

Parameters

Returns boolean

textureCoordsToSphericalCoords

Parameters

Returns Position

Throws

Settings

On This Page

`Readonly`SPHERE_HORIZONTAL_SEGMENTS

`Readonly`SPHERE_SEGMENTS

`Protected` `Readonly`viewer

`Static` `Readonly`id

`Static` `Readonly`supportsDownload

`Static` `Readonly`VERSION