Wikitude.TrackableBehaviour Class Reference

Trackables are used by trackers to update 3D objects in Unity based on tracked targets. More...

Inherits MonoBehaviour.

Public Attributes
OnEnterFieldOfVisionEvent	OnEnterFieldOfVision = new OnEnterFieldOfVisionEvent()
	Called when a target is recognized and is withing the field of vision. More...
OnExitFieldOfVisionEvent	OnExitFieldOfVision = new OnExitFieldOfVisionEvent()
	Called when the tracked target exits the field of vision. More...

Properties
string	TargetPattern [get, set]
	Gets or sets the target pattern. More...
bool	ExtendedTracking [get]
	Toggles extended tracking. More...
string[]	TargetsForExtendedTracking [get, set]
	Specifies the targets that will be used for extended tracking. More...
bool	AutoToggleVisibility [get, set]
	Specifies wether the trackable is automatically enabled or disabled based on the visibility of the target. More...

Detailed Description

Trackables are used by trackers to update 3D objects in Unity based on tracked targets.

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 Start function is called on the parent tracker. Trackables added after that will not work correctly.

Member Data Documentation

OnEnterFieldOfVisionEvent Wikitude.TrackableBehaviour.OnEnterFieldOfVision = new OnEnterFieldOfVisionEvent()

Called when a target is recognized and is withing the field of vision.

Parameters

targetName

Name of the target from the collection that was recognized

OnExitFieldOfVisionEvent Wikitude.TrackableBehaviour.OnExitFieldOfVision = new OnExitFieldOfVisionEvent()

Called when the tracked target exits the field of vision.

///

Parameters

targetName

Name of the target from the collection that was lost

Property Documentation

bool Wikitude.TrackableBehaviour.AutoToggleVisibility

getset

Specifies wether the trackable is automatically enabled or disabled based on the visibility of the target.

Setting this to false will enable you to control the visibility of the augmentation independent of the visibility of the target.

true if the the trackable should be toggled automatically based on the visibility of the target; otherwise, false.

bool Wikitude.TrackableBehaviour.ExtendedTracking

get

Toggles extended tracking.

string Wikitude.TrackableBehaviour.TargetPattern

getset

Gets or sets the target pattern.

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

string [] Wikitude.TrackableBehaviour.TargetsForExtendedTracking

getset

Specifies the targets that will be used for extended tracking.

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

The targets for extended tracking.