Meta Developers

OVRSceneAnchor Class

Represents a scene anchor.

OVRSceneAnchor extends MonoBehaviour.

Overview

Properties

OVRSpace	Space`[Get]` The runtime handle of this scene anchor.
Guid	Uuid`[Get]` The universally unique identifier for this scene anchor.
OVRAnchor	Anchor`[Get]` Associated OVRAnchor.
bool	IsTracked`[Get]` Indicates whether this anchor is tracked by the system.

Public Member Functions

void	Initialize ( OVRAnchor anchor )
void	InitializeFrom ( OVRSceneAnchor other ) Initializes this scene anchor from an existing scene anchor.

Static Public Member Functions

static void	GetSceneAnchors ( List< OVRSceneAnchor > anchors ) Get the list of all scene anchors that the OVRSceneManager created.
static void	GetSceneAnchorsOfType< T > ( List< T > anchors ) Get the list of all scene anchors filtered by type.

Details

Detailed Description

A scene anchor is a type of anchor that is provided by the system. It represents an item in the physical environment, such as a plane or volume. Scene anchors are created by the OVRSceneManager.

Properties

OVRSpace OVRSceneAnchor.Space
The runtime handle of this scene anchor.

Guid OVRSceneAnchor.Uuid
The universally unique identifier for this scene anchor.

OVRAnchor OVRSceneAnchor.Anchor
Associated OVRAnchor.

bool OVRSceneAnchor.IsTracked
Indicates whether this anchor is tracked by the system.

Member Functions

void OVRSceneAnchor.Initialize ( OVRAnchor anchor )
No description available.

void OVRSceneAnchor.InitializeFrom ( OVRSceneAnchor other )
Initializes this scene anchor from an existing scene anchor. Parameters other An existing OVRSceneAnchor from which to initialize this scene anchor. Exceptions ArgumentNullException Thrown if other is null. InvalidOperationException Thrown if this OVRSceneAnchor is already associated with a scene anchor.

Static Member Functions

static void OVRSceneAnchor.GetSceneAnchors ( List< OVRSceneAnchor > anchors )
Get the list of all scene anchors that the OVRSceneManager created. Anchor components such as OVRSceneRoom, OVRScenePlane, and OVRSceneVolume all have a OVRSceneAnchor component, so this method should be used to find those sibling components. Parameters anchors A list of OVRSceneAnchors to populate. Any existing elements in the list will be removed. Exceptions ArgumentNullException Thrown if anchors is null.

static void OVRSceneAnchor.GetSceneAnchors
( List< OVRSceneAnchor > anchors )

Get the list of all scene anchors that the OVRSceneManager created.

Anchor components such as OVRSceneRoom, OVRScenePlane, and OVRSceneVolume all have a OVRSceneAnchor component, so this method should be used to find those sibling components.

Parameters

anchors

A list of OVRSceneAnchors to populate. Any existing elements in the list will be removed.

Exceptions

ArgumentNullException

Thrown if anchors is null.

static void OVRSceneAnchor.GetSceneAnchorsOfType< T > ( List< T > anchors )
Get the list of all scene anchors filtered by type. Anchor components such as OVRSceneRoom, OVRScenePlane, and OVRSceneVolume all have a OVRSceneAnchor component, so this method should be used to find those sibling components. This method traverses all OVRSceneAnchor instantiated by the OVRSceneManager and filters them based on whether they have the given component. Others T The type of component the OVRSceneAnchor must have. Parameters anchors A list of components of type T to populate. Any existing elements in the list will be removed. Exceptions ArgumentNullException Thrown if anchors is null.

static void OVRSceneAnchor.GetSceneAnchorsOfType< T >
( List< T > anchors )

Get the list of all scene anchors filtered by type.

Anchor components such as OVRSceneRoom, OVRScenePlane, and OVRSceneVolume all have a OVRSceneAnchor component, so this method should be used to find those sibling components.

This method traverses all OVRSceneAnchor instantiated by the OVRSceneManager and filters them based on whether they have the given component.

Others

The type of component the OVRSceneAnchor must have.

Parameters

anchors

A list of components of type T to populate. Any existing elements in the list will be removed.

Exceptions

ArgumentNullException

Thrown if anchors is null.

Did you find this page helpful?