Coordinate Space API module

Reference
- Enums
- Typedefs
- Functions

Use these functions for operations that require coordinate space transformations.

Enums

enum ZCCoordinateSpace { ZC_COORDINATE_SPACE_TRACKER = 0, ZC_COORDINATE_SPACE_DISPLAY = 1, ZC_COORDINATE_SPACE_VIEWPORT = 2, ZC_COORDINATE_SPACE_CAMERA = 3 }

Typedefs

using ZCCoordinateSpace = enum ZCCoordinateSpace

Functions

auto zcGetCoordinateSpaceTransform(ZCHandle viewportHandle, ZCCoordinateSpace a, ZCCoordinateSpace b, ZSMatrix4* transform) -> ZCError
auto zcTransformMatrix(ZCHandle viewportHandle, ZCCoordinateSpace a, ZCCoordinateSpace b, ZSMatrix4* matrix) -> ZCError

Enum documentation

enum ZCCoordinateSpace

Defines the coordinate spaces used by the zSpace Core SDK. This enum is used by both the Coordinate Space API and the Stereo Frustum API.

Enumerators
ZC_COORDINATE_SPACE_TRACKER
ZC_COORDINATE_SPACE_DISPLAY
ZC_COORDINATE_SPACE_VIEWPORT
ZC_COORDINATE_SPACE_CAMERA

Typedef documentation

typedef enum ZCCoordinateSpace ZCCoordinateSpace

Defines the coordinate spaces used by the zSpace Core SDK. This enum is used by both the Coordinate Space API and the Stereo Frustum API.

Function documentation

ZCError zcGetCoordinateSpaceTransform(ZCHandle viewportHandle, ZCCoordinateSpace a, ZCCoordinateSpace b, ZSMatrix4* transform)

Parameters
viewportHandle in	A handle to the viewport.
a in	The source coordinate space.
b in	The destination coordinate space.
transform out	The transformation matrix in order to transform from space a to b.

Gets the coordinate space transformation from space a to b.

ZCError zcTransformMatrix(ZCHandle viewportHandle, ZCCoordinateSpace a, ZCCoordinateSpace b, ZSMatrix4* matrix)

Parameters
viewportHandle in	A handle to the viewport.
a in	The source coordinate space.
b in	The destination coordinate space.
matrix in/out	The input matrix to be transformed.

Transforms a 4x4 transformation matrix from space a to b.

Example:

// For this example, assume stylusHandle and viewportHandle 
// have been properly initialized.
ZCHandle stylusHandle;
ZCHandle viewportHandle;

// Get the stylus tracker-space pose.
ZCTrackerPose stylusPose;
zcGetTargetPose(stylusHandle, &stylusPose);

// Transform the stylus pose matrix from tracker-space to camera-space.
zcTransformMatrix(viewportHandle, 
                  ZC_COORDINATE_SPACE_TRACKER, 
                  ZC_COORDINATE_SPACE_CAMERA, 
                  &stylusPose.matrix);