Tracker Event API module

Reference
- Classes
- Enums
- Typedefs
- Functions

These functions add and remove event handlers for a specific tracker target and type of event.

Classes

struct ZCTrackerEventData: The tracker event data type.

Enums

enum ZCTrackerEventType { ZC_TRACKER_EVENT_MOVE = 0x0101, ZC_TRACKER_EVENT_BUTTON_PRESS = 0x0201, ZC_TRACKER_EVENT_BUTTON_RELEASE = 0x0202, ZC_TRACKER_EVENT_TAP_PRESS = 0x0301, ZC_TRACKER_EVENT_TAP_RELEASE = 0x0302, ZC_TRACKER_EVENT_TAP_HOLD = 0x0303, ZC_TRACKER_EVENT_TAP_SINGLE = 0x0304, ZC_TRACKER_EVENT_TAP_DOUBLE = 0x0305, ZC_TRACKER_EVENT_ALL = 0xFFFF }

Typedefs

using ZCTrackerEventType = enum ZCTrackerEventType
using ZCTrackerEventData = struct ZCTrackerEventData: The tracker event data type.
using ZCTrackerEventHandler = void(*)(ZCHandle targetHandle, const ZCTrackerEventData*eventData, const void*userData)

Functions

auto zcAddTrackerEventHandler(ZCHandle targetHandle, ZCTrackerEventType trackerEventType, ZCTrackerEventHandler trackerEventHandler, const void* userData) -> ZCError
auto zcRemoveTrackerEventHandler(ZCHandle targetHandle, ZCTrackerEventType trackerEventType, ZCTrackerEventHandler trackerEventHandler, const void* userData) -> ZCError

Enum documentation

enum ZCTrackerEventType

Defines event types that you can use with a tracker event handler.

Enumerators
ZC_TRACKER_EVENT_MOVE
ZC_TRACKER_EVENT_BUTTON_PRESS
ZC_TRACKER_EVENT_BUTTON_RELEASE
ZC_TRACKER_EVENT_TAP_PRESS
ZC_TRACKER_EVENT_TAP_RELEASE
ZC_TRACKER_EVENT_TAP_HOLD
ZC_TRACKER_EVENT_TAP_SINGLE
ZC_TRACKER_EVENT_TAP_DOUBLE
ZC_TRACKER_EVENT_ALL

Typedef documentation

typedef enum ZCTrackerEventType ZCTrackerEventType

Defines event types that you can use with a tracker event handler.

typedef void(ZCTrackerEventHandler)(ZCHandle targetHandle, const ZCTrackerEventDataeventData, const void*userData)

Handler for tracker events.

Function documentation

ZCError zcAddTrackerEventHandler(ZCHandle targetHandle, ZCTrackerEventType trackerEventType, ZCTrackerEventHandler trackerEventHandler, const void* userData)

Parameters
targetHandle in	A handle to the tracker target.
trackerEventType in	The event type with which the handler is being registered.
trackerEventHandler in	The user defined event handler that adheres to the ZCTrackerEventHandler signature.
userData in	A reference to custom user data that will be passed along to the event handler.

Adds an event handler for the specified tracker target and event type. Event handlers are invoked asynchronously on a background thread managed by the zSpace SDK. Refer to ZCTrackerEventType for the available types of tracker events.

Example:

// Custom button press handler
void handleButtonPress(ZCHandle targetHandle, 
                       const ZCTrackerEventData* eventData, 
                       const void* userData)
{
  if (eventData->type == ZC_TRACKER_EVENT_BUTTON_PRESS)
  {
    printf("Button %d: Pressed (%f, %f, %f)\n", 
            eventData->buttonId, 
            eventData->poseMatrix.m03, 
            eventData->poseMatrix.m13, 
            eventData->poseMatrix.m23);
  }
}

int main()
{
  // zSpace initialization code goes here.
  // Assume the ZCContext has been properly initialized by zcInitialize().
  ZCContext context = ...;

  // Get the stylus target
  ZCHandle stylusHandle = NULL;
  zcGetTargetByType(context, ZC_TARGET_TYPE_PRIMARY, 0, &stylusHandle);

  // Register button event handler.
  zcAddTrackerEventHandler(stylusHandle, 
                           ZC_TRACKER_EVENT_BUTTON_PRESS, 
                           &handleButtonPress, 
                           0);

  // zSpace shutdown code goes here.
  return 0;
}

ZCError zcRemoveTrackerEventHandler(ZCHandle targetHandle, ZCTrackerEventType trackerEventType, ZCTrackerEventHandler trackerEventHandler, const void* userData)

Parameters
targetHandle in	A handle to the tracker target.
trackerEventType in	The event type with which the handler is being deregistered.
trackerEventHandler in	The handler to be removed.
userData in	A reference to the custom user data associated with the event handler.

Removes a tracker event handler. Both the event handler and event type must match for the handler to be deregistered.