Class: BoxGraphics

BoxGraphics

new BoxGraphics(optionsopt)

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

Members

(readonly) definitionChanged :Event

Gets the event that is raised whenever a property or sub-property is changed or modified.
Type:
Source:

dimensions :Property

Gets or sets Cartesian3 Property property specifying the length, width, and height of the box.
Type:
Source:

distanceDisplayCondition :Property

Gets or sets the DistanceDisplayCondition Property specifying at what distance from the camera that this box will be displayed.
Type:
Source:

fill :Property

Gets or sets the boolean Property specifying whether the box is filled with the provided material.
Type:
Default Value:
  • true
Source:

material :MaterialProperty

Gets or sets the material used to fill the box.
Type:
Default Value:
  • Color.WHITE
Source:

outline :Property

Gets or sets the Property specifying whether the box is outlined.
Type:
Default Value:
  • false
Source:

outlineColor :Property

Gets or sets the Property specifying the Color of the outline.
Type:
Default Value:
  • Color.BLACK
Source:

outlineWidth :Property

Gets or sets the numeric Property specifying the width of the outline.
Type:
Default Value:
  • 1.0
Source:

shadows :Property

Get or sets the enum Property specifying whether the box casts or receives shadows from each light source.
Type:
Default Value:
  • ShadowMode.DISABLED
Source:

show :Property

Gets or sets the boolean Property specifying the visibility of the box.
Type:
Default Value:
  • true
Source:

Methods

clone(resultopt) → {BoxGraphics}

Duplicates this instance.
Parameters:
Name Type Attributes Description
result BoxGraphics <optional>
 The object onto which to store the result.
Source:
Returns:
The modified result parameter or a new instance if one was not provided.
Type
BoxGraphics

merge(source)

Assigns each unassigned property on this object to the value of the same property on the provided source object.
Parameters:
Name Type Description
source BoxGraphics The object to be merged into this object.
Source: