Class EquirectangularVideoAdapter

Adapter for equirectangular videos

Hierarchy

AbstractVideoAdapter<
    EquirectangularVideoPanorama,
    PanoData,
    EquirectangularVideoMesh,
>
- EquirectangularVideoAdapter

Constructors

constructor

new EquirectangularVideoAdapter(
viewer: Viewer,
config: EquirectangularVideoAdapterConfig,
): EquirectangularVideoAdapter
Parameters
- viewer: Viewer
- config: EquirectangularVideoAdapterConfig
Returns EquirectangularVideoAdapter
Overrides AbstractVideoAdapter< EquirectangularVideoPanorama, PanoData, EquirectangularVideoMesh >.constructor
- Defined in equirectangular-video-adapter/src/EquirectangularVideoAdapter.ts:35

Properties

`Protected` `Readonly`config

config: EquirectangularVideoAdapterConfig

`Protected` `Readonly`viewer

viewer: Viewer

`Static` `Readonly`id

id: "equirectangular-video" = 'equirectangular-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: PanoData): EquirectangularVideoMesh
Creates the mesh
Parameters
- panoData: PanoData
Returns EquirectangularVideoMesh
Overrides AbstractVideoAdapter.createMesh
- Defined in equirectangular-video-adapter/src/EquirectangularVideoAdapter.ts:81

destroy

destroy(): void
Returns void
Overrides AbstractVideoAdapter.destroy
- Defined in equirectangular-video-adapter/src/EquirectangularVideoAdapter.ts:45

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: EquirectangularVideoPanorama,
    _?: boolean,
    newPanoData?: any,
): Promise<EquirectangularVideoTextureData>
Parameters
- panorama: EquirectangularVideoPanorama
- Optional_: boolean
- OptionalnewPanoData: any
Returns Promise<EquirectangularVideoTextureData>
Overrides AbstractVideoAdapter.loadTexture
- Defined in equirectangular-video-adapter/src/EquirectangularVideoAdapter.ts:61

setTexture

setTexture(
mesh: EquirectangularVideoMesh,
__namedParameters: EquirectangularVideoTextureData,
): void
Applies the texture to the mesh
Parameters
- mesh: EquirectangularVideoMesh
- __namedParameters: EquirectangularVideoTextureData
Returns void
Overrides AbstractVideoAdapter.setTexture
- Defined in equirectangular-video-adapter/src/EquirectangularVideoAdapter.ts:85

setTextureOpacity

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

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 AbstractVideoAdapter.sphericalCoordsToTextureCoords
- Defined in equirectangular-video-adapter/src/EquirectangularVideoAdapter.ts:57

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: 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 AbstractVideoAdapter.textureCoordsToSphericalCoords
- Defined in equirectangular-video-adapter/src/EquirectangularVideoAdapter.ts:53

`Static`withConfig

withConfig(config: EquirectangularVideoAdapterConfig): [AdapterConstructor, any]
Parameters
- config: EquirectangularVideoAdapterConfig
Returns [AdapterConstructor, any]
- Defined in equirectangular-video-adapter/src/EquirectangularVideoAdapter.ts:31

Class EquirectangularVideoAdapter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EquirectangularVideoAdapter

Properties

Protected Readonlyconfig

Protected Readonlyviewer

Static Readonlyid

Static ReadonlysupportsDownload

Static ReadonlyVERSION

Methods

createMesh

Parameters

Returns EquirectangularVideoMesh

destroy

Returns void

disposeMesh

Parameters

Returns void

disposeTexture

Parameters

Returns void

init

Returns void

loadTexture

Parameters

Returns Promise<EquirectangularVideoTextureData>

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