Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Entity

Hierarchy

  • Entity
    • Entity

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Entity(options?: { availability?: TimeIntervalCollection; billboard?: BillboardGraphics; box?: BoxGraphics; corridor?: CorridorGraphics; cylinder?: CylinderGraphics; description?: Property; ellipse?: EllipseGraphics; ellipsoid?: EllipsoidGraphics; id?: string; label?: LabelGraphics; model?: ModelGraphics; name?: string; orientation?: Property; parent?: Entity; path?: PathGraphics; plane?: PlaneGraphics; point?: PointGraphics; polygon?: PolygonGraphics; polyline?: PolylineGraphics; polylineVolume?: PolylineVolumeGraphics; position?: PositionProperty; properties?: PropertyBag; rectangle?: RectangleGraphics; show?: boolean; tileset?: Cesium3DTilesetGraphics; viewFrom?: Property; wall?: WallGraphics }): Entity

  • Parameters

    • Optional options: { availability?: TimeIntervalCollection; billboard?: BillboardGraphics; box?: BoxGraphics; corridor?: CorridorGraphics; cylinder?: CylinderGraphics; description?: Property; ellipse?: EllipseGraphics; ellipsoid?: EllipsoidGraphics; id?: string; label?: LabelGraphics; model?: ModelGraphics; name?: string; orientation?: Property; parent?: Entity; path?: PathGraphics; plane?: PlaneGraphics; point?: PointGraphics; polygon?: PolygonGraphics; polyline?: PolylineGraphics; polylineVolume?: PolylineVolumeGraphics; position?: PositionProperty; properties?: PropertyBag; rectangle?: RectangleGraphics; show?: boolean; tileset?: Cesium3DTilesetGraphics; viewFrom?: Property; wall?: WallGraphics }
      • Optional availability?: TimeIntervalCollection
      • Optional billboard?: BillboardGraphics
      • Optional box?: BoxGraphics
      • Optional corridor?: CorridorGraphics
      • Optional cylinder?: CylinderGraphics
      • Optional description?: Property
      • Optional ellipse?: EllipseGraphics
      • Optional ellipsoid?: EllipsoidGraphics
      • Optional id?: string
      • Optional label?: LabelGraphics
      • Optional model?: ModelGraphics
      • Optional name?: string
      • Optional orientation?: Property
      • Optional parent?: Entity
      • Optional path?: PathGraphics
      • Optional plane?: PlaneGraphics
      • Optional point?: PointGraphics
      • Optional polygon?: PolygonGraphics
      • Optional polyline?: PolylineGraphics
      • Optional polylineVolume?: PolylineVolumeGraphics
      • Optional position?: PositionProperty
      • Optional properties?: PropertyBag
      • Optional rectangle?: RectangleGraphics
      • Optional show?: boolean
      • Optional tileset?: Cesium3DTilesetGraphics
      • Optional viewFrom?: Property
      • Optional wall?: WallGraphics

    Returns Entity

Properties

availability

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

billboard: BillboardGraphics

Gets or sets the billboard.

box

box: BoxGraphics

Gets or sets the box.

corridor

corridor: CorridorGraphics

Gets or sets the corridor.

cylinder

cylinder: CylinderGraphics

Gets or sets the cylinder.

Readonly definitionChanged

definitionChanged: Event

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

description

description: Property

Gets or sets the description.

ellipse

ellipse: EllipseGraphics

Gets or sets the ellipse.

ellipsoid

ellipsoid: EllipsoidGraphics

Gets or sets the ellipsoid.

entityCollection

entityCollection: EntityCollection

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

id

id: string

Gets the unique ID associated with this object.

isShowing

isShowing: boolean

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

label

label: LabelGraphics

Gets or sets the label.

model

model: ModelGraphics

Gets or sets the model.

name

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

orientation: Property

Gets or sets the orientation.

parent

parent: Entity

Gets or sets the parent object.

path

path: PathGraphics

Gets or sets the path.

plane

plane: PlaneGraphics

Gets or sets the plane.

point

point: PointGraphics

Gets or sets the point graphic.

polygon

polygon: PolygonGraphics

Gets or sets the polygon.

polyline

polyline: PolylineGraphics

Gets or sets the polyline.

polylineVolume

polylineVolume: PolylineVolumeGraphics

Gets or sets the polyline volume.

position

position: PositionProperty

Gets or sets the position.

properties

properties: PropertyBag

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

propertyNames

propertyNames: any[]

Gets the names of all properties registered on this instance.

rectangle

rectangle: RectangleGraphics

Gets or sets the rectangle.

show

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

tileset: Cesium3DTilesetGraphics

Gets or sets the tileset.

viewFrom

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

wall: WallGraphics

Gets or sets the wall.

Methods

addProperty

  • addProperty(propertyName: string): void

  • Adds a property to this object. Once a property is added, it can be observed with {@link Entity#definitionChanged} and composited with {@link CompositeEntityCollection}

    Parameters

    • propertyName: string

      The name of the property to add.

    Returns void

computeModelMatrix

  • computeModelMatrix(time: JulianDate, result?: Matrix4, scene?: Scene): Matrix4

  • Computes the model matrix for the entity's transform at specified time. Returns undefined if orientation or position are undefined.

    Parameters

    • time: JulianDate

      The time to retrieve model matrix for.

    • Optional result: Matrix4
    • Optional scene: Scene

    Returns Matrix4

    The modified result parameter or a new Matrix4 instance if one was not provided. Result is undefined if position or orientation are undefined.

isAvailable

  • isAvailable(time: JulianDate): boolean

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

    Parameters

    • time: JulianDate

      The time to check availability for.

    Returns boolean

    true if the object should have data during the provided time, false otherwise.

merge

  • merge(source: Entity): void

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

    Parameters

    • source: Entity

      The object to be merged into this object.

    Returns void

removeProperty

  • removeProperty(propertyName: string): void

  • Removed a property previously added with addProperty.

    Parameters

    • propertyName: string

      The name of the property to remove.

    Returns void

Static supportsMaterialsforEntitiesOnTerrain

  • supportsMaterialsforEntitiesOnTerrain(scene: Scene): boolean

  • Checks if the given Scene supports materials besides Color on Entities draped on terrain or 3D Tiles. If this feature is not supported, Entities with non-color materials but no height will instead be rendered as if height is 0.

    Parameters

    • scene: Scene

      The current scene.

    Returns boolean

    Whether or not the current scene supports materials for entities on terrain.

Static supportsPolylinesOnTerrain

  • supportsPolylinesOnTerrain(scene: Scene): boolean

  • Checks if the given Scene supports polylines clamped to terrain or 3D Tiles. If this feature is not supported, Entities with PolylineGraphics will be rendered with vertices at the provided heights and using the arcType parameter instead of clamped to the ground.

    Parameters

    • scene: Scene

      The current scene.

    Returns boolean

    Whether or not the current scene supports polylines on terrain or 3D TIles.