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

OVRBody Class

Extends MonoBehaviour
Implements OVRSkeleton.IOVRSkeletonDataProvider, OVRSkeletonRenderer.IOVRSkeletonRendererDataProvider
This class implements OVRSkeleton.IOVRSkeletonDataProvider in order to provide body tracking data per frame, and is responsible for stopping and starting body tracking.
Furthermore, it defines the skeleton type and implements OVRSkeletonRenderer.IOVRSkeletonRendererDataProvider in case the body tracking state needs to be provided to renderer-based classes. Use this class to read body tracking pose data, accessible via OVRSkeleton.IOVRSkeletonDataProvider.GetSkeletonPoseData, to drive the bone transforms of a character, or to use for pose estimation purposes. For more information, see Body Tracking for Movement SDK for Unity.
Typically, you would use this in conjunction with an OVRSkeleton in order to transform bones and/or an OVRSkeletonRenderer to render them.

Properties

BodyState : OVRPlugin.? BodyState
[Get]
The raw BodyState data used to populate the OVRSkeleton.
Query this value for metadata associated with BodyState, such as joint locations or confidence values.
Signature
OVRPlugin.? BodyState BodyState
Fidelity : OVRPlugin.BodyTrackingFidelity2
[Get][Set]
This field manages body tracking fidelity, which is associated with body tracking quality that is currently being used in an app.
Fidelity is determined by the app's runtime settings as well as the capabilities of the device that is runs on.
Signature
OVRPlugin.BodyTrackingFidelity2 Fidelity
ProvidedSkeletonType : OVRPlugin.BodyJointSet
[Get][Set]
The skeleton type joint set that is used when updating the body state.
Change this value based on the joint set that is compatible with your character.
Signature
OVRPlugin.BodyJointSet ProvidedSkeletonType

Methods

GetBodyTrackingCalibrationStatus ()
Returns the current body tracking calibration status.
Signature
OVRPlugin.BodyTrackingCalibrationState GetBodyTrackingCalibrationStatus()
Returns
OVRPlugin.BodyTrackingCalibrationState  Body calibration status in the form of OVRPlugin.BodyTrackingCalibrationState.
GetBodyTrackingFidelityStatus ()
This function returns the current body tracking fidelity.
Use this function to understand the visual fidelity of body tracking of your app during runtime.
Signature
OVRPlugin.BodyTrackingFidelity2 GetBodyTrackingFidelityStatus()
Returns
OVRPlugin.BodyTrackingFidelity2  Body tracking fidelity as OVRPlugin.BodyTrackingFidelity2.

Static Methods

ResetBodyTrackingCalibration ()
Resets body tracking calibration.
Signature
static bool ResetBodyTrackingCalibration()
Returns
bool true if body tracking calibration was successful; false if not.
SetRequestedJointSet ( jointSet )
Attempts to set the requested joint set.
If you call this function and request a joint set that is not supported, you will get a false value returned as a result.
Signature
static bool SetRequestedJointSet(OVRPlugin.BodyJointSet jointSet)
Parameters
jointSet: OVRPlugin.BodyJointSet  The requested joint set.
Returns
bool true if joint set requested was set; false if not.
SuggestBodyTrackingCalibrationOverride ( height )
Runs body tracking calibration with the height specified in meters.
Use this function to enforce the height of the user.
Signature
static bool SuggestBodyTrackingCalibrationOverride(float height)
Parameters
height: float  The height in meters.
Returns
bool true if the height calibration worked, false if not.