These functions are used to switch axes on and off and to revert the axes' orientation. More...

Functions
ScStatus	scGetStdMode (int devIdx, unsigned char *bitmaskP)

ScStatus	scSetStdMode (int devIdx, unsigned char *bitmaskP)

ScStatus	scGetTra (int devIdx, bool *isTraP)
	Answers with true if the translational mode is set. More...

ScStatus	scSetTra (int devIdx, bool *isTraP)
	Sets and retrieves the translational mode. More...

ScStatus	scGetXTra (int devIdx, bool *isTraP)
	Answers with true if the x-axis' translational data will be transmitted. More...

ScStatus	scSetXTra (int devIdx, bool *isTraP)
	Sets and retrieves the translational mode for the x-axis. More...

ScStatus	scGetYTra (int devIdx, bool *isTraP)
	Answers with true if the y-axis' translational data will be transmitted. More...

ScStatus	scSetYTra (int devIdx, bool *isTraP)
	Sets and retrieves the translational mode for the y-axis. More...

ScStatus	scGetZTra (int devIdx, bool *isTraP)
	Answers with true if the z-axis' translational data will be transmitted. More...

ScStatus	scSetZTra (int devIdx, bool *isTraP)
	Sets and retrieves the translational mode for the z-axis. More...

ScStatus	scGetXTraRev (int devIdx, bool *isRevP)
	Answers with true if the x-axis' translational mode is set to reverse. More...

ScStatus	scSetXTraRev (int devIdx, bool *isRevP)
	Sets and retrieves the x-axis' reverse translational mode. More...

ScStatus	scGetYTraRev (int devIdx, bool *isRevP)
	Answers with true if the y-axis' translational mode is set to reverse. More...

ScStatus	scSetYTraRev (int devIdx, bool *isRevP)
	Sets and retrieves the y-axis' reverse translational mode. More...

ScStatus	scGetZTraRev (int devIdx, bool *isRevP)
	Answers with true if the z-axis' translational mode is set to reverse. More...

ScStatus	scSetZTraRev (int devIdx, bool *isRevP)
	Sets and retrieves the z-axis' reverse translational mode. More...

ScStatus	scGetRot (int devIdx, bool *isRotP)
	Answers with true if the rotational mode is set. More...

ScStatus	scSetRot (int devIdx, bool *isRotP)
	Sets and retrieves the rotational mode. More...

ScStatus	scGetXRot (int devIdx, bool *isRotP)
	Answers with true if the x-axis' rotational data will be transmitted. More...

ScStatus	scSetXRot (int devIdx, bool *isRotP)
	Sets and retrieves the rotational mode for the x-axis. More...

ScStatus	scGetYRot (int devIdx, bool *isRotP)
	Answers with true if the y-axis' rotational data will be transmitted. More...

ScStatus	scSetYRot (int devIdx, bool *isRotP)
	Sets and retrieves the rotational mode for the y-axis. More...

ScStatus	scGetZRot (int devIdx, bool *isRotP)
	Answers with true if the z-axis' rotational data will be transmitted. More...

ScStatus	scSetZRot (int devIdx, bool *isRotP)
	Sets and retrieves the rotational mode for the z-axis. More...

ScStatus	scGetXRotRev (int devIdx, bool *isRevP)
	Answers with true if the x-axis' rotational mode is set to reverse. More...

ScStatus	scSetXRotRev (int devIdx, bool *isRevP)
	Sets and retrieves the x-axis' reverse rotational mode. More...

ScStatus	scGetYRotRev (int devIdx, bool *isRevP)
	Answers with true if the y-axis' rotational mode is set to reverse. More...

ScStatus	scSetYRotRev (int devIdx, bool *isRevP)
	Sets and retrieves the y-axis' reverse rotational mode. More...

ScStatus	scGetZRotRev (int devIdx, bool *isRevP)
	Answers with true if the z-axis' rotational mode is set to reverse. More...

ScStatus	scSetZRotRev (int devIdx, bool *isRevP)
	Sets and retrieves the z-axis' reverse rotational mode. More...

ScStatus	scGetDom (int devIdx, bool *isDomP)
	Answers with true if the dominant mode is set. More...

ScStatus	scSetDom (int devIdx, bool *isDomP)
	Sets and retrieves the dominant mode. More...

Detailed Description

These functions are used to switch axes on and off and to revert the axes' orientation.

Function Documentation

◆ scGetDom()

ScStatus scGetDom	(	int	devIdx,
		bool *	isDomP
	)

Answers with true if the dominant mode is set.

See scGetStdMode() for details.
Example:

int      devIdx = 0;
bool     isDom;
ScStatus status = scGetDom(devIdx, &isDom);
if (status == SC_OK)
{
   if (isDom)
      printf("dominant mode is active\n");
   else
      printf("dominant mode is not active\n");
}
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

isDomP if dominant mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetRot()

ScStatus scGetRot	(	int	devIdx,
		bool *	isRotP
	)

Answers with true if the rotational mode is set.

See scGetStdMode() for details.
Example:

int      devIdx = 0;
bool     isRot;
ScStatus status = scGetRot(devIdx, &isRot);
if (status == SC_OK)
{
   if (isRot)
      printf("rotational mode is active\n");
   else
      printf("rotational mode is not active\n");
}
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

isRotP if rotational mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetStdMode()

ScStatus scGetStdMode	(	int	devIdx,
		unsigned char *	bitmaskP
	)

Deprecated:: Retrieves the operating mode for standard data.

There are three modes:

Dominant mode: If active all data is set to zero except the data with the highest value.
Translational mode: If active all translational data values (x, y, z) are transmitted, if not the values are set to 0.
Rotational mode: If active all rotational data values (a, b, c) are transmitted, if not the values are set to 0.

The modes are coded as bits in the character *bitmaskP:

///   Bit no.: 87654321 
/// *bitMaskP: 00000000
///                   ^ if bit 1 is set rotational mode is active
///                  ^ if bit 2 is set translational mode is active
///                 ^ if bit 3 is set dominant mode is active
///

Example:

int           devIdx = 0;
unsigned char test   = 4; // set test to 00000100
unsigned char bitmask;
ScStatus      status = scGetStdMode(devIdx, &bitmask);
if (status == SC_OK)
{
   if (bitmask & test)
      printf("dominant mode is active\n");
   else
      printf("dominant mode is not active\n");
}
else
   printf("error\n");

Attention: This function is used for the old SpaceMouse protocol and not needed for the new SpaceControl protocol.

Parameters

devIdx the index of the device to be requested

Return values

bitmaskP pointer to the bitmask which contains the answer

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetTra()

ScStatus scGetTra	(	int	devIdx,
		bool *	isTraP
	)

Answers with true if the translational mode is set.

See scGetStdMode() for details.
Example:

int      devIdx = 0;
bool     isTra;
ScStatus status = scGetTra(devIdx, &isTra);
if (status == SC_OK)
{
   if (isTra)
      printf("translational mode is active\n");
   else
      printf("translational mode is not active\n");
}
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

isTraP if translational mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetXRot()

ScStatus scGetXRot	(	int	devIdx,
		bool *	isRotP
	)

Answers with true if the x-axis' rotational data will be transmitted.

Example:

int      devIdx = 0;
bool     isRot;
ScStatus status = scGetXRot(devIdx, &isRot);
if (status == SC_OK)
{
   if (isRot)
      printf("rotational mode is active\n");
   else
      printf("rotational mode is not active\n");
}
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

isRotP if rotational mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetXRotRev()

ScStatus scGetXRotRev	(	int	devIdx,
		bool *	isRevP
	)

Answers with true if the x-axis' rotational mode is set to reverse.

Example:

int      devIdx = 0;
bool     isRev;
ScStatus status = scGetXRotRev(devIdx, &isRev);
if (status == SC_OK)
{
   if (isRev)
      printf("reverse mode is active\n");
   else
      printf("reverse mode is not active\n");
}
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

isRevP if reverse mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetXTra()

ScStatus scGetXTra	(	int	devIdx,
		bool *	isTraP
	)

Answers with true if the x-axis' translational data will be transmitted.

Example:

int      devIdx = 0;
bool     isTra;
ScStatus status = scGetXTra(devIdx, &isTra);
if (status == SC_OK)
{
   if (isTra)
      printf("translational mode is active\n");
   else
      printf("translational mode is not active\n");
}
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

isTraP if translational mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetXTraRev()

ScStatus scGetXTraRev	(	int	devIdx,
		bool *	isRevP
	)

Answers with true if the x-axis' translational mode is set to reverse.

Example:

int      devIdx = 0;
bool     isRev;
ScStatus status = scGetXTraRev(devIdx, &isRev);
if (status == SC_OK)
{
   if (isRev)
      printf("reverse mode is active\n");
   else
      printf("reverse mode is not active\n");
}
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

isRevP if reverse mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetYRot()

ScStatus scGetYRot	(	int	devIdx,
		bool *	isRotP
	)

Answers with true if the y-axis' rotational data will be transmitted.

Example:

int      devIdx = 0;
bool     isRot;
ScStatus status = scGetYRot(devIdx, &isRot);
if (status == SC_OK)
{
   if (isRot)
      printf("rotational mode is active\n");
   else
      printf("rotational mode is not active\n");
}
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

isRotP if rotational mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetYRotRev()

ScStatus scGetYRotRev	(	int	devIdx,
		bool *	isRevP
	)

Answers with true if the y-axis' rotational mode is set to reverse.

Example:

int      devIdx = 0;
bool     isRev;
ScStatus status = scGetYRotRev(devIdx, &isRev);
if (status == SC_OK)
{
   if (isRev)
      printf("reverse mode is active\n");
   else
      printf("reverse mode is not active\n");
}
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

isRevP if reverse mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetYTra()

ScStatus scGetYTra	(	int	devIdx,
		bool *	isTraP
	)

Answers with true if the y-axis' translational data will be transmitted.

Example:

int      devIdx = 0;
bool     isTra;
ScStatus status = scGetYTra(devIdx, &isTra);
if (status == SC_OK)
{
   if (isTra)
      printf("translational mode is active\n");
   else
      printf("translational mode is not active\n");
}
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

isTraP if translational mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetYTraRev()

ScStatus scGetYTraRev	(	int	devIdx,
		bool *	isRevP
	)

Answers with true if the y-axis' translational mode is set to reverse.

Example:

int      devIdx = 0;
bool     isRev;
ScStatus status = scGetYTraRev(devIdx, &isRev);
if (status == SC_OK)
{
   if (isRev)
      printf("reverse mode is active\n");
   else
      printf("reverse mode is not active\n");
}
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

isRevP if reverse mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetZRot()

ScStatus scGetZRot	(	int	devIdx,
		bool *	isRotP
	)

Answers with true if the z-axis' rotational data will be transmitted.

Example:

int      devIdx = 0;
bool     isRot;
ScStatus status = scGetZRot(devIdx, &isRot);
if (status == SC_OK)
{
   if (isRot)
      printf("rotational mode is active\n");
   else
      printf("rotational mode is not active\n");
}
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

isRotP if rotational mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetZRotRev()

ScStatus scGetZRotRev	(	int	devIdx,
		bool *	isRevP
	)

Answers with true if the z-axis' rotational mode is set to reverse.

Example:

int      devIdx = 0;
bool     isRev;
ScStatus status = scGetZRotRev(devIdx, &isRev);
if (status == SC_OK)
{
   if (isRev)
      printf("reverse mode is active\n");
   else
      printf("reverse mode is not active\n");
}
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

isRevP if reverse mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetZTra()

ScStatus scGetZTra	(	int	devIdx,
		bool *	isTraP
	)

Answers with true if the z-axis' translational data will be transmitted.

Example:

int      devIdx = 0;
bool     isTra;
ScStatus status = scGetZTra(devIdx, &isTra);
if (status == SC_OK)
{
   if (isTra)
      printf("translational mode is active\n");
   else
      printf("translational mode is not active\n");
}
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

isTraP if translational mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scGetZTraRev()

ScStatus scGetZTraRev	(	int	devIdx,
		bool *	isRevP
	)

Answers with true if the z-axis' translational mode is set to reverse.

Example:

int      devIdx = 0;
bool     isRev;
ScStatus status = scGetZTraRev(devIdx, &isRev);
if (status == SC_OK)
{
   if (isRev)
      printf("reverse mode is active\n");
   else
      printf("reverse mode is not active\n");
}
else
   printf("error\n");

Parameters

devIdx the index of the device to be requested

Return values

isRevP if reverse mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scSetDom()

ScStatus scSetDom	(	int	devIdx,
		bool *	isDomP
	)

Sets and retrieves the dominant mode.

This is a convenience function for scSetStdMode(), see there for details.
Example:

int      devIdx = 0;
bool     isDom  = true;
ScStatus status = scSetDom(devIdx, &isDom);
if (status == SC_OK)
   if (isDom)
      printf("dominant mode is active\n");
   else
      printf("setting dominant mode failed!\n");
else
   printf("error\n");

Parameters

devIdx the index of the device the data is to be set

Return values

isDomP if dominant mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scSetRot()

ScStatus scSetRot	(	int	devIdx,
		bool *	isRotP
	)

Sets and retrieves the rotational mode.

This is a convenience function for scSetStdMode(), see there for details.
Example:

int      devIdx = 0;
bool     isRot  = true;
ScStatus status = scSetRot(devIdx, &isRot);
if (status == SC_OK)
   if (isRot)
      printf("rotational mode is active\n");
   else
      printf("setting rotational mode failed!\n");
else
   printf("error\n");

Parameters

devIdx the index of the device the data is to be set

Return values

isRotP if translational mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scSetStdMode()

ScStatus scSetStdMode	(	int	devIdx,
		unsigned char *	bitmaskP
	)

Deprecated:: Sets and retrieves the operating mode for standard data.

See scGetStdMode() for details. Example:

int           devIdx  = 0;
unsigned char test    = 2; // set test to 00000010
unsigned char bitmask = 3; // 00000011 <=> trans. and rot. mode active
ScStatus      status  = scSetStdMode(devIdx, &bitmask);
if (status == SC_OK)
{
   if (bitmask & test)
      printf("translational mode is active\n");
   else
      printf("translational mode is not active\n");
}
else
   printf("error\n");

Attention: This function is used for the old SpaceMouse protocol and not needed for the new SpaceControl protocol.

Parameters

devIdx the index of the device to be requested

Return values

bitmaskP pointer to the bitmask which contains the answer

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX, SC_PARAMETER_OUT_OF_RANGE

References MAX_STD_MODE, MIN_STD_MODE, SC_COMMUNICATION_ERROR, SC_OK, SC_PARAMETER_OUT_OF_RANGE, and SC_WRONG_DEVICE_INDEX.

◆ scSetTra()

ScStatus scSetTra	(	int	devIdx,
		bool *	isTraP
	)

Sets and retrieves the translational mode.

This is a convenience function for scSetStdMode(), see there for details.
Example:

int      devIdx = 0;
bool     isTra  = true;
ScStatus status = scSetTra(devIdx, &isTra);
if (status == SC_OK)
   if (isTra)
      printf("translational mode is active\n");
   else
      printf("setting translational mode failed!\n");
else
   printf("error\n");

Parameters

devIdx the index of the device the data is to be set

Return values

isTraP if translational mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scSetXRot()

ScStatus scSetXRot	(	int	devIdx,
		bool *	isRotP
	)

Sets and retrieves the rotational mode for the x-axis.

Example:

int      devIdx = 0;
bool     isRot  = true;
ScStatus status = scSetXRot(devIdx, &isRot);
if (status == SC_OK)
   if (isRot)
      printf("rotational mode is active\n");
   else
      printf("setting rotational mode failed!\n");
else
   printf("error\n");

Parameters

devIdx the index of the device the data is to be set

Return values

isRotP if rotational mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scSetXRotRev()

ScStatus scSetXRotRev	(	int	devIdx,
		bool *	isRevP
	)

Sets and retrieves the x-axis' reverse rotational mode.

Example:

int      devIdx = 0;
bool     isRev  = true;
ScStatus status = scSetXRotRev(devIdx, &isRev);
if (status == SC_OK)
   if (isRev)
      printf("reverse mode is active\n");
   else
      printf("setting reverse mode failed!\n");
else
   printf("error\n");

Parameters

devIdx the index of the device the data is to be set

Return values

isRevP if reverse mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scSetXTra()

ScStatus scSetXTra	(	int	devIdx,
		bool *	isTraP
	)

Sets and retrieves the translational mode for the x-axis.

Example:

int      devIdx = 0;
bool     isTra  = true;
ScStatus status = scSetXTra(devIdx, &isTra);
if (status == SC_OK)
   if (isTra)
      printf("translational mode is active\n");
   else
      printf("setting translational mode failed!\n");
else
   printf("error\n");

Parameters

devIdx the index of the device the data is to be set

Return values

isTraP if translational mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scSetXTraRev()

ScStatus scSetXTraRev	(	int	devIdx,
		bool *	isRevP
	)

Sets and retrieves the x-axis' reverse translational mode.

Example:

int      devIdx = 0;
bool     isRev  = true;
ScStatus status = scSetXTraRev(devIdx, &isRev);
if (status == SC_OK)
   if (isRev)
      printf("reverse mode is active\n");
   else
      printf("setting reverse mode failed!\n");
else
   printf("error\n");

Parameters

devIdx the index of the device the data is to be set

Return values

isRevP if reverse mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scSetYRot()

ScStatus scSetYRot	(	int	devIdx,
		bool *	isRotP
	)

Sets and retrieves the rotational mode for the y-axis.

Example:

int      devIdx = 0;
bool     isRot  = true;
ScStatus status = scSetYRot(devIdx, &isRot);
if (status == SC_OK)
   if (isRot)
      printf("rotational mode is active\n");
   else
      printf("setting rotational mode failed!\n");
else
   printf("error\n");

Parameters

devIdx the index of the device the data is to be set

Return values

isRotP if rotational mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scSetYRotRev()

ScStatus scSetYRotRev	(	int	devIdx,
		bool *	isRevP
	)

Sets and retrieves the y-axis' reverse rotational mode.

Example:

int      devIdx = 0;
bool     isRev  = true;
ScStatus status = scSetYRotRev(devIdx, &isRev);
if (status == SC_OK)
   if (isRev)
      printf("reverse mode is active\n");
   else
      printf("setting reverse mode failed!\n");
else
   printf("error\n");

Parameters

devIdx the index of the device the data is to be set

Return values

isRevP if reverse mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scSetYTra()

ScStatus scSetYTra	(	int	devIdx,
		bool *	isTraP
	)

Sets and retrieves the translational mode for the y-axis.

Example:

int      devIdx = 0;
bool     isTra  = true;
ScStatus status = scSetYTra(devIdx, &isTra);
if (status == SC_OK)
   if (isTra)
      printf("translational mode is active\n");
   else
      printf("setting translational mode failed!\n");
else
   printf("error\n");

Parameters

devIdx the index of the device the data is to be set

Return values

isTraP if translational mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scSetYTraRev()

ScStatus scSetYTraRev	(	int	devIdx,
		bool *	isRevP
	)

Sets and retrieves the y-axis' reverse translational mode.

Example:

int      devIdx = 0;
bool     isRev  = true;
ScStatus status = scSetYTraRev(devIdx, &isRev);
if (status == SC_OK)
   if (isRev)
      printf("reverse mode is active\n");
   else
      printf("setting reverse mode failed!\n");
else
   printf("error\n");

Parameters

devIdx the index of the device the data is to be set

Return values

isRevP if reverse mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scSetZRot()

ScStatus scSetZRot	(	int	devIdx,
		bool *	isRotP
	)

Sets and retrieves the rotational mode for the z-axis.

Example:

int      devIdx = 0;
bool     isRot  = true;
ScStatus status = scSetZRot(devIdx, &isRot);
if (status == SC_OK)
   if (isRot)
      printf("rotational mode is active\n");
   else
      printf("setting rotational mode failed!\n");
else
   printf("error\n");

Parameters

devIdx the index of the device the data is to be set

Return values

isRotP if rotational mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scSetZRotRev()

ScStatus scSetZRotRev	(	int	devIdx,
		bool *	isRevP
	)

Sets and retrieves the z-axis' reverse rotational mode.

Example:

int      devIdx = 0;
bool     isRev  = true;
ScStatus status = scSetZRotRev(devIdx, &isRev);
if (status == SC_OK)
   if (isRev)
      printf("reverse mode is active\n");
   else
      printf("setting reverse mode failed!\n");
else
   printf("error\n");

Parameters

devIdx the index of the device the data is to be set

Return values

isRevP if reverse mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scSetZTra()

ScStatus scSetZTra	(	int	devIdx,
		bool *	isTraP
	)

Sets and retrieves the translational mode for the z-axis.

Example:

int      devIdx = 0;
bool     isTra  = true;
ScStatus status = scSetZTra(devIdx, &isTra);
if (status == SC_OK)
   if (isTra)
      printf("translational mode is active\n");
   else
      printf("setting translational mode failed!\n");
else
   printf("error\n");

Parameters

devIdx the index of the device the data is to be set

Return values

isTraP if translational mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

◆ scSetZTraRev()

ScStatus scSetZTraRev	(	int	devIdx,
		bool *	isRevP
	)

Sets and retrieves the z-axis' reverse translational mode.

Example:

int      devIdx = 0;
bool     isRev  = true;
ScStatus status = scSetZTraRev(devIdx, &isRev);
if (status == SC_OK)
   if (isRev)
      printf("reverse mode is active\n");
   else
      printf("setting reverse mode failed!\n");
else
   printf("error\n");

Parameters

devIdx the index of the device the data is to be set

Return values

isRevP if reverse mode is active true, else false

Returns: SC_OK, SC_COMMUNICATION_ERROR, SC_WRONG_DEVICE_INDEX

References SC_COMMUNICATION_ERROR, SC_OK, and SC_WRONG_DEVICE_INDEX.

Functions

Detailed Description

Function Documentation

◆ scGetDom()

◆ scGetRot()

◆ scGetStdMode()

◆ scGetTra()

◆ scGetXRot()

◆ scGetXRotRev()

◆ scGetXTra()

◆ scGetXTraRev()

◆ scGetYRot()

◆ scGetYRotRev()

◆ scGetYTra()

◆ scGetYTraRev()

◆ scGetZRot()

◆ scGetZRotRev()

◆ scGetZTra()

◆ scGetZTraRev()

◆ scSetDom()

◆ scSetRot()

◆ scSetStdMode()

◆ scSetTra()

◆ scSetXRot()

◆ scSetXRotRev()

◆ scSetXTra()

◆ scSetXTraRev()

◆ scSetYRot()

◆ scSetYRotRev()

◆ scSetYTra()

◆ scSetYTraRev()

◆ scSetZRot()

◆ scSetZRotRev()

◆ scSetZTra()

◆ scSetZTraRev()