The default reference frame to use when calling getEntityPose
.
By default, this is the origin
reference frame.
The time in milliseconds since the previous timestamp, capped to ContextService.maxDeltaTime
A coordinate system representing the floor.
While the stage
always represents a physical surface,
the floor
entity may represent a virtual floor.
This value caps the deltaTime for each frame. By default, the value is 1/3s (333.3ms)
An entity representing the local origin, which is oriented with +Y up. The local origin changes infrequently, is platform dependent, and is the suggested origin for a rendering scenegraph.
Any time the local origin changes, the localOriginChange event is raised.
An event that fires when the origin changes.
An event that is raised after the render event
An event that is raised when it is an approriate time to render graphics. This event fires after the update event.
A coordinate system representing the physical space in which the user is free to move around, positioned on the surface the user is standing on, where +X is east, +Y is up, and +Z is south (East-Up-South), if geolocation is known. If the stage is not geolocated, then the +X and +Z directions are arbitrary.
Subscribe to pose updates for the given entity id
The current (absolute) time according to the current reality. This value is arbitrary until the first ContextService.updateEvent.
A monotonically increasing value (in milliseconds) for the current frame state. This value is useful only for doing accurate timing, not for determining the absolute time. Use ContextService.time for absolute time. This value is -1 until the first ContextService.updateEvent.
Unsubscribe to pose updates for the given entity id
An event that is raised after managed entities have been updated for the current frame.
An coordinate system representing the user, where +X is right, +Y is up, and -Z is the direction the user is facing
An coordinate system representing the rendering view, where +X is right, +Y is up, and -Z is the direction of the view.
If geopose is available, this is the accuracy of the user's heading
If geopose is available, this is the accuracy of the user's cartographic location
If geopose is available, this is the accuracy of the user's elevation
alias for origin
An event that fires when the local origin changes.
The serialized frame state for this frame
Deprecated. Use timestamp property.
Create a new EntityPose instance to represent the pose of an entity relative to a given reference frame. If no reference frame is specified, then the pose is based on the context's defaultReferenceFrame.
the entity to track
The intended reference frame. Defaults to this.defaultReferenceFrame
.
Create a frame state.
Deprecated. Use EntityService.createFixed
(app.entity.createFixed
);
Deprecated. To be removed. Use the defaultReferenceFrame property.
Get the cartographic position of an Entity for the current context time
Gets the current pose of an entity, relative to a given reference frame.
The entity whose state is to be queried.
The intended reference frame. Defaults to this.defaultReferenceFrame
.
Deprecated. To be removed.
Deprecated. To be removed. Use the defaultReferenceFrame property if necessary.
Process the next frame state (which should come from the current reality viewer)
Subscribe to pose updates for an entity specified by the given id
the id of the desired entity
A new or existing entity instance matching the given id
Generated using TypeDoc
Provides a means of querying the current state of reality.