Mouse Emulation

Detailed Description

Use these functions to enable any tracker target to emulate a mouse.

List of Functions

void  ZSCore::SetMouseEmulationEnabled (bool isMouseEmulationEnabled)
  Set whether mouse emulation is enabled.
bool  ZSCore::IsMouseEmulationEnabled ()
  Check whether mouse emulation is enabled.
void  ZSCore::SetMouseEmulationTarget (TrackerTargetType trackerTargetType)
  Specify the tracker target that will emulate the mouse.
void  ZSCore::SetMouseEmulationMovementMode (MouseMovementMode movementMode)
  Set the movement mode for mouse emulation.
MouseMovementMode  ZSCore::GetMouseEmulationMovementMode ()
  Get the movement mode of mouse emulation. Refer to MouseMovementMode for details.
void  ZSCore::SetMouseEmulationDistance (float mouseEmulationDistance)
  Set the distance at which mouse emulation will be enabled.
float  ZSCore::GetMouseEmulationDistance ()
  Get the distance at which mouse emulation will be enabled.
void  ZSCore::SetMouseEmulationButtonMapping (int buttonId, MouseButton mouseButton)
  Map a specified tracker target button to a mouse button.
MouseButton  ZSCore::GetMouseEmulationButtonMapping (int buttonId)
  Get the mouse button that the specified button ID is mapped to.

List of Enumerations

enum   ZSCore::MouseMovementMode {
  ZSCore::Absolute = 0,
  ZSCore::Relative = 1
}
enum   ZSCore::MouseButton {
  ZSCore::Unknown = -1,
  ZSCore::Left = 0,
  ZSCore::Right = 1,
  ZSCore::Center = 2
}

List of Variables

bool  ZSCore::EnableMouseEmulation = false

Function Descriptions

MouseButton ZSCore:: GetMouseEmulationButtonMapping ( int  buttonId ) [inline]

Get the mouse button that the specified button ID is mapped to.

Parameters:
buttonId Tracker target button ID.
Returns:
Mouse button.
float ZSCore:: GetMouseEmulationDistance ( ) [inline]

Get the distance at which mouse emulation will be enabled.

Returns:
The mouse emulation distance.
MouseMovementMode ZSCore:: GetMouseEmulationMovementMode ( ) [inline]

Get the movement mode of mouse emulation. Refer to MouseMovementMode for details.

Returns:
The current movement mode.
bool ZSCore:: IsMouseEmulationEnabled ( ) [inline]

Check whether mouse emulation is enabled.

Returns:
True if mouse emulation is enabled. False if not.
void ZSCore:: SetMouseEmulationButtonMapping ( int  buttonId,
MouseButton  mouseButton 
) [inline]

Map a specified tracker target button to a mouse button.

Parameters:
buttonId Tracker target button ID.
mouseButton Mouse button.
void ZSCore:: SetMouseEmulationDistance ( float  mouseEmulationDistance ) [inline]

Set the distance at which mouse emulation will be enabled.

Parameters:
mouseEmulationDistance The mouse emulation distance.
void ZSCore:: SetMouseEmulationEnabled ( bool  isMouseEmulationEnabled ) [inline]

Set whether mouse emulation is enabled.

Parameters:
isMouseEmulationEnabled True to enable mouse emulation. False if not.
void ZSCore:: SetMouseEmulationMovementMode ( MouseMovementMode  movementMode ) [inline]

Set the movement mode for mouse emulation.

Parameters:
movementMode Movement is either absolute or relative to the mouse's current position.
void ZSCore:: SetMouseEmulationTarget ( TrackerTargetType  trackerTargetType ) [inline]

Specify the tracker target that will emulate the mouse.

Parameters:
trackerTargetType The type of tracker target.

Enumeration Descriptions

enum ZSCore::MouseButton

Defines mouse buttons to be used when mapping a tracker target's buttons to a mouse.

Enumerator:
Unknown 
Left 
Right 
Center 
enum ZSCore::MouseMovementMode

Determines how the stylus and mouse control the cursor when both are used.

Enumerator:
Absolute 

The stylus uses absolute positions. In this mode, the mouse and stylus can fight for control of the cursor if both are in use. This is the default mode.

Relative 

The stylus applies delta positions to the mouse cursor's current position. Movements by the mouse and stylus are compounded without fighting.

Variable Descriptions

bool ZSCore::EnableMouseEmulation = false

Whether mouse emulation is enabled.