C++ Java Unity
Unity Reference
ModelTarget Interface Reference

A trackable behaviour to represent a flat natural feature target. More...

Inheritance diagram for ModelTarget:
ObjectTarget Trackable

Public Member Functions

int GetActiveGuideViewIndex ()
 Returns the active GuideView index More...
 
string GetActiveStateName ()
 Returns the active state name More...
 
OrientedBoundingBox3D GetBoundingBox ()
 Returns the bounding box of the target (in 3D scene units). More...
 
GuideView GetGuideView (int index)
 Returns a guide view with a given index More...
 
ModelTargetMotionHint GetMotionHint ()
 Get the motion hint, which can be STATIC with hint == 0 or ADAPTIVE with hint == 1. More...
 
int GetNumGuideViews ()
 Queries native for the number of guide views for the model target More...
 
ModelTargetTrackingMode GetTrackingMode ()
 For more details on the meaning of the value, please see the documentation of setTrackingMode().

Returns
The current tracking mode of this target.
More...
 
bool SetActiveGuideViewIndex (int index)
 Sets the index for an active GuideView for this ModelTarget More...
 
bool SetActiveStateName (string name)
 Sets the active state for this ModelTarget by name More...
 
bool SetMotionHint (ModelTargetMotionHint hint)
 Set the motion hint, which can be STATIC with hint == 0 or ADAPTIVE with hint == 1. More...
 
bool SetTrackingMode (ModelTargetTrackingMode mode)
 This hint modifies the internal Model Target tracking parameters to optimize the tracking quality and robustness for different target types. More...
 
- Public Member Functions inherited from ObjectTarget
float GetLargestSizeComponent ()
 Returns the largets component of the target size. More...
 
Vector3 GetSize ()
 Returns the size of the target (in 3D scene units). More...
 
bool SetSize (Vector3 size)
 Sets the size of the target (in 3D scene units). This is only allowed when the dataset is not active! More...
 

Additional Inherited Members

- Properties inherited from Trackable
int ID [get]
 The runtime Id of the Trackable More...
 
string Name [get]
 The name of the Trackable More...
 

Detailed Description

A trackable behaviour to represent a flat natural feature target.

Member Function Documentation

int GetActiveGuideViewIndex ( )

Returns the active GuideView index

string GetActiveStateName ( )

Returns the active state name

OrientedBoundingBox3D GetBoundingBox ( )

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

GuideView GetGuideView ( int  index)

Returns a guide view with a given index

ModelTargetMotionHint GetMotionHint ( )

Get the motion hint, which can be STATIC with hint == 0 or ADAPTIVE with hint == 1.

int GetNumGuideViews ( )

Queries native for the number of guide views for the model target

ModelTargetTrackingMode GetTrackingMode ( )

For more details on the meaning of the value, please see the documentation of setTrackingMode().

Returns
The current tracking mode of this target.

bool SetActiveGuideViewIndex ( int  index)

Sets the index for an active GuideView for this ModelTarget

bool SetActiveStateName ( string  name)

Sets the active state for this ModelTarget by name

bool SetMotionHint ( ModelTargetMotionHint  hint)

Set the motion hint, which can be STATIC with hint == 0 or ADAPTIVE with hint == 1.

bool SetTrackingMode ( ModelTargetTrackingMode  mode)

This hint modifies the internal Model Target tracking parameters to optimize the tracking quality and robustness for different target types.

Note
Only changes between 'DEFAULT' and 'CAR' are supported.
The DataSet this target belongs to must be deactivated when this function is called.
Parameters
modeThe tracking mode.
Returns
true if the mode was set successfully, or false if the DataSet is active or the operation is not supported.