Class EquirectangularAdapter

Adapter for equirectangular panoramas

Hierarchy (View Summary)

AbstractAdapter<
    string
    | EquirectangularPanorama,
    PanoData,
    Texture,
    EquirectangularMesh,
>
- EquirectangularAdapter
  - DualFisheyeAdapter

Index

Constructors

constructor

new EquirectangularAdapter(
viewer: Viewer,
config?: EquirectangularAdapterConfig,
): EquirectangularAdapter
Parameters
- viewer: Viewer
- Optionalconfig: EquirectangularAdapterConfig
Returns EquirectangularAdapter
Overrides AbstractAdapter.constructor
- Defined in packages/core/src/adapters/EquirectangularAdapter.ts:87

Properties

`Readonly`SPHERE_HORIZONTAL_SEGMENTS

SPHERE_HORIZONTAL_SEGMENTS: number

`Readonly`SPHERE_SEGMENTS

SPHERE_SEGMENTS: number

`Protected` `Readonly`viewer

viewer: Viewer

`Static` `Readonly`id

id: string = 'equirectangular'

Unique identifier of the adapter

`Static` `Readonly`supportsDownload

supportsDownload: boolean = true

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: PanoData): EquirectangularMesh
Creates the mesh
Parameters
- panoData: PanoData
Returns EquirectangularMesh
Overrides AbstractAdapter.createMesh
- Defined in packages/core/src/adapters/EquirectangularAdapter.ts:255

destroy

destroy(): void
Destroys the adapter

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

disposeMesh

disposeMesh(mesh: EquirectangularMesh): void
Cleanup a mesh from memory
Parameters
- mesh: EquirectangularMesh
Returns void
Overrides AbstractAdapter.disposeMesh
- Defined in packages/core/src/adapters/EquirectangularAdapter.ts:290

disposeTexture

disposeTexture(__namedParameters: EquirectangularTextureData): void
Clear a loaded texture from memory
Parameters
- __namedParameters: EquirectangularTextureData
Returns void
Overrides AbstractAdapter.disposeTexture
- Defined in packages/core/src/adapters/EquirectangularAdapter.ts:286

init

init(): void
Initializes the adapter

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

loadTexture

loadTexture(
    panorama: string | EquirectangularPanorama,
    loader?: boolean,
    newPanoData?: PanoData | PanoDataProvider,
    useXmpPanoData?: boolean,
): Promise<EquirectangularTextureData>
Loads the panorama texture
Parameters
- panorama: string | EquirectangularPanorama
- loader: boolean = true
- OptionalnewPanoData: PanoData | PanoDataProvider
- useXmpPanoData: boolean = ...
Returns Promise<EquirectangularTextureData>
Overrides AbstractAdapter.loadTexture
- Defined in packages/core/src/adapters/EquirectangularAdapter.ts:136

setTexture

setTexture(
mesh: EquirectangularMesh,
textureData: EquirectangularTextureData,
): void
Applies the texture to the mesh
Parameters
- mesh: EquirectangularMesh
- textureData: EquirectangularTextureData
Returns void
Overrides AbstractAdapter.setTexture
- Defined in packages/core/src/adapters/EquirectangularAdapter.ts:277

setTextureOpacity

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

sphericalCoordsToTextureCoords

sphericalCoordsToTextureCoords(
position: Position,
data: PanoData,
): 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 packages/core/src/adapters/EquirectangularAdapter.ts:122

supportsPreload

supportsPreload(): boolean
Indicates if the adapter supports preload of a panorama

Returns boolean
Overrides AbstractAdapter.supportsPreload
- Defined in packages/core/src/adapters/EquirectangularAdapter.ts:104

supportsTransition

supportsTransition(): boolean
Indicates if the adapter supports transitions between panoramas

Returns boolean
Overrides AbstractAdapter.supportsTransition
- Defined in packages/core/src/adapters/EquirectangularAdapter.ts:100

textureCoordsToSphericalCoords

textureCoordsToSphericalCoords(
point: PanoramaPosition,
data: PanoData,
): 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 packages/core/src/adapters/EquirectangularAdapter.ts:108

Class EquirectangularAdapter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EquirectangularAdapter

Properties

ReadonlySPHERE_HORIZONTAL_SEGMENTS

ReadonlySPHERE_SEGMENTS

Protected Readonlyviewer

Static Readonlyid

Static ReadonlysupportsDownload

Static ReadonlyVERSION

Methods

createMesh

Parameters

Returns EquirectangularMesh

destroy

Returns void

disposeMesh

Parameters

Returns void

disposeTexture

Parameters

Returns void

init

Returns void

loadTexture

Parameters

Returns Promise<EquirectangularTextureData>

setTexture

Parameters

Returns void

setTextureOpacity

Parameters

Returns void

sphericalCoordsToTextureCoords

Parameters

Returns PanoramaPosition

Throws

supportsPreload

Returns boolean

supportsTransition

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