ModelTargetBehaviour Class Reference

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

Inheritance diagram for ModelTargetBehaviour:

Public Types
enum	GuideViewDisplayMode {   NoGuideView,   GuideView2D,   GuideView3D }
	The different modes how Vuforia will provide guide view rendering: More...
Public Types inherited from TrackableBehaviour
enum	Status {   NO_POSE = 0,   LIMITED = 1,   DETECTED = 2,   TRACKED = 3,   EXTENDED_TRACKED = 4 }
	The tracking status of the TrackableBehaviour. More...
enum	StatusInfo {   NORMAL = 0,   UNKNOWN = 1,   INITIALIZING = 2,   RELOCALIZING = 3,   EXCESSIVE_MOTION = 4,   INSUFFICIENT_FEATURES = 5,   INSUFFICIENT_LIGHT = 6,   NO_DETECTION_RECOMMENDING_GUIDANCE = 7,   WRONG_SCALE = 8 }
	Information on the tracking status. Gives the primary reason about the problem with tracking (STATUS::NO_POSE or STATUS::LIMITED). More...

Public Member Functions
Vector3	GetSize ()
	Returns the size of this target in scene units More...
void	SetBoundingBox (Vector3 minBBox, Vector3 maxBBox)
	Set the Bounding Box (only in editor mode). More...
void	SetHeight (float height)
	Set the height (z-dimension) of the target in scene units. This will scale the target uniformly. More...
void	SetLength (float length)
	Set the length (x-dimension) of the target in scene units. This will scale the target uniformly. More...
void	SetWidth (float width)
	Set the width (y-dimension) of the target in scene units. This will scale the target uniformly. More...
Public Member Functions inherited from TrackableBehaviour
virtual void	OnFrameIndexUpdate (int newFrameIndex)
	Is triggered by the StateManager after each render frame More...
virtual void	OnTrackerUpdate (Status newStatus, StatusInfo newStatusInfo)
	Is triggered by the TrackerBehavior after it has updated. More...
void	RegisterOnTrackableStatusChanged (Action< StatusChangeResult > onTrackableStatusChangedAction)
	Subscribe a method to be called when the Status of the TrackableBehaviour changes. Parameters onTrackableStatusChangedAction Action to be registered. More...
void	RegisterOnTrackableStatusInfoChanged (Action< StatusInfoChangeResult > onTrackableStatusChangedAction)
	Subscribe a method to be called when the StatusInfo of the TrackableBehaviour changes. More...
bool	UnregisterOnTrackableStatusChanged (Action< StatusChangeResult > onTrackableStatusChangedAction)
	Unsubscribe a method from being called when the Status of the TrackableBehaviour changes More...
void	UnregisterOnTrackableStatusInfoChanged (Action< StatusInfoChangeResult > onTrackableStatusChangedAction)
	Unsubscribe a method from being called when the StatusInfo of the TrackableBehaviour changes More...

Public Attributes
Texture2D	m2DGuideViewImage = null
Material	m2DGuideViewMaterial
Material	m3DGuideViewMaterial
GameObject	m3DGuideViewModel = null

Properties
GuideViewDisplayMode	GuideViewMode [get, set]
ModelTarget	ModelTarget [get]
	The ModelTarget that this ModelTargetBehaviour augments More...
Properties inherited from TrackableBehaviour
Status	CurrentStatus [get]
	The tracking status of the TrackableBehaviour More...
StatusInfo	CurrentStatusInfo [get]
	Information on the tracking status. Gives the primary reason about the problem with tracking (STATUS::NO_POSE or STATUS::LIMITED). More...
virtual Trackable	Trackable [get]
	The Trackable created at runtime that is augmented by this TrackableBehaviour More...
string	TrackableName [get]
	The name of the Trackable. More...
Properties inherited from WorldCenterTrackableBehaviour
Trackable	Trackable [get]
	The Trackable created at runtime that is augmented by this TrackableBehaviour More...

Detailed Description

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

Member Enumeration Documentation

enum GuideViewDisplayMode

strong

The different modes how Vuforia will provide guide view rendering:

• No guide view rendering (in case there is custom application logic to display some form of snapping view)
• 2D guide view using the integrated or overwritten texture
• 3D guide view using the integrated or overwritten 3D model

Enumerator
NoGuideView	Using camel-case for enum here, so that Unity automatically creates nice strings for in editor display e.g. "NoGuideView" becomes "No Guide View"
GuideView2D
GuideView3D

Member Function Documentation

Vector3 GetSize

(

)

Returns the size of this target in scene units

void SetBoundingBox	(	Vector3	minBBox,
		Vector3	maxBBox
	)

Set the Bounding Box (only in editor mode).

Parameters

minBBox	bounding box min position
maxBBox	bounding box max position

void SetHeight

(

float

height

)

Set the height (z-dimension) of the target in scene units. This will scale the target uniformly.

Parameters

height

height value

void SetLength

(

float

length

)

Set the length (x-dimension) of the target in scene units. This will scale the target uniformly.

Parameters

length

length value

void SetWidth

(

float

width

)

Set the width (y-dimension) of the target in scene units. This will scale the target uniformly.

Parameters

width

width value

Member Data Documentation

Texture2D m2DGuideViewImage = null

Material m2DGuideViewMaterial

Material m3DGuideViewMaterial

GameObject m3DGuideViewModel = null

Property Documentation

GuideViewDisplayMode GuideViewMode

getset

ModelTarget ModelTarget

get

The ModelTarget that this ModelTargetBehaviour augments