Visometry.VisionLib.SDK.Core.TrackingAnchor Class Reference

The TrackingAnchor represents a tracked Object (anchor). It handles rendered augmentations at runtime, switching between an initial pose guide during initialization and content to be augmented while the anchor in question is tracked. More...

Inherits MonoBehaviour, and Visometry.VisionLib.SDK.Core.Details.ISceneValidationCheck.

Public Member Functions
void	AddWorkSpace (WorkSpace workSpace)
void	Awake ()
void	DeregisterRenderedObject (RenderedObject renderedObject)
void	DisableAnyAugmentationIfNotTracking ()
	Disable any augmentation currently enabled by the AugmentationHandler. In order to not interfere with the augmentation behavior, this is a no-op whenever tracking is running. More...
void	EnableInitPoseGuideIfNotTracking ()
	Enable the AugmentationHandler's InitPoseGuide. In order to not interfere with the augmentation behavior, this is a no-op whenever tracking is running. More...
void	FinalizeLoadingModel (LoadedModelHandle loadedModel)
string	GetAnchorName ()
ModelTransform	GetCurrentInitPoseInWorldCoordinateSystem ()
bool	GetIsInitPoseInBackendInitialized ()
bool	GetKeepUpright ()
ModelTransform	GetLastTrackingPose ()
string []	GetModelHashes ()
Vector3	GetModelUpVector ()
List< RenderedObject >	GetRegisteredRenderedObjects ()
Camera	GetSLAMCamera ()
Vector3	GetWorldUpVector ()
void	RegisterLoadingModel (LoadedModelHandle loadedModel)
void	RegisterRenderedObject (RenderedObject renderedObject)
void	ResetHard ()
	Reset the tracking and all keyframes. More...
async Task	ResetHardAndNotifyAsync ()
void	ResetSoft ()
	Reset the tracking. More...
async Task	ResetSoftAndNotifyAsync ()
void	SetKeepUpright (bool value)
void	SetModelUpVector (Vector3 modelUp)
void	SetSLAMCamera (Camera SLAMCamera)
void	SetTransformAsInitPose ()
	Set the InitPose in the InitPoseHandler to the TrackingAnchor's current transform and immediately send it to the backend. This change will take with approximately a single frame's delay. More...
async Task	SetTransformAsInitPoseAndWriteToBackendAsync ()
void	SetWorldUpVector (Vector3 worldUp)
void	UpdateInitPose ()

Data Fields
UnityEvent	OnTracked = new UnityEvent()
	Event fired once after the tracking state changed to "tracked". More...
UnityEvent	OnTrackingCritical = new UnityEvent()
	Event fired once after the tracking state changed to "critical". More...
UnityEvent	OnTrackingLost = new UnityEvent()
	Event fired once after the tracking state changed to "lost". More...
WorkSpace []	workSpaces = new WorkSpace[] {}
	List of WorkSpaces that are used to initialize the tracking target. More...

Properties
bool	AnchorExists [get]
bool	IsAnchorEnabled [get]
bool	UseInitPose [get, set]

Events
VLSDK.VoidDelegate	OnAnchorAdded
	Event emitted after the anchor has been added to VisionLib. More...
VLSDK.VoidDelegate	OnAnchorRemoved
	Event emitted after the anchor has been removed from VisionLib. More...

Detailed Description

The TrackingAnchor represents a tracked Object (anchor). It handles rendered augmentations at runtime, switching between an initial pose guide during initialization and content to be augmented while the anchor in question is tracked.

Member Function Documentation

DisableAnyAugmentationIfNotTracking()

void Visometry.VisionLib.SDK.Core.TrackingAnchor.DisableAnyAugmentationIfNotTracking ( )

inline

Disable any augmentation currently enabled by the AugmentationHandler. In order to not interfere with the augmentation behavior, this is a no-op whenever tracking is running.

EnableInitPoseGuideIfNotTracking()

void Visometry.VisionLib.SDK.Core.TrackingAnchor.EnableInitPoseGuideIfNotTracking ( )

inline

Enable the AugmentationHandler's InitPoseGuide. In order to not interfere with the augmentation behavior, this is a no-op whenever tracking is running.

ResetHard()

void Visometry.VisionLib.SDK.Core.TrackingAnchor.ResetHard ( )

inline

Reset the tracking and all keyframes.

This function will be performed asynchronously.

ResetSoft()

void Visometry.VisionLib.SDK.Core.TrackingAnchor.ResetSoft ( )

inline

Reset the tracking.

This function will be performed asynchronously.

SetTransformAsInitPose()

void Visometry.VisionLib.SDK.Core.TrackingAnchor.SetTransformAsInitPose ( )

inline

Set the InitPose in the InitPoseHandler to the TrackingAnchor's current transform and immediately send it to the backend. This change will take with approximately a single frame's delay.

Field Documentation

OnTracked

UnityEvent Visometry.VisionLib.SDK.Core.TrackingAnchor.OnTracked = new UnityEvent()

Event fired once after the tracking state changed to "tracked".

OnTrackingCritical

UnityEvent Visometry.VisionLib.SDK.Core.TrackingAnchor.OnTrackingCritical = new UnityEvent()

Event fired once after the tracking state changed to "critical".

OnTrackingLost

UnityEvent Visometry.VisionLib.SDK.Core.TrackingAnchor.OnTrackingLost = new UnityEvent()

Event fired once after the tracking state changed to "lost".

workSpaces

WorkSpace [] Visometry.VisionLib.SDK.Core.TrackingAnchor.workSpaces = new WorkSpace[] {}

List of WorkSpaces that are used to initialize the tracking target.

Event Documentation

OnAnchorAdded

VLSDK.VoidDelegate Visometry.VisionLib.SDK.Core.TrackingAnchor.OnAnchorAdded

Event emitted after the anchor has been added to VisionLib.

OnAnchorRemoved

VLSDK.VoidDelegate Visometry.VisionLib.SDK.Core.TrackingAnchor.OnAnchorRemoved

Event emitted after the anchor has been removed from VisionLib.