C API Unity API
Unity API Reference (Version 10.22.5)
CylinderTargetBehaviour Class Reference

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

Inheritance diagram for CylinderTargetBehaviour:
ScalableDataSetTrackableBehaviour DataSetTrackableBehaviour ObserverBehaviour VuforiaMonoBehaviour

Public Member Functions

TrackingOptimization GetTrackingOptimization ()
 Get the tracking optimization More...
 
bool SetBottomDiameter (float value)
 Set the bottom diameter. Changing this value uniformly scales the target. More...
 
bool SetSideLength (float value)
 Set the side length. Changing this value uniformly scales the target. More...
 
bool SetTopDiameter (float value)
 Set the top diameter. Changing this value uniformly scales the target. More...
 
bool SetTrackingOptimization (TrackingOptimization optimization)
 Set the tracking optimization More...
 

Properties

float BottomDiameter [get]
 Get the bottom diameter More...
 
float SideLength [get]
 Get the side length More...
 
float TopDiameter [get]
 Get the top diameter 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< ObserverBehaviourOnBehaviourDestroyed
 Triggered when this behaviour is destroyed. Can be used for script cleanup More...
 
Action< ObserverBehaviour, TargetStatusOnTargetStatusChanged
 Triggered when the TargetStatus changes More...
 

Detailed Description

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

Member Function Documentation

◆ GetTrackingOptimization()

TrackingOptimization GetTrackingOptimization ( )
inline

Get the tracking optimization

◆ SetBottomDiameter()

bool SetBottomDiameter ( float  value)
inline

Set the bottom diameter. Changing this value uniformly scales the target.

Parameters
valueThe bottom diameter value in meters
Returns
Returns true on success

◆ SetSideLength()

bool SetSideLength ( float  value)
inline

Set the side length. Changing this value uniformly scales the target.

Parameters
valueThe side length value in meters
Returns
Returns true on success

◆ SetTopDiameter()

bool SetTopDiameter ( float  value)
inline

Set the top diameter. Changing this value uniformly scales the target.

Parameters
valueThe top diameter value in meters
Returns
Returns true on success

◆ SetTrackingOptimization()

bool SetTrackingOptimization ( TrackingOptimization  optimization)
inline

Set the tracking optimization

Property Documentation

◆ BottomDiameter

float BottomDiameter
get

Get the bottom diameter

◆ SideLength

float SideLength
get

Get the side length

◆ TopDiameter

float TopDiameter
get

Get the top diameter