Class: DebugModelMatrixPrimitive

DebugModelMatrixPrimitive

new DebugModelMatrixPrimitive(optionsopt)

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.

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

Members

id :Object

User-defined object returned when the primitive is picked.
Type:
  • Object
Default Value:
  • undefined
Source:
See:

length :Number

The length of the axes in meters.
Type:
  • Number
Default Value:
  • 10000000.0
Source:

modelMatrix :Matrix4

The 4x4 matrix that defines the reference frame, i.e., origin plus axes, to visualize.
Type:
Default Value:
Source:

show :Boolean

Determines if this primitive will be shown.
Type:
  • Boolean
Default Value:
  • true
Source:

width :Number

The width of the axes in pixels.
Type:
  • Number
Default Value:
  • 2.0
Source:

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.

Source:
See:
Throws:
This object was destroyed, i.e., destroy() was called.
Type
DeveloperError
Returns:
Type
undefined
Example
p = p && p.destroy();

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.

Source:
See:
Returns:
true if this object was destroyed; otherwise, false.
Type
Boolean