SurgSim::Devices::RawMultiAxisScaffold::DeviceData Struct Reference

## Public Member Functions

| DeviceData (const std::string &path, RawMultiAxisDevice *device, std::unique_ptr< SystemInputDeviceHandle > &&handle)
| Initialize the data. More...
| DeviceData (DeviceData &&other)
| ~DeviceData ()

## Static Public Member Functions

static SurgSim::Math::Matrix33d | defaultCoordinateSystemRotation ()
static SystemInputDeviceHandle::AxisStates | initialAxisStates ()
static SystemInputDeviceHandle::ButtonStates | initialButtonStates ()

## Public Attributes

const std::string | devicePath
| The system device path corresponding to this device. More...
RawMultiAxisDevice *const | deviceObject
| The corresponding device object. More...
std::unique_ptr< RawMultiAxisThread > | thread
| Processing thread. More...
std::unique_ptr< SystemInputDeviceHandle > | deviceHandle
| Device handle to read from. More...
SystemInputDeviceHandle::AxisStates | axisStates
| Persistent axis states. More...
SystemInputDeviceHandle::ButtonStates | buttonStates
| Persistent button states. More...
SurgSim::Math::Matrix33d | coordinateSystemRotation
| The rotation of the coordinate system (used to reorient, e.g. point +Y up) More...
double | positionScale
| Scale factor for the position axes. More...
double | orientationScale
| Scale factor for the orientation axes. More...
bool | useAxisDominance
| Controls whether dominance will be enabled. More...
boost::mutex | parametersMutex
| The mutex that protects the externally modifiable parameters. More...

## Private Member Functions

| DeviceData (const DeviceData &)
DeviceData & | operator= (const DeviceData &)

## Constructor & Destructor Documentation

## DeviceData() [1/3]

SurgSim::Devices::RawMultiAxisScaffold::DeviceData::DeviceData | ( | const std::string & | path,
|  | RawMultiAxisDevice * | device,
|  | std::unique_ptr< SystemInputDeviceHandle > && | handle
| ) |  |

inline

Initialize the data.

## DeviceData() [2/3]

SurgSim::Devices::RawMultiAxisScaffold::DeviceData::DeviceData | ( | DeviceData && | other | ) |

inline

## ~DeviceData()

SurgSim::Devices::RawMultiAxisScaffold::DeviceData::~DeviceData | ( |  | ) |

inline

## DeviceData() [3/3]

SurgSim::Devices::RawMultiAxisScaffold::DeviceData::DeviceData | ( | const DeviceData & |  | ) |

private

## Member Function Documentation

## defaultCoordinateSystemRotation()

static SurgSim::Math::Matrix33d SurgSim::Devices::RawMultiAxisScaffold::DeviceData::defaultCoordinateSystemRotation | ( |  | ) |

inline static

## initialAxisStates()

static SystemInputDeviceHandle::AxisStates SurgSim::Devices::RawMultiAxisScaffold::DeviceData::initialAxisStates | ( |  | ) |

inline static

## initialButtonStates()

static SystemInputDeviceHandle::ButtonStates SurgSim::Devices::RawMultiAxisScaffold::DeviceData::initialButtonStates | ( |  | ) |

inline static

## operator=()

DeviceData& SurgSim::Devices::RawMultiAxisScaffold::DeviceData::operator= | ( | const DeviceData & |  | ) |

private

## Member Data Documentation

## axisStates

SystemInputDeviceHandle::AxisStates SurgSim::Devices::RawMultiAxisScaffold::DeviceData::axisStates

Persistent axis states.

## buttonStates

SystemInputDeviceHandle::ButtonStates SurgSim::Devices::RawMultiAxisScaffold::DeviceData::buttonStates

Persistent button states.

## coordinateSystemRotation

SurgSim::Math::Matrix33d SurgSim::Devices::RawMultiAxisScaffold::DeviceData::coordinateSystemRotation

The rotation of the coordinate system (used to reorient, e.g. point +Y up)

## deviceHandle

std::unique_ptr<SystemInputDeviceHandle> SurgSim::Devices::RawMultiAxisScaffold::DeviceData::deviceHandle

Device handle to read from.

## deviceObject

RawMultiAxisDevice* const SurgSim::Devices::RawMultiAxisScaffold::DeviceData::deviceObject

The corresponding device object.

## devicePath

const std::string SurgSim::Devices::RawMultiAxisScaffold::DeviceData::devicePath

The system device path corresponding to this device.

## orientationScale

double SurgSim::Devices::RawMultiAxisScaffold::DeviceData::orientationScale

Scale factor for the orientation axes.

## parametersMutex

boost::mutex SurgSim::Devices::RawMultiAxisScaffold::DeviceData::parametersMutex

The mutex that protects the externally modifiable parameters.

## positionScale

double SurgSim::Devices::RawMultiAxisScaffold::DeviceData::positionScale

Scale factor for the position axes.

## thread

std::unique_ptr<RawMultiAxisThread> SurgSim::Devices::RawMultiAxisScaffold::DeviceData::thread

Processing thread.

## useAxisDominance

bool SurgSim::Devices::RawMultiAxisScaffold::DeviceData::useAxisDominance

Controls whether dominance will be enabled.

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

- SurgSim/Devices/MultiAxis/RawMultiAxisScaffold.cpp