Tracker Target

Detailed Description

Upon initialization, ZSCore creates instances of the tracker target and registers them to the tracker device. The zSpace display's built-in tracking cameras are an example of a tracker device. The zSpace stylus and polarized glasses are the default tracker targets. Other peripheral devices, such as mice, can also be tracker targets.

List of Functions

void  ZSCore::SetTrackerTargetEnabled (TrackerTargetType trackerTargetType, bool isEnabled)
  Set whether a specified tracker target is enabled.
bool  ZSCore::IsTrackerTargetEnabled (TrackerTargetType trackerTargetType)
  Check whether a specified tracker target is enabled.
bool  ZSCore::IsTrackerTargetVisible (TrackerTargetType trackerTargetType)
  Check whether a specified tracker target is visible.
Matrix4x4  ZSCore::GetTrackerTargetPose (TrackerTargetType trackerTargetType)
  Get the tracker space pose of a specified default tracker target.
Matrix4x4  ZSCore::GetTrackerTargetCameraPose (TrackerTargetType trackerTargetType)
  Get the camera space pose of a specified default tracker target.
Matrix4x4  ZSCore::GetTrackerTargetWorldPose (TrackerTargetType trackerTargetType)
  Get the world space pose of a specified default tracker target. This forces a recalculation based on the current camera's local to world matrix.
Matrix4x4  ZSCore::GetCachedTrackerTargetWorldPose (TrackerTargetType trackerTargetType)
  Get the cached world space pose of a specified default tracker target.
void  ZSCore::SetTrackerTargetPoseBufferingEnabled (TrackerTargetType trackerTargetType, bool isPoseBufferingEnabled)
  Set whether pose buffering is enabled for a specified tracker target.
bool  ZSCore::IsTrackerTargetPoseBufferingEnabled (TrackerTargetType trackerTargetType)
  Check whether pose buffering is enabled for a specified tracker target.
Matrix4x4  ZSCore::GetTrackerTargetBufferedPose (TrackerTargetType trackerTargetType, float lookBackTime)
  Get the tracker space buffered pose of a specified default tracker target.
Matrix4x4  ZSCore::GetTrackerTargetBufferedCameraPose (TrackerTargetType trackerTargetType, float lookBackTime)
  Get the camera space buffered pose of a specified default tracker target.
Matrix4x4  ZSCore::GetTrackerTargetBufferedWorldPose (TrackerTargetType trackerTargetType, float lookBackTime)
  Get the world space buffered pose of a specified default tracker target.

List of Enumerations

enum   ZSCore::TrackerTargetType {
  ZSCore::Unknown = -1,
  ZSCore::Head = 0,
  ZSCore::Primary = 1,
  ZSCore::Secondary = 2,
  ZSCore::NumTypes
}

Function Descriptions

Matrix4x4 ZSCore:: GetCachedTrackerTargetWorldPose ( TrackerTargetType  trackerTargetType ) [inline]

Get the cached world space pose of a specified default tracker target.

Parameters:
trackerTargetType The type of tracker target.
Returns:
The Matrix4x4 pose in world space.
Matrix4x4 ZSCore:: GetTrackerTargetBufferedCameraPose ( TrackerTargetType  trackerTargetType,
float  lookBackTime 
) [inline]

Get the camera space buffered pose of a specified default tracker target.

Parameters:
trackerTargetType The type of tracker target.
lookBackTime The amount of time in seconds to look back from the current time.
Returns:
The most recent buffered pose in camera space since the lookBackTime.
Matrix4x4 ZSCore:: GetTrackerTargetBufferedPose ( TrackerTargetType  trackerTargetType,
float  lookBackTime 
) [inline]

Get the tracker space buffered pose of a specified default tracker target.

Parameters:
trackerTargetType The type of tracker target.
lookBackTime The amount of time in seconds to look back from the current time.
Returns:
The most recent buffered pose in tracker space since the lookBackTime.
Matrix4x4 ZSCore:: GetTrackerTargetBufferedWorldPose ( TrackerTargetType  trackerTargetType,
float  lookBackTime 
) [inline]

Get the world space buffered pose of a specified default tracker target.

Parameters:
trackerTargetType The type of tracker target.
lookBackTime The amount of time in seconds to look back from the current time.
Returns:
The most recent buffered pose in world space since the lookBackTime.
Matrix4x4 ZSCore:: GetTrackerTargetCameraPose ( TrackerTargetType  trackerTargetType ) [inline]

Get the camera space pose of a specified default tracker target.

Parameters:
trackerTargetType The type of tracker target.
Returns:
The Matrix4x4 pose in camera space.
Matrix4x4 ZSCore:: GetTrackerTargetPose ( TrackerTargetType  trackerTargetType ) [inline]

Get the tracker space pose of a specified default tracker target.

Parameters:
trackerTargetType The type of tracker target.
Returns:
The Matrix4x4 pose in tracker space.
Matrix4x4 ZSCore:: GetTrackerTargetWorldPose ( TrackerTargetType  trackerTargetType ) [inline]

Get the world space pose of a specified default tracker target. This forces a recalculation based on the current camera's local to world matrix.

Parameters:
trackerTargetType The type of tracker target.
Returns:
The Matrix4x4 pose in world space.
bool ZSCore:: IsTrackerTargetEnabled ( TrackerTargetType  trackerTargetType ) [inline]

Check whether a specified tracker target is enabled.

Parameters:
trackerTargetType The type of tracker target.
Returns:
True if the target is enabled. False if not.
bool ZSCore:: IsTrackerTargetPoseBufferingEnabled ( TrackerTargetType  trackerTargetType ) [inline]

Check whether pose buffering is enabled for a specified tracker target.

Parameters:
trackerTargetType The type of tracker target.
Returns:
True if pose buffering is enabled. False if not.
bool ZSCore:: IsTrackerTargetVisible ( TrackerTargetType  trackerTargetType ) [inline]

Check whether a specified tracker target is visible.

Parameters:
trackerTargetType The type of tracker target.
Returns:
True if the target is visible. False if not.
void ZSCore:: SetTrackerTargetEnabled ( TrackerTargetType  trackerTargetType,
bool  isEnabled 
) [inline]

Set whether a specified tracker target is enabled.

Parameters:
trackerTargetType The type of tracker target.
isEnabled True to enable the target. False if not.
void ZSCore:: SetTrackerTargetPoseBufferingEnabled ( TrackerTargetType  trackerTargetType,
bool  isPoseBufferingEnabled 
) [inline]

Set whether pose buffering is enabled for a specified tracker target.

Parameters:
trackerTargetType The type of tracker target.
isPoseBufferingEnabled True to enable pose buffering. False if not.

Enumeration Descriptions

enum ZSCore::TrackerTargetType

Identifies a 6-degree-of-freedom tracker target, such as the zSpace stylus or glasses.

Enumerator:
Unknown 

The tracker target's type is unknown.

Head 

The tracker target corresponding to the user's head.

Primary 

The tracker target corresponding to the user's primary hand.

Secondary 

The tracker target corresponding to the user's secondary hand. (Reserved for future use.)

NumTypes  The number of supported tracker target types.