All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Modules Pages
Loading...
Searching...
No Matches
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:
ScalableDataSetTrackableBehaviour DataSetTrackableBehaviour ObserverBehaviour VuforiaMonoBehaviour

Public Types

enum  GuideViewDisplayMode {
  NoGuideView ,
  GuideView2D ,
  GuideView3D
}
 The guide view display modes. More...
 

Public Member Functions

int GetActiveGuideViewIndex ()
 Return the active Guide View index.
 
string GetActiveStateName ()
 Get the active state name.
 
IEnumerable< string > GetAvailableStateNames ()
 Get a collection of all available state names.
 
Bounds GetBoundingBox ()
 Return the bounding box of the target (in 3D scene units).
 
GuideView GetGuideView (int guideViewIndex)
 Return a Guide View with a given index.
 
int GetNumGuideViews ()
 The number of guide views for the model target.
 
Vector3 GetSize ()
 Return the size of this target in scene units.
 
TrackingOptimization GetTrackingOptimization ()
 Get the tracking optimization.
 
void Reset ()
 Reset tracking of this Model Target observer This will stop any ongoing tracking of this Model Target including extended tracking. The tracking will automatically restart if the target is recognized again. Only an activated target can be reset.
 
bool SetActiveGuideViewIndex (int index)
 Set the index for an active GuideView for this ModelTarget.
 
bool SetActiveGuideViewName (string guideViewName)
 Activates a guide view by name.
 
bool SetActiveStateName (string stateName)
 Set the active state name.
 
void SetBoundingBox (Vector3 minBBox, Vector3 maxBBox)
 Set the Bounding Box (only in editor mode).
 
void SetHeight (float height)
 Set the height (z-dimension) of the target in scene units. This will scale the target uniformly.
 
void SetLength (float length)
 Set the length (x-dimension) of the target in scene units. This will scale the target uniformly.
 
bool SetTrackingOptimization (TrackingOptimization mode)
 Set tracking optimization.
 
void SetWidth (float width)
 Set the width (y-dimension) of the target in scene units. This will scale the target uniformly.
 

Public Attributes

Texture2D m2DGuideViewImage
 2D guide view image
 
Material m2DGuideViewMaterial
 2D guide view material
 
Material m3DGuideViewMaterial
 3D guide view material
 
GameObject m3DGuideViewModel
 3D guide view GameObject
 

Properties

Material[] GuideView2DMaterials [get, set]
 2D guide view materials
 
Material[] GuideView3DMaterials [get, set]
 3D guide view materials
 
GuideViewDisplayMode GuideViewMode [get, set]
 Get or set the GuideViewDisplayMode.
 
TrackingOptimization TrackingOptimization [get, set]
 Tracking optimization setting.
 
- Properties inherited from ObserverBehaviour
int? ID [get]
 The runtime Id of the Observer.
 
string TargetName [get]
 Name of the target of the Observer.
 
TargetStatus TargetStatus = TargetStatus.NotObserved [get]
 Current status information of the target.
 

Additional Inherited Members

- Events inherited from ObserverBehaviour
Action< ObserverBehaviourOnBehaviourDestroyed
 Triggered when this behaviour is destroyed. Can be used for script cleanup.
 
Action< ObserverBehaviour, TargetStatusOnTargetStatusChanged
 Triggered when the TargetStatus changes.
 

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

◆ GuideViewDisplayMode

The guide view display modes.

Enumerator
NoGuideView 

No guide view rendering (in case there is custom application logic to display some form of snapping view)

GuideView2D 

2D guide view using the integrated or overwritten texture

GuideView3D 

3D guide view using the integrated or overwritten 3D model

Member Function Documentation

◆ GetActiveGuideViewIndex()

int GetActiveGuideViewIndex ( )
inline

Return the active Guide View index.

◆ GetActiveStateName()

string GetActiveStateName ( )
inline

Get the active state name.

◆ GetAvailableStateNames()

IEnumerable< string > GetAvailableStateNames ( )
inline

Get a collection of all available state names.

◆ GetBoundingBox()

Bounds GetBoundingBox ( )
inline

Return the bounding box of the target (in 3D scene units).

◆ GetGuideView()

GuideView GetGuideView ( int guideViewIndex)
inline

Return a Guide View with a given index.

◆ GetNumGuideViews()

int GetNumGuideViews ( )
inline

The number of guide views for the model target.

◆ GetSize()

Vector3 GetSize ( )
inline

Return the size of this target in scene units.

◆ GetTrackingOptimization()

TrackingOptimization GetTrackingOptimization ( )
inline

Get the tracking optimization.

◆ Reset()

void Reset ( )
inline

Reset tracking of this Model Target observer This will stop any ongoing tracking of this Model Target including extended tracking. The tracking will automatically restart if the target is recognized again. Only an activated target can be reset.

◆ SetActiveGuideViewIndex()

bool SetActiveGuideViewIndex ( int index)
inline

Set the index for an active GuideView for this ModelTarget.

◆ SetActiveGuideViewName()

bool SetActiveGuideViewName ( string guideViewName)
inline

Activates a guide view by name.

Parameters
guideViewNameThe name of the guide view to be activated
Returns

◆ SetActiveStateName()

bool SetActiveStateName ( string stateName)
inline

Set the active state name.

◆ SetBoundingBox()

void SetBoundingBox ( Vector3 minBBox,
Vector3 maxBBox )
inline

Set the Bounding Box (only in editor mode).

Parameters
minBBoxbounding box min position
maxBBoxbounding box max position

◆ SetHeight()

void SetHeight ( float height)
inline

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

Parameters
heightheight value

◆ SetLength()

void SetLength ( float length)
inline

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

Parameters
lengthlength value

◆ SetTrackingOptimization()

bool SetTrackingOptimization ( TrackingOptimization mode)
inline

Set tracking optimization.

◆ SetWidth()

void SetWidth ( float width)
inline

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

Parameters
widthwidth value

Member Data Documentation

◆ m2DGuideViewImage

Texture2D m2DGuideViewImage

2D guide view image

◆ m2DGuideViewMaterial

Material m2DGuideViewMaterial

2D guide view material

◆ m3DGuideViewMaterial

Material m3DGuideViewMaterial

3D guide view material

◆ m3DGuideViewModel

GameObject m3DGuideViewModel

3D guide view GameObject

Property Documentation

◆ GuideView2DMaterials

Material [] GuideView2DMaterials
getset

2D guide view materials

◆ GuideView3DMaterials

Material [] GuideView3DMaterials
getset

3D guide view materials

◆ GuideViewMode

GuideViewDisplayMode GuideViewMode
getset

Get or set the GuideViewDisplayMode.

◆ TrackingOptimization

Tracking optimization setting.