Wikitude.ImageTracker Class Reference

Image Trackers are used to recognize image targets bundled in .wtc files by using a TargetCollectionResource or from the cloud by using a CloudRecognitionService. More...

Inheritance diagram for Wikitude.ImageTracker:

Public Member Functions
void	StopExtendedTracking ()
	Stops and immediately restarts extended tracking with a new tracking map. It is useful when tracking was lost and the user would like to return to the target to reinitialize extended tracking. More...

Public Attributes
OnExtendedTrackingQualityChangedEvent	OnExtendedTrackingQualityChanged = new OnExtendedTrackingQualityChangedEvent()
	Called whenever the quality of extended tracking changes. During a tracking session, the extended tracking quality might get better or worse, depending on the scene that is captured. This method is also called when extended tracking processed the first frame. More...
Public Attributes inherited from Wikitude.TrackerBehaviour
OnTargetsLoadedEvent	OnTargetsLoaded = new OnTargetsLoadedEvent()
	Called when a tracker was successfully initialized. More...
OnErrorLoadingTargetsEvent	OnErrorLoadingTargets = new OnErrorLoadingTargetsEvent()
	Called when the targets could not be loaded. Parameters error The error describing what went wrong. More...
OnInitializationErrorEvent	OnInitializationError = new OnInitializationErrorEvent()
	Called when the tracker could not be initialized. Parameters error The error describing what went wrong. More...

Properties
TargetSourceType	TargetSourceType [get, set]
	Determines if the source for the targets is bundled in a .wtc file and loaded with a TargetCollectionResource, or if the CloudRecognitionService is used instead. Has to be set before OnEnable is called, otherwise it will have no effect. More...
TargetCollectionResource	TargetCollectionResource [get, set]
	The TargetCollectionResource that should be used to load the .wtc file. The .wtc file can be located either on the device, by placing it in the StreamingAssets folder, or at a custom URL. Is used only if the TargetSourceType property is set to TargetCollectionResource. Has to be set before OnEnable is called, otherwise it will have no effect. More...
CloudRecognitionService	CloudRecognitionService [get, set]
	The CloudRecognitionService that should be used to recognize targets in the cloud. Is used only if the TargetSourceType property is set to CloudRecognitionService. Has to be set before OnEnable is called, otherwise it will have no effect. More...
int	MaximumNumberOfConcurrentTrackableTargets [get, set]
	An integer value denoting how many concurrent targets are to be recognized and tracked simultaneously. Depending on the current device, more targets can be recognized and tracked at the same time. It's best to set this to the lowest number required by your use case. The Wikitude SDK will stop searching for new image targets in case the limit is reached which results in better performance and longer battery life. If you don't need to track multiple targets at the same time, this value should be set to 1. Has to be set before OnEnable is called, otherwise it will have no effect. More...
ImageRecognitionRangeExtension	RangeExtension [get, set]
	Defines the image recognition range extension that should be sued when image recognition is active. Setting this property to On on 32 bit devices might degrade performance significantly. Has to be set before OnEnable is called, otherwise it will have no effect. More...
TrackerEfficiencyMode	TrackerEfficiencyMode [get, set]
	Defines the efficiency mode for the tracker. Has to be set before OnEnable is called, otherwise it will have no effect. More...
Dictionary< string, float >	PhysicalTargetImageHeights [get, set]
	Use this property to specify the physical height of individual image targets that are included in the .wtc file. Physical target image heights are necessary as soon as any distance related API is used from ImageTarget. This property is helpful if the physical target image heights are missing in the .wtc file or if they should be overwritten. Has to be set before OnEnable is called, otherwise it will have no effect. More...

Detailed Description

Image Trackers are used to recognize image targets bundled in .wtc files by using a TargetCollectionResource or from the cloud by using a CloudRecognitionService.

When Image Trackers are created at runtime, make sure that all the relevant properties are set before the OnEnable method is called by Unity. At OnEnable, the native tracker is created and all information needs to be available.

Member Function Documentation

void Wikitude.ImageTracker.StopExtendedTracking ( )

inline

Stops and immediately restarts extended tracking with a new tracking map. It is useful when tracking was lost and the user would like to return to the target to reinitialize extended tracking.

Member Data Documentation

OnExtendedTrackingQualityChangedEvent Wikitude.ImageTracker.OnExtendedTrackingQualityChanged = new OnExtendedTrackingQualityChangedEvent()

Called whenever the quality of extended tracking changes. During a tracking session, the extended tracking quality might get better or worse, depending on the scene that is captured. This method is also called when extended tracking processed the first frame.

Property Documentation

CloudRecognitionService Wikitude.ImageTracker.CloudRecognitionService

getset

The CloudRecognitionService that should be used to recognize targets in the cloud. Is used only if the TargetSourceType property is set to CloudRecognitionService. Has to be set before OnEnable is called, otherwise it will have no effect.

int Wikitude.ImageTracker.MaximumNumberOfConcurrentTrackableTargets

getset

An integer value denoting how many concurrent targets are to be recognized and tracked simultaneously. Depending on the current device, more targets can be recognized and tracked at the same time. It's best to set this to the lowest number required by your use case. The Wikitude SDK will stop searching for new image targets in case the limit is reached which results in better performance and longer battery life. If you don't need to track multiple targets at the same time, this value should be set to 1. Has to be set before OnEnable is called, otherwise it will have no effect.

Dictionary<string, float> Wikitude.ImageTracker.PhysicalTargetImageHeights

getset

Use this property to specify the physical height of individual image targets that are included in the .wtc file. Physical target image heights are necessary as soon as any distance related API is used from ImageTarget. This property is helpful if the physical target image heights are missing in the .wtc file or if they should be overwritten. Has to be set before OnEnable is called, otherwise it will have no effect.

ImageRecognitionRangeExtension Wikitude.ImageTracker.RangeExtension

getset

Defines the image recognition range extension that should be sued when image recognition is active. Setting this property to On on 32 bit devices might degrade performance significantly. Has to be set before OnEnable is called, otherwise it will have no effect.

TargetCollectionResource Wikitude.ImageTracker.TargetCollectionResource

getset

The TargetCollectionResource that should be used to load the .wtc file. The .wtc file can be located either on the device, by placing it in the StreamingAssets folder, or at a custom URL. Is used only if the TargetSourceType property is set to TargetCollectionResource. Has to be set before OnEnable is called, otherwise it will have no effect.

TargetSourceType Wikitude.ImageTracker.TargetSourceType

getset

Determines if the source for the targets is bundled in a .wtc file and loaded with a TargetCollectionResource, or if the CloudRecognitionService is used instead. Has to be set before OnEnable is called, otherwise it will have no effect.

TrackerEfficiencyMode Wikitude.ImageTracker.TrackerEfficiencyMode

getset

Defines the efficiency mode for the tracker. Has to be set before OnEnable is called, otherwise it will have no effect.