SurgSim::Devices::PhantomScaffold::DeviceData Struct Reference

## Public Member Functions

| DeviceData (const std::string &apiName, PhantomDevice *device)
| Initialize the state. More...

## Public Attributes

const std::string | initializationName
| The OpenHaptics device name. More...
PhantomDevice *const | deviceObject
| The corresponding device object. More...
PhantomScaffold::Handle | deviceHandle
| The device handle wrapper. More...
int | buttonsBuffer
| The raw button state read from the device. More...
Vector3d | position
| The position value from the device. More...
Vector3d | linearVelocity
| The linear velocity value from the device. More...
RigidTransform3d | scaledPose
| The pose value from the device, after scaling. More...
Vector3d | force
| The force value to be written to the device, in Newtons. More...
Vector3d | torque
| The torque value to be written to the device, in milliNewton-meters. More...

## Private Member Functions

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

## Constructor & Destructor Documentation

## DeviceData() [1/2]

SurgSim::Devices::PhantomScaffold::DeviceData::DeviceData | ( | const std::string & | apiName,
|  | PhantomDevice * | device
| ) |  |

inline

Initialize the state.

## DeviceData() [2/2]

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

private

## Member Function Documentation

## operator=()

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

private

## Member Data Documentation

## buttonsBuffer

int SurgSim::Devices::PhantomScaffold::DeviceData::buttonsBuffer

The raw button state read from the device.

## deviceHandle

PhantomScaffold::Handle SurgSim::Devices::PhantomScaffold::DeviceData::deviceHandle

The device handle wrapper.

## deviceObject

PhantomDevice* const SurgSim::Devices::PhantomScaffold::DeviceData::deviceObject

The corresponding device object.

## force

Vector3d SurgSim::Devices::PhantomScaffold::DeviceData::force

The force value to be written to the device, in Newtons.

## initializationName

const std::string SurgSim::Devices::PhantomScaffold::DeviceData::initializationName

The OpenHaptics device name.

## linearVelocity

Vector3d SurgSim::Devices::PhantomScaffold::DeviceData::linearVelocity

The linear velocity value from the device.

## position

Vector3d SurgSim::Devices::PhantomScaffold::DeviceData::position

The position value from the device.

## scaledPose

RigidTransform3d SurgSim::Devices::PhantomScaffold::DeviceData::scaledPose

The pose value from the device, after scaling.

## torque

Vector3d SurgSim::Devices::PhantomScaffold::DeviceData::torque

The torque value to be written to the device, in milliNewton-meters.

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

- SurgSim/Devices/Phantom/PhantomScaffold.cpp