This class encapulsates several extension methods that help convert between the Quest's coordinate system and Unity's coorindate system. Use these methods to convert to and from the Quest's local tracking space and Unity's world space, for example.

This class also contains several methods to facilitate native interop, as the native plugin uses a different coordinate system than Unity (for example, OVRPlugin.Posef). These methods are used by the Meta XR Core SDK, but typically should not necessary in application code.

Static Member Functions

static OVRPose ToTrackingSpacePose

( this Transform transform,

Camera camera )

Converts the given world-space transform to an OVRPose in tracking space.

The "tracking space" refers to the local coordinate system of the Quest device. This method uses a camera's world-space transform to calculate the transform between the Quest's tracking space and Unity's world space, then applies it to the transform to compute that transform in the device's tracking space.

Parameters

transform

A transform that will be converted to a tracking space pose.

camera

The camera whose transform is driven by the HMD. This is often the main camera.

Returns

Returns the pose of the transform in tracking space.

static OVRPose ToWorldSpacePose

( this OVRPose trackingSpacePose )

Converts the given pose from tracking-space to world-space.

The "tracking space" refers to the local coordinate system of the Quest device. This method uses the main camera's world-space transform to calculate the transform between the Quest's tracking space and Unity's world space, then applies it to the trackingSpacePose to compute that pose in Unity world space. Deprecated

This method is obsolete. Use ToWorldSpacePose(OVRPose, Camera) instead.

Parameters

trackingSpacePose

The pose, in tracking-space, to convert to world space.

Returns

The trackingSpacePose in world space.

static OVRPose ToWorldSpacePose

( this OVRPose trackingSpacePose,

Camera mainCamera )

Converts the given pose from tracking-space to world-space.

The "tracking space" refers to the local coordinate system of the Quest device. This method uses mainCamera 's world-space transform to calculate the transform between the Quest's tracking space and Unity's world space, then applies it to the trackingSpacePose to compute that pose in Unity world space.This is the inverse operation of ToTrackingSpacePose.

Parameters

trackingSpacePose

The pose to convert to world-space.

mainCamera

The camera whose transform is driven by the HMD. This is often the main camera.

Returns

trackingSpacePose in world space.

static OVRPose ToHeadSpacePose

( this OVRPose trackingSpacePose )

Converts the given pose from tracking-space to head-space.

The "tracking space" refers to the local coordinate system of the Quest device. This method converts a pose in tracking space to a pose relative to the XRNode.Head.

Parameters

trackingSpacePose

The pose, in tracking space, that should be converted to head space.

Returns

trackingSpacePose in head space.

static OVRPose ToHeadSpacePose

( this Transform transform,

Camera camera )

Converts the given world-space transform to an OVRPose in head space.

The "head space" refers to the local coordinate system of the Quest HMD. This method converts the given transform to an equivalent pose relative to the user's head.

Parameters

transform

The transform to convert to head space.

camera

The camera whose transform is driven by the Quest HMD. This is often the main camera.

Returns

transform converted to a head relative pose.

static OVRPose ToOVRPose

( this Transform t,

bool isLocal )

Converts the given transform to an OVRPose.

Parameters

The transform to convert to a pose.

isLocal

If true, uses the local position and transform of t . Otherwise, uses the world space position and rotation.

Returns

t as a OVRPose.

static void FromOVRPose

( this Transform t,

OVRPose pose,

bool isLocal )

Sets a transform to the given OVRPose.

Parameters

The transform whose position and rotation will be set.

pose

The OVRPose to convert to t .

isLocal

If true, t 's local position and transform are set. Otherwise, sets the world position and rotation.

static OVRPose ToOVRPose

( this OVRPlugin.Posef p )

Converts an OVRPlugin.Posef to an OVRPose.

OVRPlugin.Posef is typically used for native interop with native plugins, and uses a different coordinate system (right-handed as opposed to Unity's left-handed coordinate system).This method converts the right-handed OVRPlugin.Posef to a left-handed OVRPose compatible with Unity's coordinate system.This method is for advanced usage.

Parameters

A right-handed pose acquired from a native function call.

Returns

p converted to an OVRPose.

static OVRTracker.Frustum ToFrustum

( this OVRPlugin.Frustumf f )

Converts an OVRPlugin.Frustumf to an OVRTracker.Frustum.

OVRPlugin.Frustumf is typically used for native interop with native plugins. This method converts that native format into a format that is more compatible with Unity.This method is for advanced usage.

Parameters

The OVRPlugin.Frustumf to convert to OVRTracker.Frustum.

Returns

f converted to an OVRTracker.Frustum.

static Color FromColorf

( this OVRPlugin.Colorf c )

Converts a OVRPlugin.Colorf to a UnityEngine Color.

This method is used to convert color data between the native OVRPlugin.Colorf format and a UnityEngine Color.This method is for advanced usage and is not typically used by application code.

Parameters

A color in native color format.

Returns

c as a UnityEngine Color.

static OVRPlugin.Colorf ToColorf

( this Color c )

Converts a UnityEngine Color to a OVRPlugin.Colorf.

This method is used to convert color data between the native OVRPlugin.Colorf format and a UnityEngine Color.This method is for advanced usage and is not typically used by application code.

Parameters

A color in Unity's Color format.

Returns

c as a OVRPlugin.Colorf.

static Vector2 FromSizef

( this OVRPlugin.Sizef v )

Converts a OVRPlugin.Sizef to a UnityEngine Vector2.

This method is used to convert size data between the native OVRPlugin.Sizef format and a UnityEngine Vector2.This method is for advanced usage and is not typically used by application code.

Parameters

A size in OVRPlugin's native format.

Returns

v as a UnityEngine Vector2.

static OVRPlugin.Sizef ToSizef

( this Vector2 v )

Converts a Vector2 to a OVRPlugin.Sizef.

This method is used to convert size data between the native OVRPlugin.Sizef format and a UnityEngine Vector2.This method is for advanced usage and is not typically used by application code.

Parameters

A size as a Vector2.

Returns

v as an OVRPlugin compatible OVRPlugin.Sizef.

static Vector2 FromVector2f

( this OVRPlugin.Vector2f v )

Converts a OVRPlugin.Vector2f to a UnityEngine Vector2.

This method is used to convert vector data between the native OVRPlugin.Vector2f format and a UnityEngine Vector2.This method is for advanced usage and is not typically used by application code.

Parameters

A vector in OVRPlugin's native format.

Returns

v as a UnityEngine Vector2.

static Vector2 FromFlippedXVector2f

( this OVRPlugin.Vector2f v )

Converts a OVRPlugin.Vector2f to a UnityEngine Vector2.

This method is used to convert vector data between the native OVRPlugin.Vector2f format and a UnityEngine Vector2.This method negates the X component of the OVRPlugin.Vector2f.This method is for advanced usage and is not typically used by application code.

Parameters

A vector in OVRPlugin's native format.

Returns

v as a UnityEngine Vector2.

static OVRPlugin.Vector2f ToVector2f

( this Vector2 v )

Converts a Vector2 to a OVRPlugin.Vector2f.

This method is used to convert vector data between the native OVRPlugin.Vector2f format and a UnityEngine Vector2.This method is for advanced usage and is not typically used by application code.

Parameters

A UnityEngine Vector2.

Returns

v as a OVRPlugin.Vector2f.

static Vector3 FromSize3f

( this OVRPlugin.Size3f v )

Converts size information between the native plugin and Unity format.

This method is used to convert size data between the native OVRPlugin.Size3f format and a UnityEngine Vector3.This method is for advanced usage and is not typically used by application code.

Parameters

A size as a OVRPlugin.Size3f.

Returns

v as a UnityEngine Vector3.

static OVRPlugin.Size3f ToSize3f

( this Vector3 v )

Converts size information between the native plugin and Unity format.

This method is used to convert size data between the native OVRPlugin.Size3f format and a UnityEngine Vector3.This method is for advanced usage and is not typically used by application code.

Parameters

A size as a UnityEngine Vector3.

Returns

v as a OVRPlugin.Size3f.

static Vector3 FromVector3f

( this OVRPlugin.Vector3f v )

Converts a 3d vector between the native plugin and Unity format.

This method is used to convert a 3d vector between the native OVRPlugin.Vector3f format and a UnityEngine Vector3.This method is for advanced usage and is not typically used by application code.

Parameters

A 3d vector as an OVRPlugin.Vector3f.

Returns

v as a UnityEngine Vector3.

static Vector3 FromFlippedXVector3f

( this OVRPlugin.Vector3f v )

Converts a 3d vector between the native plugin and Unity format.

This method is used to convert a 3d vector between the native OVRPlugin.Vector3f format and a UnityEngine Vector3.This method negates the X component of v .This method is for advanced usage and is not typically used by application code.

Parameters

A 3d vector as an OVRPlugin.Vector3f.

Returns

v as a UnityEngine Vector3.

static Vector3 FromFlippedZVector3f

( this OVRPlugin.Vector3f v )

Converts a 3d vector between the native plugin and Unity format.

This method is used to convert a 3d vector between the native OVRPlugin.Vector3f format and a UnityEngine Vector3.This method negates the Z component of v .This method is for advanced usage and is not typically used by application code.

Parameters

A 3d vector as an OVRPlugin.Vector3f.

Returns

v as a UnityEngine Vector3.

static OVRPlugin.Vector3f ToVector3f

( this Vector3 v )

Converts a 3d vector between the native plugin and Unity format.

This method is used to convert a 3d vector between the native OVRPlugin.Vector3f format and a UnityEngine Vector3.This method is for advanced usage and is not typically used by application code.

Parameters

A 3d vector as UnityEngine Vector3.

Returns

v as an OVRPlugin.Vector3f.

See Also

FromVector3f

static OVRPlugin.Vector3f ToFlippedXVector3f

( this Vector3 v )

Converts a 3d vector between the native plugin and Unity format.

Parameters

A 3d vector as UnityEngine Vector3.

Returns

v as an OVRPlugin.Vector3f.

See Also

FromFlippedXVector3f

static OVRPlugin.Vector3f ToFlippedZVector3f

( this Vector3 v )

Converts a 3d vector between the native plugin and Unity format.

Parameters

A 3d vector as UnityEngine Vector3.

Returns

v as an OVRPlugin.Vector3f.

See Also

FromFlippedZVector3f

static Vector4 FromVector4f

( this OVRPlugin.Vector4f v )

Converts a 4d vector between the native plugin and Unity format.

This method is used to convert a 4d vector between the native OVRPlugin.Vector4f format and a UnityEngine Vector4.This method is for advanced usage and is not typically used by application code.

Parameters

A 4d vector as an OVRPlugin.Vector4f.

Returns

v as a UnityEngine Vector4.

See Also

ToVector4f

static OVRPlugin.Vector4f ToVector4f

( this Vector4 v )

Converts a 4d vector between the native plugin and Unity format.

This method is used to convert a 4d vector between the native OVRPlugin.Vector4f format and a UnityEngine Vector4.This method is for advanced usage and is not typically used by application code.

Parameters

A 4d vector as UnityEngine Vector4.

Returns

v as an OVRPlugin.Vector4f.

See Also

FromVector4f

static Quaternion FromQuatf

( this OVRPlugin.Quatf q )

Converts a quaternion between the native plugin and Unity format.

This method is used to convert a quaternion between the native OVRPlugin.Quatf format and a UnityEngine Quaternion.This method is for advanced usage and is not typically used by application code.

Parameters

A quaternion as an OVRPlugin.Quatf.

Returns

q as a UnityEngine Quaternion.

See Also

ToQuatf

static Quaternion FromFlippedXQuatf

( this OVRPlugin.Quatf q )

Converts a quaternion between the native plugin and Unity format.

This method is used to convert a quaternion between the native OVRPlugin.Quatf format and a UnityEngine Quaternion.This method negates the Y and Z components of the quaternion, which has the effect of flipping the rotation about the X axis.This method is for advanced usage and is not typically used by application code.

Parameters

A quaternion as an OVRPlugin.Quatf.

Returns

q as a UnityEngine Quaternion.

See Also

ToFlippedXQuatf

static Quaternion FromFlippedZQuatf

( this OVRPlugin.Quatf q )

Converts a quaternion between the native plugin and Unity format.

This method is used to convert a quaternion between the native OVRPlugin.Quatf format and a UnityEngine Quaternion.This method negates the X and Y components of the quaternion, which has the effect of flipping the rotation about the Z axis.This method is for advanced usage and is not typically used by application code.

Parameters

A quaternion as an OVRPlugin.Quatf.

Returns

q as a UnityEngine Quaternion.

See Also

ToFlippedZQuatf

static OVRPlugin.Quatf ToQuatf

( this Quaternion q )

Converts a quaternion between the native plugin and Unity format.

This method is used to convert a quaternion between the native OVRPlugin.Quatf format and a UnityEngine Quaternion.This method is for advanced usage and is not typically used by application code.

Parameters

A quaternion as a UnityEngine Quaternion.

Returns

q as an OVRPlugin.Quatf.

See Also

FromQuatf

static OVRPlugin.Quatf ToFlippedXQuatf

( this Quaternion q )

Converts a quaternion between the native plugin and Unity format.

Parameters

A quaternion as a UnityEngine Quaternion.

Returns

q as an OVRPlugin.Quatf.

See Also

FromFlippedXQuatf

static OVRPlugin.Quatf ToFlippedZQuatf

( this Quaternion q )

Converts a quaternion between the native plugin and Unity format.

Parameters

A quaternion as a UnityEngine Quaternion.

Returns

q as an OVRPlugin.Quatf.

See Also

FromFlippedZQuatf

static OVR.OpenVR.HmdMatrix34_t ConvertToHMDMatrix34

( this Matrix4x4 m )

Converts a matrix between the native plugin and Unity format.

This method is used to convert a matrix between the native OVR.OpenVR.HmdMatrix34_t format and a UnityEngine Matrix4x4.This method negates the Z axis of the rotation and translation, which converts between the native right-handed coordinate system and Unity's left-handed coordinate system.This method is for advanced usage and is not typically used by application code.

Parameters

The Matrix4x4 to convert.

Returns

Returns m as an OVR.OpenVR.HmdMatrix34_t.

static Transform FindChildRecursive

( this Transform parent,

string name )

Recursively searches for a child transform with the given name.

Note that only children of parent are considered. parent itself is not included in the search.A child transform is considered a match if any part of its name contains name .

Parameters

parent

The transform at which to begin the search.

name

The name of the transform to find.

Returns

Returns the first child of parent with name , or null, if no such child exists.

static bool Equals

( this Gradient gradient,

Gradient otherGradient )

Compares two Gradients for equality.

Parameters