DebugModelMatrixPrimitive

new DebugModelMatrixPrimitive(options)

Draws the axes of a reference frame defined by a matrix that transforms to world coordinates, i.e., Earth's WGS84 coordinates. The most prominent example is a primitives modelMatrix.

The X axis is red; Y is green; and Z is blue.

This is for debugging only; it is not optimized for production use.

Name Type Description
options Object optional Object with the following properties:
Name Type Default Description
length Number 10000000.0 optional The length of the axes in meters.
width Number 2.0 optional The width of the axes in pixels.
modelMatrix Matrix4 Matrix4.IDENTITY optional The 4x4 matrix that defines the reference frame, i.e., origin plus axes, to visualize.
show Boolean true optional Determines if this primitive will be shown.
id Object optional A user-defined object to return when the instance is picked with Scene#pick
Example:
primitives.add(new Cesium.DebugModelMatrixPrimitive({
  modelMatrix : primitive.modelMatrix,  // primitive to debug
  length : 100000.0,
  width : 10.0
}));
Source: Scene/DebugModelMatrixPrimitive.js, line 54

Members

id :Object

User-defined object returned when the primitive is picked.
Default Value: undefined
See:
Source: Scene/DebugModelMatrixPrimitive.js, line 100

length :Number

The length of the axes in meters.
Default Value: 10000000.0
Source: Scene/DebugModelMatrixPrimitive.js, line 63

modelMatrix :Matrix4

The 4x4 matrix that defines the reference frame, i.e., origin plus axes, to visualize.
Default Value: Matrix4.IDENTITY
Source: Scene/DebugModelMatrixPrimitive.js, line 89

show :Boolean

Determines if this primitive will be shown.
Default Value: true
Source: Scene/DebugModelMatrixPrimitive.js, line 81

width :Number

The width of the axes in pixels.
Default Value: 2.0
Source: Scene/DebugModelMatrixPrimitive.js, line 72

Methods

destroy() → undefined

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.

Returns:
Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
p = p && p.destroy();
See:
Source: Scene/DebugModelMatrixPrimitive.js, line 202

isDestroyed() → Boolean

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:
Source: Scene/DebugModelMatrixPrimitive.js, line 180