API reference
API reference
Select your platform
No SDKs available
No versions available

IBodyPose Interface

Encapsulates the pose of a body as a collection of joint poses together constituting a fully-posed skeleton.
IBodyPoses can be generated from live data (using PoseFromBody, for example) or stored/cached off as a reference for comparison (using BodyPoseComparerActiveState, for example).

Properties

SkeletonMapping : ISkeletonMapping
[Get]
The mapping of the skeleton, which characterizes which BodyJointIds are populated by in this body pose and the structure/parentage among them.
Signature 
ISkeletonMapping Oculus.Interaction.Body.PoseDetection.IBodyPose.SkeletonMapping

Events

WhenBodyPoseUpdated : Action
Event indicating that the data in this IBodyPose has been updated.
Observing instances can hook into this event to run their logic only when new data is available (rather than polling).
Signature 
Action Oculus.Interaction.Body.PoseDetection.IBodyPose.WhenBodyPoseUpdated

Methods

GetJointPoseFromRoot ( bodyJointId , pose )
Attempts to return the pose of the requested body joint relative to the root joint (BodyJointId.Body_Root).
Signature 
bool Oculus.Interaction.Body.PoseDetection.IBodyPose.GetJointPoseFromRoot(BodyJointId bodyJointId, out Pose pose)
Parameters
bodyJointId: BodyJointId
pose: out Pose
Returns
bool
GetJointPoseLocal ( bodyJointId , pose )
Attempts to return the pose of the requested body joint, in local space relative to its parent joint (i.e., the BodyJointId retrievable from ISkeletonMapping.TryGetParentJointId(BodyJointId, out BodyJointId)).
Signature 
bool Oculus.Interaction.Body.PoseDetection.IBodyPose.GetJointPoseLocal(BodyJointId bodyJointId, out Pose pose)
Parameters
bodyJointId: BodyJointId
pose: out Pose
Returns
bool
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta