C++ Java Unity
Unity Reference
AnchorBehaviour Class Reference
Inheritance diagram for AnchorBehaviour:
TrackableBehaviour VuforiaMonoBehaviour

Public Member Functions

void ConfigureAnchor (Anchor anchor)
 Set the anchor that was created using the PositionalDeviceTracker. This sets up the AnchorBehaviour so its pose will be updated More...
 
void UnConfigureAnchor ()
 Resets the AnchorBehaviour to an unconfigured state. It's unregistered from the trackable system and its pose is no longer updated. It becomes unanchored. More...
 
- Public Member Functions inherited from TrackableBehaviour
virtual void OnFrameIndexUpdate (int newFrameIndex)
 Is triggered by the StateManager after each render frame More...
 
virtual void OnTrackerUpdate (Status newStatus, StatusInfo newStatusInfo)
 Is triggered by the TrackerBehavior after it has updated. More...
 
void RegisterOnTrackableStatusChanged (Action< StatusChangeResult > onTrackableStatusChangedAction)
 Subscribe a method to be called when the Status of the TrackableBehaviour changes.

Parameters
onTrackableStatusChangedActionAction to be registered.
More...
 
void RegisterOnTrackableStatusInfoChanged (Action< StatusInfoChangeResult > onTrackableStatusChangedAction)
 Subscribe a method to be called when the StatusInfo of the TrackableBehaviour changes. More...
 
void RegisterTrackableEventHandler (ITrackableEventHandler trackableEventHandler)
 This method registers a new Tracker event handler at the Tracker. These handlers are called as soon as ALL Trackables have been updated in this frame. More...
 
bool UnregisterOnTrackableStatusChanged (Action< StatusChangeResult > onTrackableStatusChangedAction)
 Unsubscribe a method from being called when the Status of the TrackableBehaviour changes More...
 
void UnregisterOnTrackableStatusInfoChanged (Action< StatusInfoChangeResult > onTrackableStatusChangedAction)
 Unsubscribe a method from being called when the StatusInfo of the TrackableBehaviour changes More...
 
bool UnregisterTrackableEventHandler (ITrackableEventHandler trackableEventHandler)
 This method unregisters a Tracker event handler. Returns "false" if event handler does not exist. More...
 

Protected Member Functions

override void InternalUnregisterTrackable ()
 This method disconnects the TrackableBehaviour from it's associated trackable. Use it only if you know what you are doing - e.g. when you want to destroy a trackable, but reuse the TrackableBehaviour. More...
 

Additional Inherited Members

- Public Types inherited from TrackableBehaviour
enum  Status {
  NO_POSE = 0,
  LIMITED = 1,
  DETECTED = 2,
  TRACKED = 3,
  EXTENDED_TRACKED = 4
}
 The tracking status of the TrackableBehaviour. More...
 
enum  StatusInfo {
  NORMAL = 0,
  UNKNOWN = 1,
  INITIALIZING = 2,
  RELOCALIZING = 3,
  EXCESSIVE_MOTION = 4,
  INSUFFICIENT_FEATURES = 5,
  INSUFFICIENT_LIGHT = 6,
  NO_DETECTION_RECOMMENDING_GUIDANCE = 7
}
 Information on the tracking status. Gives the primary reason about the problem with tracking (STATUS::NO_POSE or STATUS::LIMITED). More...
 
- Protected Attributes inherited from TrackableBehaviour
bool mInitializedInEditor = false
 
Status mStatus = Status.NO_POSE
 
StatusInfo mStatusInfo = StatusInfo.UNKNOWN
 
Trackable mTrackable
 
string mTrackableName = ""
 For dataset-trackables this value is retrieved from the dataset and it is used for detecting that the specified trackable in the dataset is not valid anymore. More...
 
- Properties inherited from TrackableBehaviour
Status CurrentStatus [get]
 The tracking status of the TrackableBehaviour More...
 
StatusInfo CurrentStatusInfo [get]
 Information on the tracking status. Gives the primary reason about the problem with tracking (STATUS::NO_POSE or STATUS::LIMITED). More...
 
virtual Trackable Trackable [get]
 The Trackable created at runtime that is augmented by this TrackableBehaviour More...
 
string TrackableName [get]
 The name of the Trackable. More...
 

Member Function Documentation

void ConfigureAnchor ( Anchor  anchor)

Set the anchor that was created using the PositionalDeviceTracker. This sets up the AnchorBehaviour so its pose will be updated

Parameters
anchor
override void InternalUnregisterTrackable ( )
protectedvirtual

This method disconnects the TrackableBehaviour from it's associated trackable. Use it only if you know what you are doing - e.g. when you want to destroy a trackable, but reuse the TrackableBehaviour.

Implements TrackableBehaviour.

void UnConfigureAnchor ( )

Resets the AnchorBehaviour to an unconfigured state. It's unregistered from the trackable system and its pose is no longer updated. It becomes unanchored.