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

OVRScenePlane Class

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

Properties

Boundary : IReadOnlyList< Vector2 >
[Get]
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).
Signature
IReadOnlyList<Vector2> OVRScenePlane.Boundary
Dimensions : Vector2
[Get]
The dimensions of the plane.
This property corresponds to a Vector whose components are (Width, Height).
Signature
Vector2 OVRScenePlane.Dimensions
Height : float
[Get]
The plane's height (in the local Y-direction), in meters.
Signature
float OVRScenePlane.Height
Offset : Vector2
[Get]
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
Signature
Vector2 OVRScenePlane.Offset
OffsetChildren : bool
[Get][Set]
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
Signature
bool OVRScenePlane.OffsetChildren
ScaleChildren : bool
[Get][Set]
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
Signature
bool OVRScenePlane.ScaleChildren
Width : float
[Get]
The plane's width (in the local X-direction), in meters.
Signature
float OVRScenePlane.Width