OVRScenePlane Class

A OVRSceneAnchor that has a 2D bounds associated with it.

OVRScenePlane extends MonoBehaviour.

OVRScenePlane extends IOVRSceneComponent.

Overview

Properties

float	Width`[Get]` The plane's width (in the local X-direction), in meters.
float	Height`[Get]` The plane's height (in the local Y-direction), in meters.
Vector2	Offset`[Get]` The offset of the plane with respect to the anchor's pivot.
Vector2	Dimensions`[Get]` The dimensions of the plane.
IReadOnlyList< Vector2 >	Boundary`[Get]` The vertices of the 2D plane boundary.
bool	ScaleChildren`[Get]` Whether the child transforms will be scaled according to the dimensions of this plane.
bool	OffsetChildren`[Get]` Whether the child transforms will be offset according to the offset of this plane.

Details

Properties

float OVRScenePlane.Width
The plane's width (in the local X-direction), in meters.

float OVRScenePlane.Height
The plane's height (in the local Y-direction), in meters.

Vector2 OVRScenePlane.Offset
The offset of the plane with respect to the anchor's pivot. The offset is mostly zero, as objects have the anchor's pivot aligned with centroid of the plane. The Offset is provided in the local coordinate space of the children. See See Also: OVRSceneAnchor to see the transformation of Unity and OpenXR coordinate systems.

Vector2 OVRScenePlane.Dimensions
The dimensions of the plane. This property corresponds to a Vector whose components are (Width, Height).

IReadOnlyList<Vector2> OVRScenePlane.Boundary
The vertices of the 2D plane boundary. The vertices are provided in clockwise order and in plane-space (relative to the plane's local space). The X and Y coordinates of the 2D coordinates are the same as the 3D coordinates. To map the 2D vertices (x, y) to 3D, set the Z coordinate to zero: (x, y, 0).

bool OVRScenePlane.ScaleChildren
Whether the child transforms will be scaled according to the dimensions of this plane. If set to True, all the child transforms will be scaled to the dimensions of this plane immediately. And, if it's set to False, dimensions of this plane will no longer affect the child transforms, and child transforms will retain their current scale. This can be controlled further by using a See Also: OVRSceneObjectTransformType, OVRSceneVolume . Note: if the current game object also contains a , then the volume's scale will take precedence.

bool OVRScenePlane.ScaleChildren

Whether the child transforms will be scaled according to the dimensions of this plane.

If set to True, all the child transforms will be scaled to the dimensions of this plane immediately. And, if it's set to False, dimensions of this plane will no longer affect the child transforms, and child transforms will retain their current scale. This can be controlled further by using a

. Note: if the current game object also contains a , then the volume's scale will take precedence.

bool OVRScenePlane.OffsetChildren
Whether the child transforms will be offset according to the offset of this plane. If set to True, all the child transforms will be offset to the offset of this plane immediately. And, if it's set to False, offsets of this plane will no longer affect the child transforms, and child transforms will retain their current offset. This can be controlled further by using a See Also: OVRSceneObjectTransformType, OVRSceneVolume . Note: if the current game object also contains a , then the volume's offset will take precedence.

bool OVRScenePlane.OffsetChildren

Whether the child transforms will be offset according to the offset of this plane.

If set to True, all the child transforms will be offset to the offset of this plane immediately. And, if it's set to False, offsets of this plane will no longer affect the child transforms, and child transforms will retain their current offset. This can be controlled further by using a

. Note: if the current game object also contains a , then the volume's offset will take precedence.

Did you find this page helpful?