Entity

external class Entity(source)

Entity instances aggregate multiple forms of visualization into a single high-level object. They can be created manually and added to Viewer.entities or be produced by data sources, such as CzmlDataSource and GeoJsonDataSource.

See also

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The availability, if any, associated with this object. If availability is undefined, it is assumed that this object's other properties will return valid data for any provided time. If availability exists, the objects other properties will only provide valid data if queried within the given interval.

Link copied to clipboard

Gets or sets the billboard.

Link copied to clipboard

Gets or sets the box.

Link copied to clipboard

Gets or sets the corridor.

Link copied to clipboard

Gets or sets the cylinder.

Link copied to clipboard

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

Link copied to clipboard

Gets or sets the description.

Link copied to clipboard

Gets or sets the ellipse.

Link copied to clipboard

Gets or sets the ellipsoid.

Link copied to clipboard

Gets or sets the entity collection that this entity belongs to.

Link copied to clipboard
var id: String

Gets the unique ID associated with this object.

Link copied to clipboard

Gets whether this entity is being displayed, taking into account the visibility of any ancestor entities.

Link copied to clipboard

Gets or sets the label.

Link copied to clipboard

Gets or sets the model.

Link copied to clipboard
var name: String?

Gets or sets the name of the object. The name is intended for end-user consumption and does not need to be unique.

Link copied to clipboard

Gets or sets the orientation in respect to Earth-fixed-Earth-centered (ECEF). Defaults to east-north-up at entity position.

Link copied to clipboard

Gets or sets the parent object.

Link copied to clipboard

Gets or sets the path.

Link copied to clipboard

Gets or sets the plane.

Link copied to clipboard

Gets or sets the point graphic.

Link copied to clipboard

Gets or sets the polygon.

Link copied to clipboard

Gets or sets the polyline.

Link copied to clipboard

Gets or sets the polyline volume.

Link copied to clipboard

Gets or sets the position.

Link copied to clipboard

Gets or sets the bag of arbitrary properties associated with this entity.

Link copied to clipboard

Gets the names of all properties registered on this instance.

Link copied to clipboard

Gets or sets the rectangle.

Link copied to clipboard

Gets or sets whether this entity should be displayed. When set to true, the entity is only displayed if the parent entity's show property is also true.

Link copied to clipboard

Gets or sets the tileset.

Link copied to clipboard

Gets or sets the suggested initial offset when tracking this object. The offset is typically defined in the east-north-up reference frame, but may be another frame depending on the object's velocity.

Link copied to clipboard

Gets or sets the wall.

Functions

Link copied to clipboard
fun addProperty(propertyName: String)

Adds a property to this object. Once a property is added, it can be observed with Entity.definitionChanged and composited with CompositeEntityCollection

Link copied to clipboard
fun computeModelMatrix(time: JulianDate, result: Matrix4? = definedExternally): Matrix4

Computes the model matrix for the entity's transform at specified time. Returns undefined if position is undefined

Link copied to clipboard

Given a time, returns true if this object should have data during that time.

Link copied to clipboard
fun merge(source: Entity)

Assigns each unassigned property on this object to the value of the same property on the provided source object.

Link copied to clipboard
fun removeProperty(propertyName: String)

Removed a property previously added with addProperty.