new BoxGeometryUpdater(entity, scene)
A
GeometryUpdater for boxes.
Clients do not normally create this class directly, but instead rely on DataSourceDisplay.
| Name | Type | Description |
|---|---|---|
entity |
Entity | The entity containing the geometry to be visualized. |
scene |
Scene | The scene where visualization is taking place. |
Members
-
staticBoxGeometryUpdater.materialAppearanceType :Appearance
-
Gets the type of Appearance to use for material-based geometry.
-
staticBoxGeometryUpdater.perInstanceColorAppearanceType :Appearance
-
Gets the type of Appearance to use for simple color-based geometry.
-
readonlyentity :Entity
-
Gets the entity associated with this geometry.
-
readonlyfillEnabled :Boolean
-
Gets a value indicating if the geometry has a fill component.
-
readonlyfillMaterialProperty :MaterialProperty
-
Gets the material property used to fill the geometry.
-
readonlygeometryChanged :Boolean
-
Gets an event that is raised whenever the public properties of this updater change.
-
readonlyhasConstantFill :Boolean
-
Gets a value indicating if fill visibility varies with simulation time.
-
readonlyhasConstantOutline :Boolean
-
Gets a value indicating if the geometry has an outline component.
-
readonlyisClosed :Boolean
-
Gets a value indicating if the geometry is closed. This property is only valid for static geometry.
-
readonlyisDynamic :Boolean
-
Gets a value indicating if the geometry is time-varying. If true, all visualization is delegated to the
DynamicGeometryUpdaterreturned by GeometryUpdater#createDynamicUpdater. -
readonlyoutlineColorProperty :Property
-
Gets the
Colorproperty for the geometry outline. -
readonlyoutlineEnabled :Boolean
-
Gets a value indicating if the geometry has an outline component.
-
readonlyoutlineWidth :Number
-
Gets the constant with of the geometry outline, in pixels. This value is only valid if isDynamic is false.
Methods
-
createDynamicUpdater(primitives) → DynamicGeometryUpdater
-
Creates the dynamic updater to be used when GeometryUpdater#isDynamic is true.
Name Type Description primitivesPrimitiveCollection The primitive collection to use. Returns:
The dynamic updater used to update the geometry each frame.Throws:
-
DeveloperError : This instance does not represent dynamic geometry.
-
-
createFillGeometryInstance(time) → GeometryInstance
-
Creates the geometry instance which represents the fill of the geometry.
Name Type Description timeJulianDate The time to use when retrieving initial attribute values. Returns:
The geometry instance representing the filled portion of the geometry.Throws:
-
DeveloperError : This instance does not represent a filled geometry.
-
-
createOutlineGeometryInstance(time) → GeometryInstance
-
Creates the geometry instance which represents the outline of the geometry.
Name Type Description timeJulianDate The time to use when retrieving initial attribute values. Returns:
The geometry instance representing the outline portion of the geometry.Throws:
-
DeveloperError : This instance does not represent an outlined geometry.
-
-
destroy()
-
Destroys and resources used by the object. Once an object is destroyed, it should not be used.
Throws:
-
DeveloperError : This object was destroyed, i.e., destroy() was called.
-
-
isDestroyed() → Boolean
-
Returns true if this object was destroyed; otherwise, false.
Returns:
True if this object was destroyed; otherwise, false. -
isFilled(time) → Boolean
-
Checks if the geometry is filled at the provided time.
Name Type Description timeJulianDate The time for which to retrieve visibility. Returns:
true if geometry is filled at the provided time, false otherwise. -
isOutlineVisible(time) → Boolean
-
Checks if the geometry is outlined at the provided time.
Name Type Description timeJulianDate The time for which to retrieve visibility. Returns:
true if geometry is outlined at the provided time, false otherwise.