ControlMapping Struct Reference

This represents a group of functionalities mapped to some events triggered by a specific controller. More...

#include <KinovaTypes.h>

List of all members.

Public Attributes
int	ActualModeA
	This is the actual index of the active mode map in the list A. If the list A is currently unused, this value will be -1.
int	ActualModeB
ControlMappingMode	Mode
	That indicates what kind of controller is in use.
ControlsModeMap	ModeControlsA [MODE_MAP_COUNT]
	This is the mode map list A. By default, on the 3-axis kinova joystick, it corresponds to the modes accessible with the left button on the top of the stick.
ControlsModeMap	ModeControlsB [MODE_MAP_COUNT]
	This is the mode map list B. By default, on the 3-axis kinova joystick, it corresponds to the modes accessible with the right button on the top of the stick.
int	NumOfModesA
	List A's element count. If this value exceeds MODE_MAP_COUNT, we got a problem.
int	NumOfModesB
	List B's element count. If this value exceeds MODE_MAP_COUNT, we got a problem.

---

Detailed Description

This represents a group of functionalities mapped to some events triggered by a specific controller.

As an example, the kinova 3-axis joystick has its own control mapping. This API also has its own control mapping. Note that since list A and list B cannot be used at the same time in the same control mapping, it implies that either one of the variable can have a >= 0 value.

Definition at line 1312 of file KinovaTypes.h.

---

Member Data Documentation

int ControlMapping::ActualModeA

This is the actual index of the active mode map in the list A. If the list A is currently unused, this value will be -1.

Definition at line 1328 of file KinovaTypes.h.

int ControlMapping::ActualModeB

is the actual index of the active mode map in the list B. If the list B is currently unused, this value will be -1.

Definition at line 1334 of file KinovaTypes.h.

ControlMappingMode ControlMapping::Mode

That indicates what kind of controller is in use.

Definition at line 1339 of file KinovaTypes.h.

ControlsModeMap ControlMapping::ModeControlsA[MODE_MAP_COUNT]

This is the mode map list A. By default, on the 3-axis kinova joystick, it corresponds to the modes accessible with the left button on the top of the stick.

Definition at line 1345 of file KinovaTypes.h.

ControlsModeMap ControlMapping::ModeControlsB[MODE_MAP_COUNT]

This is the mode map list B. By default, on the 3-axis kinova joystick, it corresponds to the modes accessible with the right button on the top of the stick.

Definition at line 1351 of file KinovaTypes.h.

int ControlMapping::NumOfModesA

List A's element count. If this value exceeds MODE_MAP_COUNT, we got a problem.

Definition at line 1317 of file KinovaTypes.h.

int ControlMapping::NumOfModesB

List B's element count. If this value exceeds MODE_MAP_COUNT, we got a problem.

Definition at line 1322 of file KinovaTypes.h.

---

The documentation for this struct was generated from the following file:

• KinovaTypes.h