CubeMapPanorama

new Cesium.CubeMapPanorama(options)
engine/Source/Scene/CubeMapPanorama.js 76

A Panorama that displays imagery in cube map format in a scene.

This is only supported in 3D. The cube map panorama is faded out when morphing to 2D or Columbus view. The size of the cube map panorama must not exceed Scene#maximumSkyBoxSize.

Name Type Description
options CubeMapPanorama.ConstructorOptions Object describing initialization options
Example:
const modelMatrix = Cesium.Matrix4.getMatrix3(
  Cesium.Transforms.localFrameToFixedFrameGenerator("north", "down")(
    Cesium.Cartesian3.fromDegrees(longitude, latitude, height),
    Cesium.Ellipsoid.default
  ),
  new Cesium.Matrix3()
);


scene.primitives.add(new Cesium.CubeMapPanorama({
  sources : {
    positiveX : 'cubemap_px.png',
    negativeX : 'cubemap_nx.png',
    positiveY : 'cubemap_py.png',
    negativeY : 'cubemap_ny.png',
    positiveZ : 'cubemap_pz.png',
    negativeZ : 'cubemap_nz.png'
  }
  transform: modelMatrix,
}));
Demo:
See:

Members

readonly credit : Credit
engine/Source/Scene/CubeMapPanorama.js 142

Gets the credits of the panorama.

show : boolean
engine/Source/Scene/CubeMapPanorama.js 97

Determines if the cube map panorama will be shown.
Default Value: true

sources : object
engine/Source/Scene/CubeMapPanorama.js 86

The sources used to create the cube map faces: an object with positiveX, negativeX, positiveY, negativeY, positiveZ, and negativeZ properties. These can be either URLs or Image objects.
Default Value: undefined

readonly transform : Matrix4
engine/Source/Scene/CubeMapPanorama.js 130

Gets the transform of the panorama.

Methods

destroy()
engine/Source/Scene/CubeMapPanorama.js 342

Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.
Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
cubeMapPanorama = cubeMapPanorama && cubeMapPanorama.destroy();
See:

isDestroyed() → boolean
engine/Source/Scene/CubeMapPanorama.js 322

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.
Returns:
true if this object was destroyed; otherwise, false.
See:

update()
engine/Source/Scene/CubeMapPanorama.js 160

Called when Viewer or CesiumWidget render the scene to get the draw commands needed to render this primitive.

Do not call this function directly. This is documented just to list the exceptions that may be propagated when the scene is rendered:

Throws:
  • DeveloperError : this.sources is required and must have positiveX, negativeX, positiveY, negativeY, positiveZ, and negativeZ properties.
  • DeveloperError : this.sources properties must all be the same type.

Type Definitions

Cesium.CubeMapPanorama.ConstructorOptions
engine/Source/Scene/CubeMapPanorama.js 26

Initialization options for the CubeMapPanorama constructor
Properties:
Name Type Attributes Default Description
options.sources object <optional>
 The source URL or Image object for each of the six cube map faces. See the example below.
options.transform Matrix4 <optional>
 A 4x4 transformation matrix that defines the panorama’s position and orientation
options.show boolean <optional>
 true Determines if this primitive will be shown.
options.credit Credit | string <optional>
 A credit for the panorama, which is displayed on the canvas.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
CtrlK
packages/engine
packages/widgets