All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Modules Pages
Loading...
Searching...
No Matches
AnchorBehaviour Class Reference

An anchor that helps stabilize a GameObjects position in the real world. More...

Inheritance diagram for AnchorBehaviour:
ObserverBehaviour VuforiaMonoBehaviour

Public Member Functions

void ConfigureAnchor (string name, HitTestResult hitTestResult)
 Creates a plane anchor at the location of the hit test result. The behaviour is attached to that anchor.
 
void ConfigureAnchor (string name, Vector3 position, Quaternion rotation)
 Creates a mid-air anchor using the transform of the pose (position/rotation) where it should be anchored. The behaviour is attached to that anchor.
 
void UnconfigureAnchor ()
 Detaches the behaviour from an anchor.
 

Additional Inherited Members

- Properties inherited from ObserverBehaviour
int? ID [get]
 The runtime Id of the Observer.
 
string TargetName [get]
 Name of the target of the Observer.
 
TargetStatus TargetStatus = TargetStatus.NotObserved [get]
 Current status information of the target.
 
- Events inherited from ObserverBehaviour
Action< ObserverBehaviourOnBehaviourDestroyed
 Triggered when this behaviour is destroyed. Can be used for script cleanup.
 
Action< ObserverBehaviour, TargetStatusOnTargetStatusChanged
 Triggered when the TargetStatus changes.
 

Detailed Description

An anchor that helps stabilize a GameObjects position in the real world.

Member Function Documentation

◆ ConfigureAnchor() [1/2]

void ConfigureAnchor ( string name,
HitTestResult hitTestResult )
inline

Creates a plane anchor at the location of the hit test result. The behaviour is attached to that anchor.

Parameters
nameThe logical name of the anchor. This must be unique among all created anchors.
hitTestResultThe HitTestResult containing the pose at which the anchor will be created on a plane.

◆ ConfigureAnchor() [2/2]

void ConfigureAnchor ( string name,
Vector3 position,
Quaternion rotation )
inline

Creates a mid-air anchor using the transform of the pose (position/rotation) where it should be anchored. The behaviour is attached to that anchor.

Parameters
nameThe logical name of the anchor. This must be unique among all created anchors.
positionThe position at which the anchor will be created.
rotationThe rotation of the anchor that will be created.

◆ UnconfigureAnchor()

void UnconfigureAnchor ( )
inline

Detaches the behaviour from an anchor.