Class CubemapAdapter

Adapter for cubemaps

Hierarchy (view full)

AbstractAdapter<CubemapPanorama, CubemapData, Texture[], CubemapMesh>
- CubemapAdapter

Index

Constructors

Properties

viewer id supportsDownload VERSION

Methods

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

Constructors

constructor

new CubemapAdapter(viewer, config): CubemapAdapter
Parameters
- viewer: Viewer
- config: CubemapAdapterConfig
Returns CubemapAdapter
Overrides AbstractAdapter.constructor
- Defined in cubemap-adapter/src/CubemapAdapter.ts:36

Properties

`Protected` `Readonly`viewer

viewer: Viewer

`Static` `Readonly`id

id: "cubemap" = 'cubemap'

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(): CubemapMesh
Creates the mesh

Returns CubemapMesh
Overrides AbstractAdapter.createMesh
- Defined in cubemap-adapter/src/CubemapAdapter.ts:358

destroy

destroy(): void
Destroys the adapter

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

disposeMesh

disposeMesh(mesh): void
Cleanup a mesh from memory
Parameters
- mesh: CubemapMesh
Returns void
Overrides AbstractAdapter.disposeMesh
- Defined in cubemap-adapter/src/CubemapAdapter.ts:400

disposeTexture

disposeTexture(__namedParameters): void
Clear a loaded texture from memory
Parameters
- __namedParameters: CubemapTextureData
Returns void
Overrides AbstractAdapter.disposeTexture
- Defined in cubemap-adapter/src/CubemapAdapter.ts:396

init

init(): void
Initializes the adapter

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

loadTexture

loadTexture(panorama, loader?): Promise<CubemapTextureData>
Loads the panorama texture
Parameters
- panorama: CubemapPanorama
- loader: boolean = true
Returns Promise<CubemapTextureData>
Overrides AbstractAdapter.loadTexture
- Defined in cubemap-adapter/src/CubemapAdapter.ts:146

setTexture

setTexture(mesh, __namedParameters): void
Applies the texture to the mesh
Parameters
- mesh: CubemapMesh
- __namedParameters: CubemapTextureData
Returns void
Overrides AbstractAdapter.setTexture
- Defined in cubemap-adapter/src/CubemapAdapter.ts:371

setTextureOpacity

setTextureOpacity(mesh, opacity): void
Changes the opacity of the mesh
Parameters
- mesh: CubemapMesh
- opacity: number
Returns void
Overrides AbstractAdapter.setTextureOpacity
- Defined in cubemap-adapter/src/CubemapAdapter.ts:387

sphericalCoordsToTextureCoords

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

supportsPreload

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

Returns boolean
Overrides AbstractAdapter.supportsPreload
- Defined in cubemap-adapter/src/CubemapAdapter.ts:46

supportsTransition

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

Returns boolean
Overrides AbstractAdapter.supportsTransition
- Defined in cubemap-adapter/src/CubemapAdapter.ts:42

textureCoordsToSphericalCoords

textureCoordsToSphericalCoords(point, data): Position
https://github.com/bhautikj/vrProjector/blob/master/vrProjector/CubemapProjection.py#L130
Parameters
- point: PanoramaPosition
- data: CubemapData
Returns Position
Overrides AbstractAdapter.textureCoordsToSphericalCoords
- Defined in cubemap-adapter/src/CubemapAdapter.ts:53