C++ Java Unity
Unity Reference
ImageTargetBehaviour Class Reference

This class serves both as an augmentation definition for an ImageTarget in the editor as well as a tracked image target result at runtime More...

Inheritance diagram for ImageTargetBehaviour:
DataSetTrackableBehaviour TrackableBehaviour WorldCenterTrackableBehaviour VuforiaMonoBehaviour

Public Member Functions

VirtualButtonBehaviour CreateVirtualButton (string vbName, Vector2 position, Vector2 size)
 This method creates a Virtual Button and adds it to this Image Target as a direct child. More...
 
void DestroyVirtualButton (string vbName)
 Destroys the virtual button with the given name. More...
 
Vector2 GetSize ()
 Returns the size of this target in scene units More...
 
IEnumerable< VirtualButtonBehaviourGetVirtualButtonBehaviours ()
 Returns the virtual button behaviours for this imageTargetBehaviour More...
 
void SetHeight (float height)
 Set the height (y-dimension) of the target in scene units. This will scale the target uniformly. The dataset of this target has to be deactivated before setting the size. More...
 
void SetWidth (float width)
 Set the width (x-dimension) of the target in scene units. This will scale the target uniformly. The dataset of this target has to be deactivated before setting the size. 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 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 UnregisterTrackableEventHandler (ITrackableEventHandler trackableEventHandler)
 This method unregisters a Tracker event handler. Returns "false" if event handler does not exist. More...
 

Static Public Member Functions

static VirtualButtonBehaviour CreateVirtualButton (string vbName, Vector2 localScale, GameObject immediateParent)
 This methods adds the Virtual Button as a child of "immediateParent". Returns null if "immediateParent" is not an Image Target or a child of an Image Target. More...
 

Protected Member Functions

override bool CorrectScaleImpl ()
 Scales the Trackable uniformly More...
 
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...
 
- Protected Member Functions inherited from DataSetTrackableBehaviour
virtual void Awake ()
 
- Protected Member Functions inherited from TrackableBehaviour
bool EnforceUniformScaling ()
 Scales the Trackable uniformly More...
 
virtual bool SetScale (Vector3 size)
 Set scale-value of this game object based on one dimension. The largest dimension is used as scale value. More...
 
bool SetScaleFromHeight (float height, float aspectRatio)
 Set scale-value of this game object based on the target height. This method should be used only for 2D-targets More...
 
bool SetScaleFromWidth (float width, float aspectRatio)
 Set scale-value of this game object based on the target width. This method should be used only for 2D-targets More...
 

Properties

ImageTarget ImageTarget [get]
 The image target that this ImageTargetBehaviour augments 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...
 
- Properties inherited from WorldCenterTrackableBehaviour
Trackable Trackable [get]
 The Trackable created at runtime that is augmented by this 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 DataSetTrackableBehaviour
string mDataSetPath = ""
 
- Protected Attributes inherited from TrackableBehaviour
bool mInitializedInEditor = false
 
bool mPreserveChildSize = false
 
Vector3 mPreviousScale = Vector3.zero
 This value is used to identify non-uniform scaling of the trackable. More...
 
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...
 

Detailed Description

This class serves both as an augmentation definition for an ImageTarget in the editor as well as a tracked image target result at runtime

Member Function Documentation

override bool CorrectScaleImpl ( )
protectedvirtual

Scales the Trackable uniformly

Reimplemented from TrackableBehaviour.

VirtualButtonBehaviour CreateVirtualButton ( string  vbName,
Vector2  position,
Vector2  size 
)

This method creates a Virtual Button and adds it to this Image Target as a direct child.

static VirtualButtonBehaviour CreateVirtualButton ( string  vbName,
Vector2  localScale,
GameObject  immediateParent 
)
static

This methods adds the Virtual Button as a child of "immediateParent". Returns null if "immediateParent" is not an Image Target or a child of an Image Target.

void DestroyVirtualButton ( string  vbName)

Destroys the virtual button with the given name.

Vector2 GetSize ( )

Returns the size of this target in scene units

IEnumerable<VirtualButtonBehaviour> GetVirtualButtonBehaviours ( )

Returns the virtual button behaviours for this imageTargetBehaviour

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 SetHeight ( float  height)

Set the height (y-dimension) of the target in scene units. This will scale the target uniformly. The dataset of this target has to be deactivated before setting the size.

void SetWidth ( float  width)

Set the width (x-dimension) of the target in scene units. This will scale the target uniformly. The dataset of this target has to be deactivated before setting the size.

Property Documentation

The image target that this ImageTargetBehaviour augments