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

OVRCameraRig Class

Extends MonoBehaviour
A head-tracked stereoscopic virtual reality camera rig.

Protected Fields

_centerEyeCamera : Camera
Signature
Camera OVRCameraRig._centerEyeCamera
_leftEyeCamera : Camera
Signature
Camera OVRCameraRig._leftEyeCamera
_previousTrackingSpaceTransform : Matrix4x4
Signature
Matrix4x4 OVRCameraRig._previousTrackingSpaceTransform
_rightEyeCamera : Camera
Signature
Camera OVRCameraRig._rightEyeCamera
_skipUpdate : bool
Signature
bool OVRCameraRig._skipUpdate
centerEyeAnchorName : readonly string
Signature
readonly string OVRCameraRig.centerEyeAnchorName
leftControllerAnchorName : readonly string
Signature
readonly string OVRCameraRig.leftControllerAnchorName
leftControllerInHandAnchorName : readonly string
Signature
readonly string OVRCameraRig.leftControllerInHandAnchorName
leftEyeAnchorName : readonly string
Signature
readonly string OVRCameraRig.leftEyeAnchorName
leftHandAnchorDetachedName : readonly string
Signature
readonly string OVRCameraRig.leftHandAnchorDetachedName
leftHandAnchorName : readonly string
Signature
readonly string OVRCameraRig.leftHandAnchorName
leftHandOnControllerAnchorName : readonly string
Signature
readonly string OVRCameraRig.leftHandOnControllerAnchorName
rightControllerAnchorName : readonly string
Signature
readonly string OVRCameraRig.rightControllerAnchorName
rightControllerInHandAnchorName : readonly string
Signature
readonly string OVRCameraRig.rightControllerInHandAnchorName
rightEyeAnchorName : readonly string
Signature
readonly string OVRCameraRig.rightEyeAnchorName
rightHandAnchorDetachedName : readonly string
Signature
readonly string OVRCameraRig.rightHandAnchorDetachedName
rightHandAnchorName : readonly string
Signature
readonly string OVRCameraRig.rightHandAnchorName
rightHandOnControllerAnchorName : readonly string
Signature
readonly string OVRCameraRig.rightHandOnControllerAnchorName
trackerAnchorName : readonly string
Signature
readonly string OVRCameraRig.trackerAnchorName
trackingSpaceName : readonly string
Signature
readonly string OVRCameraRig.trackingSpaceName

Fields

disableEyeAnchorCameras : bool
If true, the cameras on the eyeAnchors will be disabled.
Signature
bool OVRCameraRig.disableEyeAnchorCameras
useFixedUpdateForTracking : bool
If true, all tracked anchors are updated in FixedUpdate instead of Update to favor physics fidelity.
Signature
bool OVRCameraRig.useFixedUpdateForTracking
usePerEyeCameras : bool
If true, separate cameras will be used for the left and right eyes.
Signature
bool OVRCameraRig.usePerEyeCameras

Properties

centerEyeAnchor : Transform
[Get]
Always coincides with average of the left and right eye poses.
Signature
Transform OVRCameraRig.centerEyeAnchor
leftControllerAnchor : Transform
[Get]
Anchors controller pose to fix offset issues for the left hand.
Signature
Transform OVRCameraRig.leftControllerAnchor
leftControllerInHandAnchor : Transform
[Get]
Coincides with the pose of the left controller when it is in a hand.
Signature
Transform OVRCameraRig.leftControllerInHandAnchor
leftEyeAnchor : Transform
[Get]
Always coincides with the pose of the left eye.
Signature
Transform OVRCameraRig.leftEyeAnchor
leftEyeCamera : Camera
[Get]
The left eye camera.
Signature
Camera OVRCameraRig.leftEyeCamera
leftHandAnchor : Transform
[Get]
Always coincides with the pose of the left active input device.
Signature
Transform OVRCameraRig.leftHandAnchor
leftHandAnchorDetached : Transform
[Get]
Coincides with the pose of the left input device if it is detached.
Signature
Transform OVRCameraRig.leftHandAnchorDetached
leftHandOnControllerAnchor : Transform
[Get]
Coincides with the pose of the left hand when it is on a controller.
Signature
Transform OVRCameraRig.leftHandOnControllerAnchor
rightControllerAnchor : Transform
[Get]
Anchors controller pose to fix offset issues for the right hand.
Signature
Transform OVRCameraRig.rightControllerAnchor
rightControllerInHandAnchor : Transform
[Get]
Coincides with the pose of the right controller when it is in a hand.
Signature
Transform OVRCameraRig.rightControllerInHandAnchor
rightEyeAnchor : Transform
[Get]
Always coincides with the pose of the right eye.
Signature
Transform OVRCameraRig.rightEyeAnchor
rightEyeCamera : Camera
[Get]
The right eye camera.
Signature
Camera OVRCameraRig.rightEyeCamera
rightHandAnchor : Transform
[Get]
Always coincides with the pose of the right active input device.
Signature
Transform OVRCameraRig.rightHandAnchor
rightHandAnchorDetached : Transform
[Get]
Coincides with the pose of the left input device if it is detached.
Signature
Transform OVRCameraRig.rightHandAnchorDetached
rightHandOnControllerAnchor : Transform
[Get]
Coincides with the pose of the right hand when it is on a controller.
Signature
Transform OVRCameraRig.rightHandOnControllerAnchor
trackerAnchor : Transform
[Get]
Always coincides with the pose of the sensor.
Signature
Transform OVRCameraRig.trackerAnchor
trackingSpace : Transform
[Get]
Provides a root transform for all anchors in tracking space.
Signature
Transform OVRCameraRig.trackingSpace

Events

TrackingSpaceChanged : Action< Transform >
Occurs when the trackingSpace's transform changes.
This event provides a single argument: the Transform of the tracking space. This is the same as the trackingSpace property.
Signature
Action<Transform> OVRCameraRig.TrackingSpaceChanged
UpdatedAnchors : System.Action< OVRCameraRig >
Occurs when the eye pose anchors have been set.
Signature
System.Action<OVRCameraRig> OVRCameraRig.UpdatedAnchors

Protected Methods

Awake ()
Signature
virtual void OVRCameraRig.Awake()
Returns
void
CheckForAnchorsInParent ()
Signature
void OVRCameraRig.CheckForAnchorsInParent()
Returns
void
CheckForTrackingSpaceChangesAndRaiseEvent ()
Checks for changes to trackingSpace's transform and, if it has changed, raises the TrackingSpaceChanged event.
This method compares the trackingSpace transform's localToWorldMatrix matrix against its value during the last invocation of this method.
If trackingSpace is null, this method has no effect.
Signature
virtual void OVRCameraRig.CheckForTrackingSpaceChangesAndRaiseEvent()
Returns
void
ConfigureAnchor ( root , name )
Signature
virtual Transform OVRCameraRig.ConfigureAnchor(Transform root, string name)
Parameters
root: Transform
name: string
Returns
Transform
FixedUpdate ()
Signature
virtual void OVRCameraRig.FixedUpdate()
Returns
void
OnBeforeRenderCallback ()
Signature
virtual void OVRCameraRig.OnBeforeRenderCallback()
Returns
void
OnDestroy ()
Signature
virtual void OVRCameraRig.OnDestroy()
Returns
void
RaiseUpdatedAnchorsEvent ()
Signature
virtual void OVRCameraRig.RaiseUpdatedAnchorsEvent()
Returns
void
Start ()
Signature
virtual void OVRCameraRig.Start()
Returns
void
Update ()
Signature
virtual void OVRCameraRig.Update()
Returns
void
UpdateAnchors ( updateEyeAnchors , updateHandAnchors )
Signature
virtual void OVRCameraRig.UpdateAnchors(bool updateEyeAnchors, bool updateHandAnchors)
Parameters
updateEyeAnchors: bool
updateHandAnchors: bool
Returns
void

Methods

ComputeTrackReferenceMatrix ()
Signature
virtual Matrix4x4 OVRCameraRig.ComputeTrackReferenceMatrix()
Returns
Matrix4x4
EnsureGameObjectIntegrity ()
Signature
virtual void OVRCameraRig.EnsureGameObjectIntegrity()
Returns
void