C++ Java Unity
Unity Reference
UserDefinedTargetBuildingBehaviour Class Reference

This Component can be used to create new ImageTargets at runtime. It can be configured to start scanning automatically or via a call from an external script. Registered event handlers will be informed of changes in the frame quality as well as new TrackableSources More...

Inheritance diagram for UserDefinedTargetBuildingBehaviour:
VuforiaMonoBehaviour

Public Member Functions

void BuildNewTarget (string targetName, float screenSizeWidth)
 This will start building a new target and report back to the event handlers as soon as a new TrackableSource is available. More...
 
void RegisterEventHandler (IUserDefinedTargetEventHandler eventHandler)
 Registers an event handler with this UserDefinedTargetBuildingBehaviour which will be called on events More...
 
void RegisterOnFrameQualityChangedEventHandler (Action< ImageTargetBuilder.FrameQuality > handler)
 Register for event that's called when the UserDefinedTargetBehaviour reports a new frame Quality More...
 
void RegisterOnInitializedEventHandler (Action handler)
 Register for event that's called when the UserDefinedTargetBehaviour has been initialized More...
 
void RegisterOnNewTrackableSourceEventHandler (Action< TrackableSource > handler)
 Register for event that's called when a new trackable source is available More...
 
void StartScanning ()
 Starts scanning the current camera image for features. This will trigger callbacks to the registered event handlers whenever the frame quality changes. If 'StopTrackerWhileScanning' is set, this will stop the ObjectTracker More...
 
void StopScanning ()
 Stops scanning, event handlers will be informed. If 'StopTrackerWhileScanning' is set, this will resume the ObjectTracker More...
 
bool UnregisterEventHandler (IUserDefinedTargetEventHandler eventHandler)
 Unregisters an event handler More...
 
bool UnregisterOnFrameQualityChangedEventHandler (Action< ImageTargetBuilder.FrameQuality > handler)
 Unregister from event that's called when the UserDefinedTargetBehaviour reports a new frame Quality More...
 
bool UnregisterOnInitializedEventHandler (Action handler)
 Unregister from event that's called when the UserDefinedTargetBehaviour has been initialized More...
 
bool UnregisterOnNewTrackableSourceEventHandler (Action< TrackableSource > handler)
 Unregister from event that's called when a new trackable source is available More...
 

Public Attributes

bool StartScanningAutomatically = false
 if this is set to true, scanning will start automatically when this component is activated More...
 
bool StopScanningWhenFinshedBuilding = false
 if scanning should be stopped automatically when a new target is built More...
 
bool StopTrackerWhileScanning = false
 if the tracker should be stopped when scanning is started and resumed when scanning is stopped More...
 

Detailed Description

This Component can be used to create new ImageTargets at runtime. It can be configured to start scanning automatically or via a call from an external script. Registered event handlers will be informed of changes in the frame quality as well as new TrackableSources

Member Function Documentation

void BuildNewTarget ( string  targetName,
float  screenSizeWidth 
)

This will start building a new target and report back to the event handlers as soon as a new TrackableSource is available.

void RegisterEventHandler ( IUserDefinedTargetEventHandler  eventHandler)

Registers an event handler with this UserDefinedTargetBuildingBehaviour which will be called on events

void RegisterOnFrameQualityChangedEventHandler ( Action< ImageTargetBuilder.FrameQuality handler)

Register for event that's called when the UserDefinedTargetBehaviour reports a new frame Quality

void RegisterOnInitializedEventHandler ( Action  handler)

Register for event that's called when the UserDefinedTargetBehaviour has been initialized

void RegisterOnNewTrackableSourceEventHandler ( Action< TrackableSource handler)

Register for event that's called when a new trackable source is available

void StartScanning ( )

Starts scanning the current camera image for features. This will trigger callbacks to the registered event handlers whenever the frame quality changes. If 'StopTrackerWhileScanning' is set, this will stop the ObjectTracker

void StopScanning ( )

Stops scanning, event handlers will be informed. If 'StopTrackerWhileScanning' is set, this will resume the ObjectTracker

bool UnregisterEventHandler ( IUserDefinedTargetEventHandler  eventHandler)

Unregisters an event handler

bool UnregisterOnFrameQualityChangedEventHandler ( Action< ImageTargetBuilder.FrameQuality handler)

Unregister from event that's called when the UserDefinedTargetBehaviour reports a new frame Quality

bool UnregisterOnInitializedEventHandler ( Action  handler)

Unregister from event that's called when the UserDefinedTargetBehaviour has been initialized

bool UnregisterOnNewTrackableSourceEventHandler ( Action< TrackableSource handler)

Unregister from event that's called when a new trackable source is available

Member Data Documentation

bool StartScanningAutomatically = false

if this is set to true, scanning will start automatically when this component is activated

bool StopScanningWhenFinshedBuilding = false

if scanning should be stopped automatically when a new target is built

bool StopTrackerWhileScanning = false

if the tracker should be stopped when scanning is started and resumed when scanning is stopped