Skip to main content

CubemapProjection

Since version 4.0.0

source

Projection based on cubemap images, accepts both multiple or single images.

class CubemapProjection extends Projection<{
  uTexture: UniformTextureCube | UniformCanvasCube
}>

Extends

  • Projection<{
     uTexture: UniformTextureCube | UniformCanvasCube
    }>

Properties

mesh

A 3D triangle mesh for projection. It's null until loading the src.

src

Source URL to panorama image/video.

video

Properties for the video element.
Setting false will treat panorama source as an image, true will use default properties.

Methods

applyTexture

Apply texture to current projection.

getTexture

Return active texture.

releaseAllResources

Release all resources projection has.
This is automatically called on projection change & View360's destroy call

update

Update projection.

updateCamera

Update camera to match projection's settings.

updateControl

Update control to match projection's settings.

Constructor​

Create new instance.
new CubemapProjection(options: CubemapProjectionOptions): CubemapProjection

Parameters

options

CubemapProjectionOptions

Options

Properties​

mesh​

>=4.0.0
inherited
mesh

null | TriangleMesh<{ uTexture: UniformCanvasCube | UniformTextureCube }>

A 3D triangle mesh for projection. It's null until loading the src.

source

src​

>=4.0.0
readonly inherited
src

string | HTMLElement | (string | HTMLElement)[]

Source URL to panorama image/video.

source

video​

>=4.0.0
readonly inherited
video

undefined | boolean | Partial<VideoConfig>

Properties for the video element.
Setting false will treat panorama source as an image, true will use default properties.

Example

Default properties

autoplay: true
muted: true
loop: false
volume: 1

source

Methods​

applyTexture​

>=4.0.0
applyTexture

void

applyTexture(ctx: WebGLContext, texture: Texture2D): void

Apply texture to current projection.

Parameters

ctx

WebGLContext

Instance of the WebGLContext helper

texture

Texture2D

New texture to apply

source

getTexture​

>=4.0.0
inherited
getTexture

null | Texture2D | TextureCube

getTexture(): null | Texture2D | TextureCube

Return active texture.

source

releaseAllResources​

inherited
releaseAllResources

void

releaseAllResources(ctx: WebGLContext): void

Release all resources projection has.
This is automatically called on projection change & View360's destroy call

Parameters

ctx

WebGLContext

source

update​

>=4.0.0
inherited
update

void

update(camera: Camera): void

Update projection.

Parameters

camera

Camera

Instance of the camera to reference

source

updateCamera​

>=4.0.0
inherited
updateCamera

void

updateCamera(camera: Camera): void

Update camera to match projection's settings.

Parameters

camera

Camera

Instance of the camera to update

source

updateControl​

>=4.0.0
inherited
updateControl

void

updateControl(control: PanoControl): void

Update control to match projection's settings.

Parameters

control

PanoControl

Instance of the control to update

source