TrackerBaseBehaviour Class

Description

TrackerBaseBehaviour (until 1.2.1) is the component to control ImageTracker in the AR scene.

A ImageTargetBaseBehaviour must be loaded into TrackerBaseBehaviour before its target can be tracked.

Public Fields

ImageTrackerTracker

Public Properties

List<ImageTargetBaseBehaviour>LoadedTargetBehaviours

Public Functions

voidBind(AugmenterBaseBehaviour behaviour)
voidUnBind(AugmenterBaseBehaviour behaviour)
voidBind(CameraDeviceBaseBehaviour behaviour)
voidUnBind(CameraDeviceBaseBehaviour behaviour)
voidLoadImageTargetBehaviour(ImageTargetBaseBehaviour imageTargetBaseBehaviour)
voidUnloadImageTargetBehaviour(ImageTargetBaseBehaviour imageTargetBaseBehaviour)
voidRegisterAREventHandler(IAREventHandler handler)
voidUnregisterAREventHandler(IAREventHandler handler)
voidRegisterTargetEventHandler(ITargetEventHandler targetEventHandler)
voidUnregisterTargetEventHandler(ITargetEventHandler targetEventHandler)
boolStartTrack()
boolStopTrack()

Public Events

event Action<TrackerBaseBehaviour, CameraDeviceBaseBehaviour>ARStart
event Action<TrackerBaseBehaviour>ARStop

Overwritten MonoBahaviour Functions

protected virtual voidOnApplicationPause(bool pause)
protected virtual voidOnApplicationQuit()
protected virtual voidOnDestroy()
protected virtual voidStart()
protected virtual voidUpdate()

ImageTracker Tracker

The ImageTracker object. You can reach advanced controls with Tracker. See ImageTracker for more details.

List<ImageTargetBaseBehaviour> LoadedTargetBehaviours

The ImageTargetBaseBehaviours currently loaded into the component.

void Bind(AugmenterBaseBehaviour behaviour)

Binds AugmenterBaseBehaviour. It is used for building AR scene. TrackerBaseBehaviour must be bind to a AugmenterBaseBehaviour before all functions work.

void UnBind(AugmenterBaseBehaviour behaviour)

Unbind AugmenterBaseBehaviour.

void Bind(CameraDeviceBaseBehaviour behaviour)

Binds CameraDeviceBaseBehaviour. It is used for building AR scene. TrackerBaseBehaviour must be bind to a CameraDeviceBaseBehaviour before all functions work.

void UnBind(CameraDeviceBaseBehaviour behaviour)

Unbind CameraDeviceBaseBehaviour.

void LoadImageTargetBehaviour(ImageTargetBaseBehaviour imageTargetBaseBehaviour)

Load the ImageTargetBaseBehaviour and its target into the component. It is same with ImageTargetBaseBehaviour.LoadIntoTrackerBehaviour

void UnloadImageTargetBehaviour(ImageTargetBaseBehaviour imageTargetBaseBehaviour)

Unload the ImageTargetBaseBehaviour and its target from the component.

void RegisterAREventHandler(IAREventHandler handler)

Register an IAREventHandler. See IAREventHandler for more details.

void UnregisterAREventHandler(IAREventHandler handler)

Unregister the IAREventHandler .

void RegisterTargetEventHandler(ITargetEventHandler targetEventHandler)

Register an ITargetEventHandler. See ITargetEventHandler for more details.

An ImageTargetBaseBehaviour which implenments ITargetEventHandler do not need to register, it will be registered automatically.

void UnregisterTargetEventHandler(ITargetEventHandler targetEventHandler)

Unregister the ITargetEventHandler.

bool StartTrack()

Starts the track. See ImageTracker.Start for more details.

bool StopTrack()

Stops the track. See ImageTracker.Stop for more details.

event Action<TrackerBaseBehaviour, CameraDeviceBaseBehaviour> ARStart

The event for AR start. It will be triggered at a successful AR chain bootup or when IAREventHandler registers after the successful bootup.

event Action<TrackerBaseBehaviour> ARStop

The event for AR stop. It will be triggered when the component destroys or when IAREventHandler unregisters.