Instant Trackables are used by Instant Trackers to specify which augmentations should be used during tracking. It also provides information about tracking status. More...

Inheritance diagram for Wikitude.InstantTrackable:

Public Attributes
OnInitializationStartedEvent	OnInitializationStarted = new OnInitializationStartedEvent()
	Called when scene initialization is started. During the initialization phase, properties such as TrackingPlaneOrientation and DeviceHeightAboveGround can be changed in the parent Instant Tracker. More...

OnInitializationStoppedEvent	OnInitializationStopped = new OnInitializationStoppedEvent()
	Called when scene initialization is stopped. More...

OnSceneRecognizedEvent	OnSceneRecognized = new OnSceneRecognizedEvent()
	Called when the scene started tracking. Is also called if the scene was recognized again after being lost. More...

OnSceneLostEvent	OnSceneLost = new OnSceneLostEvent()
	Called when the scene stopped tracking. More...

OnPlaneRecognizedEvent	OnPlaneRecognized = new OnPlaneRecognizedEvent()
	Called when a new plane is recognized. More...

OnPlaneTrackedEvent	OnPlaneTracked = new OnPlaneTrackedEvent()
	Called when a new plane is tracked. More...

OnPlaneLostEvent	OnPlaneLost = new OnPlaneLostEvent()
	Called when a plane is lost. More...

Properties
GameObject	PlaneDrawable `[get, set]`
	Gets or sets the drawable that should be instantiated when a new plane is recognized. Multiple instances of this drawable will be created, as more planes are detected. When the plane 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 Plane parameter that gets passed in an OnPlaneRecognized callback. 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

Instant Trackables are used by Instant Trackers to specify which augmentations should be used during tracking. It also provides information about tracking status.

Instant Trackables are not moved during tracking, but the WikitudeCamera is placed relative to the tracked trackable.

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

OnInitializationStartedEvent Wikitude.InstantTrackable.OnInitializationStarted = new OnInitializationStartedEvent()

Called when scene initialization is started. During the initialization phase, properties such as TrackingPlaneOrientation and DeviceHeightAboveGround can be changed in the parent Instant Tracker.

Parameters

InstantTarget Information about scene

OnInitializationStoppedEvent Wikitude.InstantTrackable.OnInitializationStopped = new OnInitializationStoppedEvent()

Called when scene initialization is stopped.

Parameters

InstantTarget Information about scene

OnPlaneLostEvent Wikitude.InstantTrackable.OnPlaneLost = new OnPlaneLostEvent()

Called when a plane is lost.

Parameters

Wikitude.Plane Information about the plane that was lost

OnPlaneRecognizedEvent Wikitude.InstantTrackable.OnPlaneRecognized = new OnPlaneRecognizedEvent()

Called when a new plane is recognized.

Parameters

Wikitude.Plane Information about the plane that was recognized

OnPlaneTrackedEvent Wikitude.InstantTrackable.OnPlaneTracked = new OnPlaneTrackedEvent()

Called when a new plane is tracked.

Parameters

Wikitude.Plane Information about the plane that is tracked

OnSceneLostEvent Wikitude.InstantTrackable.OnSceneLost = new OnSceneLostEvent()

Called when the scene stopped tracking.

Parameters

InstantTarget Information about scene

OnSceneRecognizedEvent Wikitude.InstantTrackable.OnSceneRecognized = new OnSceneRecognizedEvent()

Called when the scene started tracking. Is also called if the scene was recognized again after being lost.

Parameters

InstantTarget Information about scene

Property Documentation

GameObject Wikitude.InstantTrackable.PlaneDrawable

getset

Gets or sets the drawable that should be instantiated when a new plane is recognized. Multiple instances of this drawable will be created, as more planes are detected. When the plane 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 Plane parameter that gets passed in an OnPlaneRecognized callback.

Public Attributes

Properties

Detailed Description

Member Data Documentation

Property Documentation