Domain entity for fixed ground assets (stations, facilities, sites).
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Entity.ConstructorOptions |
optional
Initialization options.
|
Extends
Members
Gets or sets whether this entity can be picked in the scene.
When false, clicking on the entity will not select or track it.
- Inherited From:
- Default Value:
true
availability : TimeIntervalCollection|undefined
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.
- Inherited From:
billboard : BillboardGraphics|undefined
Gets or sets the billboard.
- Inherited From:
box : BoxGraphics|undefined
Gets or sets the box.
- Inherited From:
conicSensor : ConicSensorGraphics|undefined
Gets or sets the conic sensor.
- Inherited From:
corridor : CorridorGraphics|undefined
Gets or sets the corridor.
- Inherited From:
customSensor : CustomSensorGraphics|undefined
Gets or sets the custom sensor.
- Inherited From:
cylinder : CylinderGraphics|undefined
Gets or sets the cylinder.
- Inherited From:
readonly definitionChanged : Event
Gets the event that is raised whenever a property or sub-property is changed or modified.
- Inherited From:
description : Property|undefined
Gets or sets the description.
- Inherited From:
ellipse : EllipseGraphics|undefined
Gets or sets the ellipse.
- Inherited From:
ellipsoid : EllipsoidGraphics|undefined
Gets or sets the ellipsoid.
- Inherited From:
entityCollection : EntityCollection
Gets or sets the entity collection that this entity belongs to.
- Inherited From:
Gets the unique ID associated with this object.
- Inherited From:
Gets whether this entity is being displayed, taking into account
the visibility of any ancestor entities.
- Inherited From:
label : LabelGraphics|undefined
Gets or sets the label.
- Inherited From:
model : ModelGraphics|undefined
Gets or sets the model.
- Inherited From:
Gets or sets the name of the object. The name is intended for end-user
consumption and does not need to be unique.
- Inherited From:
orientation : Property|undefined
Gets or sets the orientation in respect to Earth-fixed-Earth-centered (ECEF).
Defaults to east-north-up at entity position.
- Inherited From:
parent : Entity|undefined
Gets or sets the parent object.
- Inherited From:
path : PathGraphics|undefined
Gets or sets the path.
- Inherited From:
plane : PlaneGraphics|undefined
Gets or sets the plane.
- Inherited From:
point : PointGraphics|undefined
Gets or sets the point graphic.
- Inherited From:
polygon : PolygonGraphics|undefined
Gets or sets the polygon.
- Inherited From:
polyline : PolylineGraphics|undefined
Gets or sets the polyline.
- Inherited From:
polylineVolume : PolylineVolumeGraphics|undefined
Gets or sets the polyline volume.
- Inherited From:
position : PositionProperty|undefined
Gets or sets the position.
- Inherited From:
properties : PropertyBag|undefined
Gets or sets the bag of arbitrary properties associated with this entity.
- Inherited From:
Gets the names of all properties registered on this instance.
- Inherited From:
rectangle : RectangleGraphics|undefined
Gets or sets the rectangle.
- Inherited From:
rectangularSensor : RectangularSensorGraphics|undefined
Gets or sets the rectangular sensor.
- Inherited From:
referenceFrame : ReferenceFrame|undefined
Gets or sets the reference frame used for this entity's orientation.
When set, the entity's orientation property is interpreted as being
relative to this reference frame rather than ECEF.
For moving entities like satellites, use
ReferenceFrame.VVLH
to get a velocity-aligned body frame that doesn't wobble as the
entity moves around the Earth.
If not set, inherits the reference frame from the parent entity.
If neither this entity nor any ancestor has a reference frame set,
the orientation is interpreted directly in ECEF (the default behavior).
- Inherited From:
Example:
// Create a satellite entity with VVLH reference frame
const satellite = viewer.entities.add({
position: positionProperty,
referenceFrame: Cesium.ReferenceFrame.VVLH,
orientation: Cesium.Quaternion.fromHeadingPitchRoll(
new Cesium.HeadingPitchRoll(0, Cesium.Math.toRadians(-90), 0) // NADIR pointing
),
});
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.
- Inherited From:
tileset : Cesium3DTilesetGraphics|undefined
Gets or sets the tileset.
- Inherited From:
trackingReferenceFrame : TrackingReferenceFrame
Gets or sets the entity's tracking reference frame.
- Inherited From:
Demo:
viewFrom : Property|undefined
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.
- Inherited From:
wall : WallGraphics|undefined
Gets or sets the wall.
- Inherited From:
Methods
Adds a property to this object. Once a property is added, it can be
observed with
Entity#definitionChanged and composited
with CompositeEntityCollection
| Name | Type | Description |
|---|---|---|
propertyName |
string | The name of the property to add. |
Throws:
-
DeveloperError : "propertyName" is a reserved property name.
-
DeveloperError : "propertyName" is already a registered property.
- Inherited From:
computeModelMatrix(time, result, useOrientation, referenceFrameOverride) → Matrix4
Computes the model matrix for the entity's transform at specified time. Returns undefined if position is undefined.
When the entity has a
Entity#referenceFrame set, the entity's orientation
is interpreted relative to that reference frame. This is useful for satellites
where you want orientation to be relative to the velocity-aligned VVLH frame
rather than the Earth-fixed frame.
| Name | Type | Default | Description |
|---|---|---|---|
time |
JulianDate | The time to retrieve model matrix for. | |
result |
Matrix4 | optional The object onto which to store the result. | |
useOrientation |
boolean |
true
|
optional Whether to use the entity's orientation property. |
referenceFrameOverride |
ReferenceFrame | optional Override the entity's reference frame. |
Returns:
The modified result parameter or a new Matrix4 instance if one was not provided. Result is undefined if position is undefined.
- Inherited From:
Given a time, returns true if this object should have data during that time.
| Name | Type | Description |
|---|---|---|
time |
JulianDate | The time to check availability for. |
Returns:
true if the object should have data during the provided time, false otherwise.
- Inherited From:
Assigns each unassigned property on this object to the value
of the same property on the provided source object.
| Name | Type | Description |
|---|---|---|
source |
Entity | The object to be merged into this object. |
- Inherited From:
Removed a property previously added with addProperty.
| Name | Type | Description |
|---|---|---|
propertyName |
string | The name of the property to remove. |
Throws:
-
DeveloperError : "propertyName" is a reserved property name.
-
DeveloperError : "propertyName" is not a registered property.
- Inherited From: