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:

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

Properties
bool	RequiresExternalPositions [get]
	Return whether the target requires external positions for initial detection.
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< ObserverBehaviour >	OnBehaviourDestroyed
	Triggered when this behaviour is destroyed. Can be used for script cleanup.
Action< ObserverBehaviour, TargetStatus >	OnTargetStatusChanged
	Triggered when the TargetStatus changes.

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

position	Position 2D (x, z) in target coordinate system (which is y-up).
horizontalAccuracy	Horizontal 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

position	Position 3D (x, y, z) in target coordinate system (which is y-up).
horizontalAccuracy	Horizontal accuracy (radial) of the position in meters. Must be positive.
verticalAccuracy	Vertical accuracy of the position in meters. Must be positive.

Returns

true on success, false on failure.

Property Documentation

RequiresExternalPositions

bool RequiresExternalPositions

get

Return whether the target requires external positions for initial detection.