VuMarkBehaviour Class Reference

This class serves both as an augmentation definition for a VuMark in the editor as well as a tracked VuMark result at runtime More...

Inheritance diagram for VuMarkBehaviour:

Public Member Functions
void	CleanUntrackedBehavioursCache ()
	Clean the cache of previously seen VuMark instances that are not actively tracked now. More...
Vector2	GetSize ()
	Returns the size of this target in scene units More...
TrackingOptimization	GetTrackingOptimization ()
	Get the tracking optimization More...
void	SetHeight (float height)
	Set the height (y-dimension) of the target in scene units. This will scale the target uniformly. The dataset has to be deactivated before changing the size. Make sure to set the same size for all instantiated behaviours of the same VuMark-template More...
bool	SetTrackingOptimization (TrackingOptimization optimization)
	Set the tracking optimization More...
void	SetWidth (float width)
	Set the width (x-dimension) of the target in scene units. This will scale the target uniformly. The dataset has to be deactivated before changing the size. Make sure to set the same size for all instantiated behaviours of the same VuMark-template More...

Properties
VuMarkInstanceId	InstanceId [get]
	The InstanceId contains the id for a particular VuMark. More...
Image	InstanceImage [get]
	Returns the generated image of the detected VuMark. More...
Vector2	Origin [get]
	Returns the size-scaled origin of the VuMark More...
bool	TrackingFromRuntimeAppearance [get, set]
	Sets or gets whether the VuMark has a changing background per instance, signaling to SDK how to track it. More...
string	VuMarkUserData [get]
	Gets the user data associated with this template that comes from the dataset. If there is no VuMark use data associated with this template, an empty string is returned. More...
Properties inherited from ObserverBehaviour
TargetStatus	TargetStatus [get]
	Current status information of the target More...

Additional Inherited Members
Public Attributes inherited from ObserverBehaviour
int	ID => mObserver?.Id
	The runtime Id of the Observer More...
string	TargetName => mTrackableName
	Name of the target of the Observer More...
Events inherited from ObserverBehaviour
Action< ObserverBehaviour >	OnBehaviourDestroyed
	Triggered when this behaviour is destroyed. Can be used for script cleanup More...
Action< ObserverBehaviour, TargetStatus >	OnTargetStatusChanged
	Triggered when the TargetStatus changes More...

Detailed Description

This class serves both as an augmentation definition for a VuMark in the editor as well as a tracked VuMark result at runtime

Member Function Documentation

CleanUntrackedBehavioursCache()

void CleanUntrackedBehavioursCache ( )

inline

Clean the cache of previously seen VuMark instances that are not actively tracked now.

The cache is automatically cleaned whenever Vuforia is paused or when the authored VuMarkBehaviour that is being used as a template for all instances is disabled,

GetSize()

Vector2 GetSize ( )

inline

Returns the size of this target in scene units

GetTrackingOptimization()

TrackingOptimization GetTrackingOptimization ( )

inline

Get the tracking optimization

SetHeight()

void SetHeight ( float  height )

inline

Set the height (y-dimension) of the target in scene units. This will scale the target uniformly. The dataset has to be deactivated before changing the size. Make sure to set the same size for all instantiated behaviours of the same VuMark-template

SetTrackingOptimization()

bool SetTrackingOptimization ( TrackingOptimization  optimization )

inline

Set the tracking optimization

SetWidth()

void SetWidth ( float  width )

inline

Set the width (x-dimension) of the target in scene units. This will scale the target uniformly. The dataset has to be deactivated before changing the size. Make sure to set the same size for all instantiated behaviours of the same VuMark-template

Property Documentation

InstanceId

VuMarkInstanceId InstanceId

get

The InstanceId contains the id for a particular VuMark.

InstanceImage

Image InstanceImage

get

Returns the generated image of the detected VuMark.

Origin

Vector2 Origin

get

Returns the size-scaled origin of the VuMark

TrackingFromRuntimeAppearance

bool TrackingFromRuntimeAppearance

getset

Sets or gets whether the VuMark has a changing background per instance, signaling to SDK how to track it.

Setting TrackingFromRuntimeAppearance to true indicates that the SDK should track this type of VuMark based on what is seen by the camera and not assume the template background image is useful for tracking because the background can change per instance. Setting TrackingFromRuntimeAppearance to false indicates that the SDK should track this type of VuMark based on VuMark Template used to create the dataset. This is the default behavior.

VuMarkUserData

string VuMarkUserData

get

Gets the user data associated with this template that comes from the dataset. If there is no VuMark use data associated with this template, an empty string is returned.