Class: CubemapAdapter

Extends

• PSV.adapters.AbstractAdapter

Members

id string readonly inherited overrides

Unique identifier of the adapter

OVERLAY_UNIFORMS inherited overrides

psv PSV.Viewer readonly inherited overrides

Reference to main controller

supportsDownload boolean readonly inherited overrides

Indicates if the adapter supports panorama download natively

supportsOverlay boolean inherited overrides

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

Methods

createMesh (scale)external:THREE.Mesh inherited overrides

Creates the cube mesh

Name	Type	Default	Description
scale	number	1	optional

Returns:

Type	Description
external:THREE.Mesh

destroy () inherited overrides

Destroys the adapter

disposeTexture (textureData) inherited overrides

Clear a loaded texture from memory

Name	Type	Description
textureData	PSV.TextureData

loadTexture (panorama)Promise.<PSV.TextureData> inherited overrides

Loads the panorama texture(s)

Name	Type	Description
panorama	Array.<string> | PSV.adapters.CubemapAdapter.Cubemap

Returns:

Type	Description
Promise.<PSV.TextureData>

setOverlay (mesh, textureData, opacity) inherited overrides

Applies the overlay to the mesh

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

setTexture (mesh, textureData, transition) inherited overrides

Applies the texture to the mesh

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

setTextureOpacity (mesh, opacity) inherited overrides

Changes the opacity of the mesh

Name	Type	Description
mesh	external:THREE.Mesh
opacity	number

supportsPreload (panorama)boolean inherited overrides

Indicates if the adapter supports preload of a panorama

Name	Type	Description
panorama	*

Returns:

Type	Description
boolean

supportsTransition (panorama)boolean inherited overrides

Indicates if the adapter supports transitions between panoramas

Name	Type	Description
panorama	*

Returns:

Type	Description
boolean

Type Definitions

PSV.adapters.CubemapAdapter.Cubemap Object

Object defining a cubemap

Properties:

Name	Type	Description
left	string
front	string
right	string
back	string
top	string
bottom	string

PSV.adapters.CubemapAdapter.Options Object

Properties:

Name	Type	Argument	Default	Description
flipTopBottom	boolean	<optional>	false	set to true if the top and bottom faces are not correctly oriented