Class: AbstractAdapter

PSV.adapters.AbstractAdapter

new PSV.adapters.AbstractAdapter (psv) abstract

Base adapters class

Name Type Description
psv PSV.Viewer

Members

id string readonly

Unique identifier of the adapter

OVERLAY_UNIFORMS

psv PSV.Viewer readonly

Reference to main controller

supportsDownload boolean readonly

Indicates if the adapter supports panorama download natively

supportsOverlay boolean

Indicated if the adapter can display an additional transparent image above the panorama

Methods

PSV.adapters.AbstractAdapter.createOverlayMaterial () static

createMesh (scale)external:THREE.Mesh abstract

Creates the cube mesh

Name Type Default Description
scale number 1 optional
Returns:
Type Description
external:THREE.Mesh

destroy ()

Destroys the adapter

disposeTexture (textureData) abstract

Clear a loaded texture from memory

Name Type Description
textureData PSV.TextureData

loadTexture (panorama, newPanoData, useXmpPanoData)Promise.<PSV.TextureData> abstract

Loads the panorama texture(s)

Name Type Description
panorama *
newPanoData PSV.PanoData | PSV.PanoDataProvider optional
useXmpPanoData boolean optional
Returns:
Type Description
Promise.<PSV.TextureData>

setOverlay (mesh, textureData, opacity) abstract

Applies the overlay to the mesh

Name Type Description
mesh external:THREE.Mesh
textureData PSV.TextureData
opacity number

setTexture (mesh, textureData, transition) abstract

Applies the texture to the mesh

Name Type Default Description
mesh external:THREE.Mesh
textureData PSV.TextureData
transition boolean false optional

setTextureOpacity (mesh, opacity) abstract

Changes the opacity of the mesh

Name Type Description
mesh external:THREE.Mesh
opacity number

supportsPreload (panorama)boolean

Indicates if the adapter supports preload of a panorama

Name Type Description
panorama *
Returns:
Type Description
boolean

supportsTransition (panorama)boolean

Indicates if the adapter supports transitions between panoramas

Name Type Description
panorama *
Returns:
Type Description
boolean