Wikitude Unity Expert Edition
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

ScalingMode ScalingMode [get, set]
 Defines the scaling mode, that should be applied on the target in the scene. 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...
 

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

ScalingMode Wikitude.ImageTrackable.ScalingMode
getset

Defines the scaling mode, that should be applied on the target in the scene.