VirtualButton Class Reference

A virtual button on a trackable More...

Public Types
enum	Sensitivity {   HIGH,   MEDIUM,   LOW }
	The sensitivity of this virtual button. This is a trade off between fast detection and robustness again accidental occlusion. More...

Public Member Functions
bool	SetArea (RectangleData area)
	Defines a new area for the button area in 3D scene units (the coordinate system is local to the ImageTarget). More...
bool	SetEnabled (bool enabled)
	Enables or disables a virtual button More...
bool	SetSensitivity (Sensitivity sensitivity)
	Sets the sensitivity of the virtual button More...

Public Attributes
const Sensitivity	DEFAULT_SENSITIVITY = Sensitivity.LOW
	The standard sensitivity More...

Properties
RectangleData	Area [get]
	Returns the currently set Area More...
bool	Enabled [get]
	Returns true if the virtual button is active (updates while tracking). More...
int	ID [get]
	Returns a unique id for this virtual button. More...
string	Name [get]
	Returns the name of the button More...

Detailed Description

A virtual button on a trackable

Methods to modify a VirtualButton must not be called while the corresponding DataSet is active. The dataset must be deactivated first before reconfiguring a VirtualButton.

Member Enumeration Documentation

enum Sensitivity

strong

The sensitivity of this virtual button. This is a trade off between fast detection and robustness again accidental occlusion.

Enumerator
HIGH	Fast detection.
MEDIUM	Balanced between fast and robust.
LOW	Robust detection.

Member Function Documentation

bool SetArea

(

RectangleData

area

)

Defines a new area for the button area in 3D scene units (the coordinate system is local to the ImageTarget).

This method must not be called while the corresponding DataSet is active or it will return false.

bool SetEnabled

(

bool

enabled

)

Enables or disables a virtual button

This method must not be called while the corresponding DataSet is active or it will return false.

bool SetSensitivity

(

Sensitivity

sensitivity

)

Sets the sensitivity of the virtual button

Sensitivity allows deciding between fast and robust button press measurements. This method must not be called while the corresponding DataSet is active or it will return false.

Member Data Documentation

const Sensitivity DEFAULT_SENSITIVITY = Sensitivity.LOW

The standard sensitivity

Property Documentation

RectangleData Area

get

Returns the currently set Area

bool Enabled

get

Returns true if the virtual button is active (updates while tracking).

int ID

get

Returns a unique id for this virtual button.

string Name

get

Returns the name of the button