Class: PlaneGraphics

PlaneGraphics

new PlaneGraphics(options)

Draw a plane class

The center position and orientation of the plane are determined by the entity to which it belongs.

Name Type Description
options Object optional

Object is an object that contains the following properties:

Name Type Default Description
show Property true optional

Boolean attribute, used to specify the visibility of the plane.
plane Property optional

The Plane property defines a plane by specifying the normal vector and distance.
dimensions Property optional

Cartesian2 attribute, specifying the length and width of the plane.
fill Property true optional

Boolean property, specifying whether to fill the plane with the provided material.
material MaterialProperty Color.WHITE optional

MaterialProperty property, specifying the material used to fill the plane
outline Property false optional

Boolean property, used to specify whether to display the outline of the plane.
outlineColor Property Color.BLACK optional

@The link Color attribute specifies the color of the planar contour line.
outlineWidth Property 1.0 optional

The number attribute specifies the width of the planar contour line.
shadows Property ShadowMode.DISABLED optional

Example attribute, used to specify whether the plane casts or receives shadows from each light source.
distanceDisplayCondition Property optional

Attribute, specifying how far the plane is displayed from the camera.

Members

readonly definitionChangedEvent

Get events. This event is thrown when the value of a property or sub property is modified, or when the definition is modified.

dimensionsProperty

Get or set the Cartesian2 property to specify the length and width of the plane.

distanceDisplayConditionProperty

Get or set the DistanceDisplayCondition property to specify how far the plane should be displayed from the camera.

fillProperty

Get or set boolean property to specify whether to fill the plane with the provided material.

Default Value:
true

materialMaterialProperty

Get or set the MaterialProperty property to specify the material used to fill the plane.

Default Value:
Color.WHITE

outlineProperty

Gets or sets the boolean property to specify whether to display the outline of the plane.

Default Value:
false

outlineColorProperty

Get or set the Color property to specify the color of the plane.

Default Value:
Color.BLACK

outlineWidthProperty

Get or set the number property to specify the contour width.

Default Value:
1.0

planeProperty

Get or set the Plane property, which defines the plane by specifying the normal vector and distance.

shadowsProperty

Gets or sets enumeration properties to specify whether the plane casts or receives shadows from each light source.

Default Value:
ShadowMode.DISABLED

showProperty

Get the visibility of the setting plane, of type boolean.

Default Value:
true

Methods

clone(result){PlaneGraphics}

Copy instance

Name Type Description
result PlaneGraphics optional

The object that stores the copied results
Returns:
Type Description
PlaneGraphics If input parameters are provided, return the modified input parameter object. If no input parameters are provided, return a new instance.

merge(source)

Assign the attribute values corresponding to the source object to all unspecified attributes of this instance.

Name Type Description
source PlaneGraphics

An object that provides attribute values.