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

OVRSceneVolume Class

Extends MonoBehaviour, IOVRSceneComponent
A OVRSceneAnchor that has a 3D bounds associated with it.

Properties

Depth : float
[Get]
The depth (in the local Z-direction), in meters.
Signature
float OVRSceneVolume.Depth
Dimensions : Vector3
[Get]
The dimensions of the volume.
This property corresponds to a Vector whose components are (Width, Height, Depth).
Signature
Vector3 OVRSceneVolume.Dimensions
Height : float
[Get]
The height (in the local Y-direction), in meters.
Signature
float OVRSceneVolume.Height
Offset : Vector3
[Get]
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
Signature
Vector3 OVRSceneVolume.Offset
OffsetChildren : bool
[Get][Set]
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
Signature
bool OVRSceneVolume.OffsetChildren
ScaleChildren : bool
[Get][Set]
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
Signature
bool OVRSceneVolume.ScaleChildren
Width : float
[Get]
The width (in the local X-direction), in meters.
Signature
float OVRSceneVolume.Width