GetCartesianTransform

Gets the parameters of the Cartesian transformation that is active between the MCS and PCS. If more than one transformation is active, the resulting Cartesian transformation is given.

Syntax

KsError GetCartesianTransform(
     int Index,
     double* TransX,
     double* TransY,
     double* TransZ,
     double* RotAngle1,
     double* RotAngle2,
     double* RotAngle3
);

Parameters

Index [in]: the index of an axis group. Indexes are zero based. Aliases affect this parameter. You can have up to 32 groups.

TransX [out]: pointer to the X-component of translation vector.

TransY [out]: pointer to the Y-component of translation vector.

TransZ [out]: pointer to the Z-component of translation vector.

RotAngle1 [out]: pointer to the Z-axis rotation angle. Unit: degree.

RotAngle2 [out]: pointer to the Y-axis rotation angle. Unit: degree.

RotAngle3 [out]: pointer to the X-axis rotation angle. Unit: degree.

Return value

If the function succeeds, it returns errNoError, otherwise an error code. For more information about the error code, see the KsError list.

Example

N/A

Requirements

  RT Win32
Minimum supported version 4.1 4.1
Header ksmotion.h ksmotion.h
Library KsApi_Rtss.lib KsApi.lib

See also

SetCartesianTransform