Class CubemapVideoAdapter

Adapter for cubemap videos

Hierarchy

AbstractVideoAdapter<CubemapVideoPanorama, CubemapVideoData, CubemapVideoMesh>
- CubemapVideoAdapter

Constructors

constructor

new CubemapVideoAdapter(
viewer: Viewer,
config: AbstractVideoAdapterConfig,
): CubemapVideoAdapter
Parameters
- viewer: Viewer
- config: AbstractVideoAdapterConfig
Returns CubemapVideoAdapter
Overrides AbstractVideoAdapter<CubemapVideoPanorama, CubemapVideoData, CubemapVideoMesh>.constructor
- Defined in cubemap-video-adapter/src/CubemapVideoAdapter.ts:38

Properties

`Protected` `Readonly`config

config: AbstractVideoAdapterConfig

`Protected` `Readonly`viewer

viewer: Viewer

`Static` `Readonly`id

id: "cubemap-video" = 'cubemap-video'

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: CubemapVideoData): CubemapVideoMesh
Creates the mesh
Parameters
- panoData: CubemapVideoData
Returns CubemapVideoMesh
Overrides AbstractVideoAdapter.createMesh
- Defined in cubemap-video-adapter/src/CubemapVideoAdapter.ts:55

destroy

destroy(): void
Destroys the adapter

Returns void
Inherited from AbstractVideoAdapter.destroy
- Defined in shared/AbstractVideoAdapter.ts:50

disposeMesh

disposeMesh(mesh: AbstractVideoMesh): void
Cleanup a mesh from memory
Parameters
- mesh: AbstractVideoMesh
Returns void
Inherited from AbstractVideoAdapter.disposeMesh
- Defined in shared/AbstractVideoAdapter.ts:125

disposeTexture

disposeTexture(__namedParameters: AbstractVideoTextureData): void
Clear a loaded texture from memory
Parameters
- __namedParameters: AbstractVideoTextureData
Returns void
Inherited from AbstractVideoAdapter.disposeTexture
- Defined in shared/AbstractVideoAdapter.ts:121

init

init(): void
Initializes the adapter

Returns void
Inherited from AbstractVideoAdapter.init
- Defined in shared/AbstractVideoAdapter.ts:44

loadTexture

loadTexture(panorama: CubemapVideoPanorama): Promise<CubemapVideoTextureData>
Parameters
- panorama: CubemapVideoPanorama
Returns Promise<CubemapVideoTextureData>
Overrides AbstractVideoAdapter.loadTexture
- Defined in cubemap-video-adapter/src/CubemapVideoAdapter.ts:44

setTexture

setTexture(
mesh: CubemapVideoMesh,
__namedParameters: CubemapVideoTextureData,
): void
Applies the texture to the mesh
Parameters
- mesh: CubemapVideoMesh
- __namedParameters: CubemapVideoTextureData
Returns void
Overrides AbstractVideoAdapter.setTexture
- Defined in cubemap-video-adapter/src/CubemapVideoAdapter.ts:77

setTextureOpacity

setTextureOpacity(mesh: CubemapVideoMesh, opacity: number): void
Changes the opacity of the mesh
Parameters
- mesh: CubemapVideoMesh
- opacity: number
Returns void
Inherited from AbstractVideoAdapter.setTextureOpacity
- Defined in shared/AbstractVideoAdapter.ts:116

sphericalCoordsToTextureCoords

sphericalCoordsToTextureCoords(
position: Position,
data: CubemapVideoData,
): PanoramaPosition
Converts spherical radians coordinates to pixel texture coordinates
Parameters
- position: Position
- data: CubemapVideoData
Returns PanoramaPosition
Throws
PSVError when the current adapter does not support texture coordinates
Inherited from AbstractVideoAdapter.sphericalCoordsToTextureCoords
- Defined in core/src/adapters/AbstractAdapter.ts:78

supportsPreload

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

Returns boolean
Inherited from AbstractVideoAdapter.supportsPreload
- Defined in shared/AbstractVideoAdapter.ts:56

supportsTransition

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

Returns boolean
Inherited from AbstractVideoAdapter.supportsTransition
- Defined in shared/AbstractVideoAdapter.ts:60

`Protected`switchVideo

switchVideo(texture: VideoTexture): void
Parameters
- texture: VideoTexture
Returns void
Inherited from AbstractVideoAdapter.switchVideo
- Defined in shared/AbstractVideoAdapter.ts:88

textureCoordsToSphericalCoords

textureCoordsToSphericalCoords(
point: PanoramaPosition,
data: CubemapVideoData,
): Position
Converts pixel texture coordinates to spherical radians coordinates
Parameters
- point: PanoramaPosition
- data: CubemapVideoData
Returns Position
Throws
PSVError when the current adapter does not support texture coordinates
Inherited from AbstractVideoAdapter.textureCoordsToSphericalCoords
- Defined in core/src/adapters/AbstractAdapter.ts:68

`Static`withConfig

withConfig(config: AbstractVideoAdapterConfig): [AdapterConstructor, any]
Parameters
- config: AbstractVideoAdapterConfig
Returns [AdapterConstructor, any]
- Defined in cubemap-video-adapter/src/CubemapVideoAdapter.ts:34

Class CubemapVideoAdapter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CubemapVideoAdapter

Properties

Protected Readonlyconfig

Protected Readonlyviewer

Static Readonlyid

Static ReadonlysupportsDownload

Static ReadonlyVERSION

Methods

createMesh

Parameters

Returns CubemapVideoMesh

destroy

Returns void

disposeMesh

Parameters

Returns void

disposeTexture

Parameters

Returns void

init

Returns void

loadTexture

Parameters

Returns Promise<CubemapVideoTextureData>

setTexture

Parameters

Returns void

setTextureOpacity

Parameters

Returns void

sphericalCoordsToTextureCoords

Parameters

Returns PanoramaPosition

Throws

supportsPreload

Returns boolean

supportsTransition

Returns boolean

ProtectedswitchVideo

Parameters

Returns void

textureCoordsToSphericalCoords

Parameters

Returns Position

Throws

StaticwithConfig

Parameters

Returns [AdapterConstructor, any]

Settings

On This Page

`Protected` `Readonly`config

`Protected` `Readonly`viewer

`Static` `Readonly`id

`Static` `Readonly`supportsDownload

`Static` `Readonly`VERSION

`Protected`switchVideo

`Static`withConfig