Wikitude Unity Plugin
Public Attributes | Properties | List of all members
Wikitude.ImageTrackable Class Reference

Image Trackables are used by Image Trackers to specify which augmentations correspond to which targets. It also provides information about tracking status. More...

Inheritance diagram for Wikitude.ImageTrackable:
Wikitude.Trackable

Public Attributes

OnImageRecognizedEvent OnImageRecognized = new OnImageRecognizedEvent()
 Called when a new image target is recognized. More...
 
OnImageLostEvent OnImageLost = new OnImageLostEvent()
 Called when the currently tracked image target is lost. More...
 

Properties

bool ExtendedTracking [get, set]
 Toggles extended tracking. When set to true, target names in TargetsForExtendedTracking will be registered for extended tracking. More...
 
string[] TargetsForExtendedTracking [get, set]
 Specifies the targets that will be used for extended tracking. Is only considered if ExtendedTracking is set to true. More...
 
- Properties inherited from Wikitude.Trackable
string TargetPattern [get, set]
 Gets or sets the target pattern that identify which targets from the collection should be used for this trackable. More...
 
GameObject Drawable [get, set]
 Gets or sets the drawable that should be instantiated when a new target is recognized. In case the tracker for this trackable can track multiple targets, multiple instances of this drawable will be created. When the target corresponding to an instantiated drawable is lost, the drawable is destroyed with it. If the drawable is set to null, an empty GameObject will be created instead. You can access this GameObject through the Drawable property of the Target parameter that gets passed in an OnRecognized callback. More...
 
bool AutoToggleVisibility [get, set]
 Specifies whether the trackable is automatically enabled or disabled based on the visibility of the target. More...
 

Detailed Description

Image Trackables are used by Image Trackers to specify which augmentations correspond to which targets. It also provides information about tracking status.

When a single target is being tracked, its corresponding trackable is not moved, and the WikitudeCamera is placed relative to the trackable. When multiple targets are being tracked, one of them is considered fixed and the WikitudeCamera is placed relative to this fixed trackable. The trackables corresponding to the other targets are then placed relative to the fixed trackable and the WikitudeCamera.

When trackables are created at runtime, make sure that it is set as a child of the tracker responsible for the tracker and that the relevant properties are set before the OnEnable function is called on the parent tracker. Trackables added after that will not work correctly.

Member Data Documentation

OnImageLostEvent Wikitude.ImageTrackable.OnImageLost = new OnImageLostEvent()

Called when the currently tracked image target is lost.

Parameters
ImageTargetInformation about the target that was lost
OnImageRecognizedEvent Wikitude.ImageTrackable.OnImageRecognized = new OnImageRecognizedEvent()

Called when a new image target is recognized.

Parameters
ImageTargetInformation about the target that was recognized

Property Documentation

bool Wikitude.ImageTrackable.ExtendedTracking
getset

Toggles extended tracking. When set to true, target names in TargetsForExtendedTracking will be registered for extended tracking.

string [] Wikitude.ImageTrackable.TargetsForExtendedTracking
getset

Specifies the targets that will be used for extended tracking. Is only considered if ExtendedTracking is set to true.

Can contain * to mean zero or more of any character and ? to mean zero or one of any character.

The targets for extended tracking.