SpaceEntity

new Cesium.SpaceEntity(options, cat)
engine/Source/DataSources/SpaceEntity.js 26

Creates a new SpaceEntity instance using an OMM object (and optionally a CAT object).
Name Type Default Description
options Entity.ConstructorOptions Object describing initialization options
cat any null optional An optional instance of the Catalog (CATT) containing additional metadata.

Extends

Members

availability : TimeIntervalCollection|undefined
engine/Source/DataSources/Entity.js 351

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
engine/Source/DataSources/Entity.js 487

Gets or sets the billboard.
Inherited From:

box : BoxGraphics|undefined
engine/Source/DataSources/Entity.js 493

Gets or sets the box.
Inherited From:

corridor : CorridorGraphics|undefined
engine/Source/DataSources/Entity.js 499

Gets or sets the corridor.
Inherited From:

coverageShowing
engine/Source/DataSources/SpaceEntity.js 183

Gets the current state of the coverage visibility.

cylinder : CylinderGraphics|undefined
engine/Source/DataSources/Entity.js 505

Gets or sets the cylinder.
Inherited From:

readonly definitionChanged : Event
engine/Source/DataSources/Entity.js 369

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

description : Property|undefined
engine/Source/DataSources/Entity.js 511

Gets or sets the description.
Inherited From:

ellipse : EllipseGraphics|undefined
engine/Source/DataSources/Entity.js 517

Gets or sets the ellipse.
Inherited From:

ellipsoid : EllipsoidGraphics|undefined
engine/Source/DataSources/Entity.js 523

Gets or sets the ellipsoid.
Inherited From:

entityCollection : EntityCollection
engine/Source/DataSources/Entity.js 312

Gets or sets the entity collection that this entity belongs to.
Inherited From:

id : string
engine/Source/DataSources/Entity.js 357

Gets the unique ID associated with this object.
Inherited From:

isShowing : boolean
engine/Source/DataSources/Entity.js 427

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

label : LabelGraphics|undefined
engine/Source/DataSources/Entity.js 529

Gets or sets the label.
Inherited From:

model : ModelGraphics|undefined
engine/Source/DataSources/Entity.js 535

Gets or sets the model.
Inherited From:

name : string|undefined
engine/Source/DataSources/Entity.js 380

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:

orbitShowing
engine/Source/DataSources/SpaceEntity.js 175

Gets the current state of the orbit visibility.

orientation : Property|undefined
engine/Source/DataSources/Entity.js 548

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
engine/Source/DataSources/Entity.js 441

Gets or sets the parent object.
Inherited From:

path : PathGraphics|undefined
engine/Source/DataSources/Entity.js 554

Gets or sets the path.
Inherited From:

plane : PlaneGraphics|undefined
engine/Source/DataSources/Entity.js 560

Gets or sets the plane.
Inherited From:

point : PointGraphics|undefined
engine/Source/DataSources/Entity.js 566

Gets or sets the point graphic.
Inherited From:

polygon : PolygonGraphics|undefined
engine/Source/DataSources/Entity.js 572

Gets or sets the polygon.
Inherited From:

polyline : PolylineGraphics|undefined
engine/Source/DataSources/Entity.js 578

Gets or sets the polyline.
Inherited From:

polylineVolume : PolylineVolumeGraphics|undefined
engine/Source/DataSources/Entity.js 584

Gets or sets the polyline volume.
Inherited From:

position : PropagatedPositionProperty
engine/Source/DataSources/SpaceEntity.js 49

properties : PropertyBag|undefined
engine/Source/DataSources/Entity.js 593

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

propertyNames : Array.<string>
engine/Source/DataSources/Entity.js 477

Gets the names of all properties registered on this instance.
Inherited From:

rectangle : RectangleGraphics|undefined
engine/Source/DataSources/Entity.js 605

Gets or sets the rectangle.
Inherited From:

show : boolean
engine/Source/DataSources/Entity.js 387

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
engine/Source/DataSources/Entity.js 541

Gets or sets the tileset.
Inherited From:

trackingReferenceFrame : TrackingReferenceFrame
engine/Source/DataSources/Entity.js 420

Gets or sets the entity's tracking reference frame.
Inherited From:
Demo:

velocity : Object
engine/Source/DataSources/SpaceEntity.js 68

Gets or sets the velocity of the space entity. The velocity is computed using the WasmPositionManager and can be retrieved in either the Fixed (FIXED) or Inertial (INERTIAL) reference frames. This property is read-only.
Properties:
Name Type Description
getValue function Gets the velocity in the fixed frame.
getValueInReferenceFrame function Gets the velocity in the specified reference frame.
Example:
// Get velocity in fixed frame
const velocityFixed = entity.velocity.getValue(time);

// Get velocity in inertial frame
const velocityInertial = entity.velocity.getValueInReferenceFrame(time, Cesium.ReferenceFrame.INERTIAL);

viewFrom : Property|undefined
engine/Source/DataSources/Entity.js 613

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
engine/Source/DataSources/Entity.js 619

Gets or sets the wall.
Inherited From:

Methods

static Cesium.SpaceEntity.getEntitiesByOrbitType(orbitType) → Array
engine/Source/DataSources/SpaceCatalogDataSource.js 272

Retrieves an array of SpaceEntity objects that belong to a specific orbit type.
Name Type Description
orbitType OrbitType
Returns:
An array of SpaceEntity objects.
Example:
// Assuming instance of SpaceEntity class is spaceEntity
const leoEntities = spaceEntity.getEntitiesByOrbitType(OrbitType.LEO);

addProperty(propertyName)
engine/Source/DataSources/Entity.js 664

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:
Inherited From:

computeModelMatrix(time, result, useOrientation) → Matrix4
engine/Source/DataSources/Entity.js 829

Computes the model matrix for the entity's transform at the specified time. Returns undefined if the position is undefined.
Name Type Default Description
time JulianDate The time to retrieve the model matrix for.
result Matrix4 optional The object onto which to store the result.
useOrientation boolean true optional Whether to include the entity's orientation in the model matrix calculation. If set to 'false', the calculation skips the entity orientation.
Returns:
The modified result parameter or a new Matrix4 instance if one was not provided. The result is undefined if the position is undefined.
Inherited From:

isAvailable(time) → boolean
engine/Source/DataSources/Entity.js 643

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:

async loadOMM(jsonOMM) → Promise.<void>
engine/Source/DataSources/SpaceEntity.js 122

Name Type Description
jsonOMM Object The OMM JSON object containing orbit data.
Returns:
A promise that resolves when the OMM data has been loaded.

async loadOMMs(ommArray) → Promise.<void>
engine/Source/DataSources/SpaceEntity.js 165

Name Type Description
ommArray Array.<Object> An array of OMM JSON objects containing orbit data.
Returns:
A promise that resolves when all OMM data has been loaded.

merge(source)
engine/Source/DataSources/Entity.js 720

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:

removeProperty(propertyName)
engine/Source/DataSources/Entity.js 697

Removed a property previously added with addProperty.
Name Type Description
propertyName string The name of the property to remove.
Throws:
Inherited From:

showCoverage(options)
engine/Source/DataSources/SpaceEntity.js 192

Updates the visibility and properties of the space entity's coverage graphics.
Name Type Description
options Object options for the coverage appearance.
Name Type Description
show boolean If true, makes the orbit visible.

showOrbit(options)
engine/Source/DataSources/SpaceEntity.js 227

Updates the visibility and properties of the space entity's orbit graphics.
Name Type Description
options Object options for the orbit's appearance.
Name Type Description
show boolean If true, makes the orbit visible.
material Material optional The material to use for the orbit path. Optional.
width number optional The width of the orbit path. Optional.
leadTime number optional The time ahead to show the orbit. Optional.
trailTime number optional The time behind to show the orbit. Optional.
resolution number optional The resolution of the orbit path. Optional.
referenceEntity Entity optional The reference entity used to define the VVLH frame for the orbit. Optional.

updateAdditiveOrientation(hprObj, timestamp)
engine/Source/DataSources/Entity.js 980

Updates the orientation of the entity in an additive manner. The applied rotation is relative to the current orientation of the entity, treating the current axes as the zero state.
Name Type Description
hprObj HeadingPitchRoll The rotation to apply as a HeadingPitchRoll.
timestamp JulianDate optional Optional timestamp for which to update the orientation. If not provided, updates the first available orientation.
Throws:
  • DeveloperError : If the entity's orientation is of an unsupported type.
Inherited From:
Need help? [email protected]
OrbPro
packages/engine
packages/widgets