top
all js glsl

DebugModelMatrixPrimitive

DebugModelMatrixPrimitive

new

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

Members

:Object

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

:Number

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

:Matrix4

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

:Boolean

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

:Number

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

Methods

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.
Returns:
Example
p = p && p.destroy();
See:

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:
Boolean true if this object was destroyed; otherwise, false.
See: