GeometryUpdater - Cesium Documentation

GeometryUpdater

new GeometryUpdater

Defines the interface for a geometry updater. A GeometryUpdater maps geometry defined as part of a DynamicObject into Geometry instances. These instances are then visualized by GeometryVisualizer. This type defines an interface and cannot be instantiated directly.

Parameters:

Name	Type	Description
`dynamicObject`	DynamicObject	The object containing the geometry to be visualized.
`scene`	Scene	The scene where visualization is taking place.

See:

Source:

tryUpdater.js

Members

dynamicObject :DynamicObject

Gets the object associated with this geometry.

fillEnabled :Boolean

Gets a value indicating if the geometry has a fill component.

fillMaterialProperty :MaterialProperty

Gets the material property used to fill the geometry.

geometryChanged :Boolean

Gets an event that is raised whenever the public properties of this updater change.

hasConstantFill :Boolean

Gets a value indicating if fill visibility varies with simulation time.

hasConstantOutline :Boolean

Gets a value indicating if outline visibility varies with simulation time.

isClosed :Boolean

Gets a value indicating if the geometry is closed. This property is only valid for static geometry.

isDynamic :Boolean

Gets a value indicating if the geometry is time-varying. If true, all visualization is delegated to the DynamicGeometryUpdater returned by GeometryUpdater#createDynamicUpdater.

outlineColorProperty :Property

Gets the Color property for the geometry outline.

outlineEnabled :Boolean

Gets a value indicating if the geometry has an outline component.

<static> materialAppearanceType :Appearance

Gets the type of Appearance to use for material-based geometry.

<static> perInstanceColorAppearanceType :Appearance

Gets the type of Appearance to use for simple color-based geometry.

Methods

createDynamicUpdater

Creates the dynamic updater to be used when GeometryUpdater#isDynamic is true.

Parameters:

Name	Type	Description
`primitives`	CompositePrimitive	The primitive collection to use.

Throws:

DeveloperError : This instance does not represent dynamic geometry.

Returns:

DynamicGeometryUpdater The dynamic updater used to update the geometry each frame.

createFillGeometryInstance

Creates the geometry instance which represents the fill of the geometry.

Parameters:

Name	Type	Description
`time`	JulianDate	The time to use when retrieving initial attribute values.

Throws:

DeveloperError : This instance does not represent a filled geometry.

Returns:

GeometryInstance The geometry instance representing the filled portion of the geometry.

createOutlineGeometryInstance

Creates the geometry instance which represents the outline of the geometry.

Parameters:

Name	Type	Description
`time`	JulianDate	The time to use when retrieving initial attribute values.

Throws:

DeveloperError : This instance does not represent an outlined geometry.

Returns:

GeometryInstance The geometry instance representing the outline portion of the 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

Returns true if this object was destroyed; otherwise, false.

Returns:

Boolean True if this object was destroyed; otherwise, false.

isFilled

Checks if the geometry is filled at the provided time.

Parameters:

Name	Type	Description
`time`	JulianDate	The time for which to retrieve visibility.

Returns:

Boolean true if geometry is filled at the provided time, false otherwise.

isOutlineVisible

Checks if the geometry is outlined at the provided time.

Parameters:

Name	Type	Description
`time`	JulianDate	The time for which to retrieve visibility.

Returns:

Boolean true if geometry is outlined at the provided time, false otherwise.