Class: DebugCameraPrimitive

DebugCameraPrimitive

new DebugCameraPrimitive(options)

Draws the outline of the camera's view frustum.
Parameters:
Name Type Description
options Object Object with the following properties:
Properties
Name Type Attributes Default Description
camera Camera The camera.
color Color <optional>
 Color.CYAN The color of the debug outline.
updateOnChange Boolean <optional>
 true Whether the primitive updates when the underlying camera changes.
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.DebugCameraPrimitive({
  camera : camera,
  color : Cesium.Color.YELLOW
}));

Members

id :Object

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

show :Boolean

Determines if this primitive will be shown.
Type:
  • Boolean
Default Value:
  • true
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