Class EquirectangularAdapter

Adapter for equirectangular panoramas

Hierarchy

AbstractAdapter<string, Texture, PanoData>
- EquirectangularAdapter

Index

Constructors

constructor

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

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: string = 'equirectangular'

Unique identifier of the adapter

`Static` `Readonly` supportsDownload

supportsDownload: boolean = true

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 packages/core/src/adapters/EquirectangularAdapter.ts:351

destroy

destroy(): void
Destroys the adapter

Returns void
Overrides AbstractAdapter.destroy
- Defined in packages/core/src/adapters/EquirectangularAdapter.ts:103

disposeTexture

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

init

init(): void
Initializes the adapter

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

loadTexture

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

setTexture

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

setTextureOpacity

setTextureOpacity(mesh, opacity): 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:367

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 packages/core/src/adapters/EquirectangularAdapter.ts:123

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:99

supportsTransition

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

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

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 packages/core/src/adapters/EquirectangularAdapter.ts:109

Class EquirectangularAdapter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

viewer: Viewer

Optional config: EquirectangularAdapterConfig

Returns EquirectangularAdapter

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: EquirectangularTexture

Returns void

init

Returns void

loadTexture

Parameters

panorama: string

loader: boolean = true

Optional newPanoData: PanoData | PanoDataProvider

useXmpPanoData: boolean = ...

Returns Promise<EquirectangularTexture>

setTexture

Parameters

mesh: EquirectangularMesh

textureData: EquirectangularTexture

Returns void

setTextureOpacity

Parameters

mesh: EquirectangularMesh

opacity: number

Returns void

sphericalCoordsToTextureCoords

Parameters

position: Position

data: PanoData

Returns PanoramaPosition

Throws

supportsPreload

Returns boolean

supportsTransition

Returns boolean

textureCoordsToSphericalCoords

Parameters

point: PanoramaPosition

data: PanoData

Returns Position

Throws

Settings

Member Visibility

Theme

On This Page

`Optional` config: EquirectangularAdapterConfig

`Readonly` SPHERE_HORIZONTAL_SEGMENTS

`Readonly` SPHERE_SEGMENTS

`Protected` `Readonly` viewer

`Static` `Readonly` VERSION

`Static` `Readonly` id

`Static` `Readonly` supportsDownload

`Optional` newPanoData: PanoData | PanoDataProvider