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

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

Inheritance diagram for AreaTargetBehaviour:
DataSetTrackableBehaviour ObserverBehaviour VuforiaMonoBehaviour

Public Member Functions

Bounds GetBoundingBox ()
 Returns the bounding box of the target (in 3D scene units). More...
 
Vector3 GetSize ()
 Get the size (width, height, length) of the Area Target. More...
 
bool SetExternal2DPosition (Vector2 position, float horizontalAccuracy)
 Set approximate 2D position within the target from an external localization source. More...
 
bool SetExternal3DPosition (Vector3 position, float horizontalAccuracy, float verticalAccuracy)
 Set approximate 3D position within the target from an external localization source. More...
 

Public Attributes

bool RequiresExternalPositions => mRequiresExternalPositions
 Return whether the target requires external positions for initial detection More...
 
- 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...
 

Additional Inherited Members

- Properties inherited from ObserverBehaviour
TargetStatus TargetStatus [get]
 Current status information of the target 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 an AreaTarget in the editor as well as a tracked AreaTarget result at runtime

Member Function Documentation

◆ GetBoundingBox()

Bounds GetBoundingBox ( )
inline

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

◆ GetSize()

Vector3 GetSize ( )
inline

Get the size (width, height, length) of the Area Target.

◆ SetExternal2DPosition()

bool SetExternal2DPosition ( Vector2  position,
float  horizontalAccuracy 
)
inline

Set approximate 2D position within the target from an external localization source.

Parameters
positionPosition 2D (x, z) in target coordinate system (which is y-up).
horizontalAccuracyHorizontal accuracy (radial) of the position in meters. Must be positive.
Returns
true on success, false on failure.

◆ SetExternal3DPosition()

bool SetExternal3DPosition ( Vector3  position,
float  horizontalAccuracy,
float  verticalAccuracy 
)
inline

Set approximate 3D position within the target from an external localization source.

Parameters
positionPosition 3D (x, y, z) in target coordinate system (which is y-up).
horizontalAccuracyHorizontal accuracy (radial) of the position in meters. Must be positive.
verticalAccuracyVertical accuracy of the position in meters. Must be positive.
Returns
true on success, false on failure.

Member Data Documentation

◆ RequiresExternalPositions

bool RequiresExternalPositions => mRequiresExternalPositions

Return whether the target requires external positions for initial detection