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

OVRCameraRig Class

A head-tracked stereoscopic virtual reality camera rig.
OVRCameraRig extends MonoBehaviour.

Overview

Properties

Camera
The left eye camera.
Camera
The right eye camera.
Transform
Provides a root transform for all anchors in tracking space.
Transform
Always coincides with the pose of the left eye.
Transform
Always coincides with average of the left and right eye poses.
Transform
Always coincides with the pose of the right eye.
Transform
Always coincides with the pose of the left active input device.
Transform
Always coincides with the pose of the right active input device.
Transform
Coincides with the pose of the left input device if it is detached.
Transform
Coincides with the pose of the left input device if it is detached.
Transform
Coincides with the pose of the left controller when it is in a hand.
Transform
Coincides with the pose of the left hand when it is on a controller.
Transform
Coincides with the pose of the right controller when it is in a hand.
Transform
Coincides with the pose of the right hand when it is on a controller.
Transform
Anchors controller pose to fix offset issues for the left hand.
Transform
Anchors controller pose to fix offset issues for the right hand.
Transform
Always coincides with the pose of the sensor.

Events

System.Action< OVRCameraRig >
Occurs when the eye pose anchors have been set.
Action< Transform >
Occurs when the trackingSpace's transform changes.

Data Fields

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

Object Data

bool
readonly string
readonly string
readonly string
readonly string
readonly string
readonly string
readonly string
readonly string
readonly string
readonly string
readonly string
readonly string
readonly string
readonly string
readonly string
Camera
Camera
Camera
Matrix4x4

Object Data

void
Awake ( )
void
Start ( )
void
void
Update ( )
void
void
UpdateAnchors
( bool updateEyeAnchors,
bool updateHandAnchors )
void
void
Checks for changes to trackingSpace's transform and, if it has changed, raises the TrackingSpaceChanged event.
void
Transform
ConfigureAnchor
( Transform root,
string name )
void

Public Member Functions

Details

Properties

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

Events

System.Action<OVRCameraRig> OVRCameraRig.UpdatedAnchors ( )
Occurs when the eye pose anchors have been set.
Action<Transform> OVRCameraRig.TrackingSpaceChanged ( )
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.

Fields

bool OVRCameraRig.usePerEyeCameras
If true, separate cameras will be used for the left and right eyes.
bool OVRCameraRig.useFixedUpdateForTracking
If true, all tracked anchors are updated in FixedUpdate instead of Update to favor physics fidelity.
Note:
: This will cause visible judder unless you tick exactly once per frame using a custom physics update, because you'll be sampling the position at different times into each frame.
bool OVRCameraRig.disableEyeAnchorCameras
If true, the cameras on the eyeAnchors will be disabled.
Note:
: The main camera of the game will be used to provide VR rendering. And the tracking space anchors will still be updated to provide reference poses.

Object Data

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

Object Data

virtual void OVRCameraRig.Awake ( )
No description available.
virtual void OVRCameraRig.Start ( )
No description available.
virtual void OVRCameraRig.FixedUpdate ( )
No description available.
virtual void OVRCameraRig.Update ( )
No description available.
virtual void OVRCameraRig.OnDestroy ( )
No description available.
virtual void OVRCameraRig.UpdateAnchors
( bool updateEyeAnchors,
bool updateHandAnchors )
No description available.
virtual void OVRCameraRig.OnBeforeRenderCallback ( )
No description available.
virtual void OVRCameraRig.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.
virtual void OVRCameraRig.RaiseUpdatedAnchorsEvent ( )
No description available.
virtual Transform OVRCameraRig.ConfigureAnchor
( Transform root,
string name )
No description available.
void OVRCameraRig.CheckForAnchorsInParent ( )
No description available.

Member Functions

virtual void OVRCameraRig.EnsureGameObjectIntegrity ( )
No description available.
virtual Matrix4x4 OVRCameraRig.ComputeTrackReferenceMatrix ( )
No description available.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon