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

OVRSceneVolume Class

A OVRSceneAnchor that has a 3D bounds associated with it.
OVRSceneVolume extends MonoBehaviour.
OVRSceneVolume extends IOVRSceneComponent.

Overview

Properties

float
Width[Get]
The width (in the local X-direction), in meters.
float
Height[Get]
The height (in the local Y-direction), in meters.
float
Depth[Get]
The depth (in the local Z-direction), in meters.
Vector3
The dimensions of the volume.
Vector3
Offset[Get]
The offset of the volume with respect to the anchor's pivot.
bool
Whether the child transforms will be scaled according to the dimensions of this volume.
bool
Whether the child transforms will be offset according to the offset of this volume.

Details

Properties

float OVRSceneVolume.Width
The width (in the local X-direction), in meters.
float OVRSceneVolume.Height
The height (in the local Y-direction), in meters.
float OVRSceneVolume.Depth
The depth (in the local Z-direction), in meters.
Vector3 OVRSceneVolume.Dimensions
The dimensions of the volume.
This property corresponds to a Vector whose components are (Width, Height, Depth).
Vector3 OVRSceneVolume.Offset
The offset of the volume with respect to the anchor's pivot.
The offset is mostly zero, as most objects have the anchor's pivot aligned with the top face of the volume.
The offset is not zero in cases where the anchor's pivot point is aligned with another element, such as the seated area for a couch, defined as a plane.
The Offset is provided in the local coordinate space of the children. See
See Also:
to see the transformation of Unity and OpenXR coordinate systems.
bool OVRSceneVolume.ScaleChildren
Whether the child transforms will be scaled according to the dimensions of this volume.
If set to True, all the child transforms will be scaled to the dimensions of this volume immediately. And, if it's set to False, dimensions of this volume will no longer affect the child transforms, and child transforms will retain their current scale. This can be controlled further by using a .
bool OVRSceneVolume.OffsetChildren
Whether the child transforms will be offset according to the offset of this volume.
If set to True, all the child transforms will be offset to the offset of this volume immediately. And, if it's set to False, offsets of this volume will no longer affect the child transforms, and child transforms will retain their current offset. This can be controlled further by using a .
Did you find this page helpful?
Thumbs up icon
Thumbs down icon