The set of entities that this session is aware of.
An event that fires when the local origin changes.
An entity positioned near the user, aligned with the local East-North-Up coordinate system.
An entity positioned near the user, aligned with the East-Up-South coordinate system. This useful for converting to the Y-Up convention used in some libraries, such as three.js.
This value caps the deltaTime for each frame
An event that is raised when it is an approriate time to render graphics. This event fires after the update event.
The set of subscribed entities.
An event that is raised when all remotely managed entities are are up-to-date for the current frame. It is suggested that all modifications to locally managed entities should occur within this event.
An entity representing the location and orientation of the user.
The set of entities representing well-known reference frames. These are assumed to be readily available to applications.
The current frame
The serialized frame state for this frame
deprecated
Get the default reference frame to use when calling getEntityPose
.
By default, this is the localOriginEastNorthUp
reference frame.
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
.
If the position and orientation exist for the given entity, an
object with the fields position
and orientation
, both of type
Cartesian3
. Otherwise undefined.
Get the current time
Set the default reference frame for getCurrentEntityState
.
Adds an entity to this session's set of tracked entities.
The unique identifier of an entity.
The entity that was subscribed to.
Generated using TypeDoc
Provides a means of querying the current state of reality.
This class adds the following message handlers to any sessions managed by the session service:
ar.context.subscribe
- Subscribes the session to updates from an entity with the provided id.This service sends the following messages to managed sessions
ar.context.update
- Indicates to this context that the session wants to be focused on.