PlaneGraphics

new Cesium.PlaneGraphics(options)

Describes a plane. The center position and orientation are determined by the containing Entity.
Name Type Description
options Object optional Object with the following properties:
Name Type Default Description
plane Property optional A Plane Property specifying the normal and distance for the plane.
dimensions Property optional A Cartesian2 Property specifying the width and height of the plane.
show Property true optional A boolean Property specifying the visibility of the plane.
fill Property true optional A boolean Property specifying whether the plane is filled with the provided material.
material MaterialProperty Color.WHITE optional A Property specifying the material used to fill the plane.
outline Property false optional A boolean Property specifying whether the plane is outlined.
outlineColor Property Color.BLACK optional A Property specifying the Color of the outline.
outlineWidth Property 1.0 optional A numeric Property specifying the width of the outline.
shadows Property ShadowMode.DISABLED optional An enum Property specifying whether the plane casts or receives shadows from each light source.
distanceDisplayCondition Property optional A Property specifying at what distance from the camera that this plane will be displayed.
Demo:

Members

readonlydefinitionChanged : Event

Gets the event that is raised whenever a property or sub-property is changed or modified.
Gets or sets the Cartesian2 Property specifying the width and height of the plane.

distanceDisplayCondition : Property

Gets or sets the DistanceDisplayCondition Property specifying at what distance from the camera that this plane will be displayed.

distanceDisplayCondition : Property

Gets or sets the DistanceDisplayCondition Property specifying at what distance from the camera that this plane will be displayed.
Gets or sets the boolean Property specifying whether the plane is filled with the provided material.
Default Value: true
Gets or sets the material used to fill the plane.
Default Value: Color.WHITE
Gets or sets the Property specifying whether the plane is outlined.
Default Value: false
Gets or sets the Property specifying the Color of the outline.
Default Value: Color.BLACK
Gets or sets the numeric Property specifying the width of the outline.
Default Value: 1.0
Gets or sets the Plane Property specifying the normal and distance of the plane.
Get or sets the enum Property specifying whether the plane casts or receives shadows from each light source.
Default Value: ShadowMode.DISABLED
Gets or sets the boolean Property specifying the visibility of the plane.
Default Value: true

Methods

Duplicates this instance.
Name Type Description
result PlaneGraphics optional The object onto which to store the result.
Returns:
The modified result parameter or a new instance if one was not provided.
Assigns each unassigned property on this object to the value of the same property on the provided source object.
Name Type Description
source PlaneGraphics The object to be merged into this object.