Version: 2019.2
LanguageEnglish
  • C#

WorldAnchor

class in UnityEngine.XR.WSA

/

Inherits from:Component

/

Implemented in:UnityEngine.VRModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

The WorldAnchor component allows a GameObject's position to be locked in physical space.

For example, a cube arranged on top of a physical desk with a WorldAnchor applied will remain fixed even as an observer walks around the room. This overrides all manipulation of the GameObject's position and orientation. To move the GameObject, first remove the WorldAnchor and manipulate the Transform normally.

While it is generally recommended to use Destroy instead of DestroyImmediate, it's best to call DestroyImmediate on WorldAnchor objects. Doing so will let you manipulate the Transform of the GameObject including adding a new WorldAnchor.

Properties

isLocatedReturns true if this WorldAnchor is located (read only). A return of false typically indicates a loss of tracking.

Public Methods

GetNativeSpatialAnchorPtrRetrieve a native pointer to the Windows.Perception.Spatial.SpatialAnchor COM object. This function calls IUnknown::AddRef on the pointer before returning it. The pointer must be released by calling IUnknown::Release.
SetNativeSpatialAnchorPtrAssigns the Windows.Perception.Spatial.SpatialAnchor COM pointer maintained by this WorldAnchor.

Events

OnTrackingChangedOnTrackingChanged notifies listeners when this object's tracking state changes.

Delegates

OnTrackingChangedDelegateEvent that is fired when this object's tracking state changes.

Inherited Members

Properties

gameObjectThe game object this component is attached to. A component is always attached to a game object.
tagThe tag of this game object.
transformThe Transform attached to this GameObject.
hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

BroadcastMessageCalls the method named methodName on every MonoBehaviour in this game object or any of its children.
CompareTagIs this game object tagged with tag ?
GetComponentReturns the component of Type type if the game object has one attached, null if it doesn't.
GetComponentInChildrenReturns the component of Type type in the GameObject or any of its children using depth first search.
GetComponentInParentReturns the component of Type type in the GameObject or any of its parents.
GetComponentsReturns all components of Type type in the GameObject.
GetComponentsInChildrenReturns all components of Type type in the GameObject or any of its children.
GetComponentsInParentReturns all components of Type type in the GameObject or any of its parents.
SendMessageCalls the method named methodName on every MonoBehaviour in this game object.
SendMessageUpwardsCalls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.
TryGetComponentGets the component of the specified type, if it exists.
GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the object.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.