Describes a box. The center position and orientation are determined by the containing
Entity.
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
optional
Object with the following properties:
|
Members
-
readonlydefinitionChanged : Event
-
Gets the event that is raised whenever a property or sub-property is changed or modified.
-
dimensions : Property
-
Gets or sets
Cartesian3Property property specifying the length, width, and height of the box. -
distanceDisplayCondition : Property
-
Gets or sets the
DistanceDisplayConditionProperty specifying at what distance from the camera that this box will be displayed. -
fill : Property
-
Gets or sets the boolean Property specifying whether the box is filled with the provided material.
-
Default Value:
true -
material : MaterialProperty
-
Gets or sets the material used to fill the box.
-
Default Value:
Color.WHITE -
outline : Property
-
Gets or sets the Property specifying whether the box is outlined.
-
Default Value:
false -
outlineColor : Property
-
Gets or sets the Property specifying the
Colorof the outline.-
Default Value:
Color.BLACK -
outlineWidth : Property
-
Gets or sets the numeric Property specifying the width of the outline.
-
Default Value:
1.0 -
shadows : Property
-
Get or sets the enum Property specifying whether the boxcasts or receives shadows from each light source.
-
Default Value:
ShadowMode.DISABLED -
show : Property
-
Gets or sets the boolean Property specifying the visibility of the box.
-
Default Value:
true
Methods
-
clone(result) → BoxGraphics
-
Duplicates this instance.
Name Type Description resultBoxGraphics 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 valueof the same property on the provided source object.
Name Type Description sourceBoxGraphics The object to be merged into this object.
