TrackableBehaviour Class Reference

The base class for all TrackableBehaviours in Vuforia This class serves both as an augmentation definition for a Trackable in the editor as well as a tracked Trackable result at runtime More...

Inheritance diagram for TrackableBehaviour:

Classes
struct	StatusChangeResult
	The result of a trackable changing its Status Both previous and new status are provided More...
struct	StatusInfoChangeResult
	The result of a trackable changing its StatusInfo Both previous and new statusInfo are provided More...

Public Types
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,   WRONG_SCALE = 8 }
	Information on the tracking status. Gives the primary reason about the problem with tracking (STATUS::NO_POSE or STATUS::LIMITED). More...

Public Member Functions
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 onTrackableStatusChangedAction Action to be registered. More...
void	RegisterOnTrackableStatusInfoChanged (Action< StatusInfoChangeResult > onTrackableStatusChangedAction)
	Subscribe a method to be called when the StatusInfo of the TrackableBehaviour changes. 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...

Properties
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...

Detailed Description

The base class for all TrackableBehaviours in Vuforia This class serves both as an augmentation definition for a Trackable in the editor as well as a tracked Trackable result at runtime

Member Enumeration Documentation

enum Status

strong

The tracking status of the TrackableBehaviour.

Enumerator
NO_POSE	Pose for the trackable could not be delivered.
LIMITED	The tracking is limited.
DETECTED	The trackable was detected.
TRACKED	The trackable was tracked.
EXTENDED_TRACKED	The trackable was extended tracked.

enum StatusInfo

strong

Information on the tracking status. Gives the primary reason about the problem with tracking (STATUS::NO_POSE or STATUS::LIMITED).

Enumerator
NORMAL	Status is normal
UNKNOWN	Unknown reason for limited status.
INITIALIZING	Not enough information yet for accurate tracking.
RELOCALIZING	The tracking system is currently relocalizing.
EXCESSIVE_MOTION	Moving too fast for accurate tracking.
INSUFFICIENT_FEATURES	Not enough features for accurate tracking.
INSUFFICIENT_LIGHT	Not enough light for accurate tracking.
NO_DETECTION_RECOMMENDING_GUIDANCE	Could not snap the target
WRONG_SCALE	The target scale does not match the physical scale

Member Function Documentation

virtual void OnFrameIndexUpdate ( int  newFrameIndex )

virtual

Is triggered by the StateManager after each render frame

Parameters

newFrameIndex

Frame index of processed frame, multiple render frames can have the same frame index

Reimplemented in CylinderTargetBehaviour.

virtual void OnTrackerUpdate ( Status  newStatus, StatusInfo  newStatusInfo  )

virtual

Is triggered by the TrackerBehavior after it has updated.

void RegisterOnTrackableStatusChanged

(

Action< StatusChangeResult >

onTrackableStatusChangedAction

)

Subscribe a method to be called when the Status of the TrackableBehaviour changes.

Parameters

onTrackableStatusChangedAction

Action to be registered.

void RegisterOnTrackableStatusInfoChanged

(

Action< StatusInfoChangeResult >

onTrackableStatusChangedAction

)

Subscribe a method to be called when the StatusInfo of the TrackableBehaviour changes.

bool UnregisterOnTrackableStatusChanged

(

Action< StatusChangeResult >

onTrackableStatusChangedAction

)

Unsubscribe a method from being called when the Status of the TrackableBehaviour changes

void UnregisterOnTrackableStatusInfoChanged

(

Action< StatusInfoChangeResult >

onTrackableStatusChangedAction

)

Unsubscribe a method from being called when the StatusInfo of the TrackableBehaviour changes

Property Documentation

Status CurrentStatus

get

The tracking status of the TrackableBehaviour

StatusInfo CurrentStatusInfo

get

Information on the tracking status. Gives the primary reason about the problem with tracking (STATUS::NO_POSE or STATUS::LIMITED).

virtual Trackable Trackable

get

The Trackable created at runtime that is augmented by this TrackableBehaviour

string TrackableName

get

The name of the Trackable.