kotlin-cesium-engine/cesium.engine/Entity

Entity

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.

Constructors

Entity

constructor()

Types

Companion

object Companion

Properties

availability

var availability: TimeIntervalCollection?

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.

billboard

var billboard: BillboardGraphics?

Gets or sets the billboard.

box

var box: BoxGraphics?

Gets or sets the box.

corridor

var corridor: CorridorGraphics?

Gets or sets the corridor.

cylinder

var cylinder: CylinderGraphics?

Gets or sets the cylinder.

definitionChanged

val definitionChanged: DefaultEvent

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

description

var description: Property?

Gets or sets the description.

ellipse

var ellipse: EllipseGraphics?

Gets or sets the ellipse.

ellipsoid

var ellipsoid: EllipsoidGraphics?

Gets or sets the ellipsoid.

entityCollection

var entityCollection: EntityCollection

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

var id: String

Gets the unique ID associated with this object.

isShowing

var isShowing: Boolean

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

label

var label: LabelGraphics?

Gets or sets the label.

model

var model: ModelGraphics?

Gets or sets the model.

name

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.

orientation

var orientation: Property?

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

parent

var parent: Entity?

Gets or sets the parent object.

path

var path: PathGraphics?

Gets or sets the path.

plane

var plane: PlaneGraphics?

Gets or sets the plane.

point

var point: PointGraphics?

Gets or sets the point graphic.

polygon

var polygon: PolygonGraphics?

Gets or sets the polygon.

polyline

var polyline: PolylineGraphics?

Gets or sets the polyline.

polylineVolume

var polylineVolume: PolylineVolumeGraphics?

Gets or sets the polyline volume.

position

var position: PositionProperty?

Gets or sets the position.

properties

var properties: PropertyBag?

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

propertyNames

var propertyNames: ReadonlyArray<String>

Gets the names of all properties registered on this instance.

rectangle

var rectangle: RectangleGraphics?

Gets or sets the rectangle.

show

var show: Boolean

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.

tileset

var tileset: Cesium3DTilesetGraphics?

Gets or sets the tileset.

trackingReferenceFrame

var trackingReferenceFrame: TrackingReferenceFrame

Gets or sets the entity's tracking reference frame.

viewFrom

var viewFrom: Property?

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.

wall

var wall: WallGraphics?

Gets or sets the wall.

Functions

addProperty

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

computeModelMatrix