SurgSim::Devices::PhantomScaffold::Callback Class Reference

## Public Member Functions

| Callback ()
| ~Callback ()
bool | isValid () const
bool | create ()
bool | destroy ()

## Private Member Functions

| Callback (const Callback &)
Callback & | operator= (const Callback &)

## Static Private Member Functions

static HDCallbackCode HDCALLBACK | run (void *data)
| The callback wrapper passed to OpenHaptics. More...

## Private Attributes

HDSchedulerHandle | m_callbackHandle
| The haptic loop callback handle. More...
bool | m_haveCallback
| True if the callback has been created (and not destroyed). More...
std::shared_ptr< PhantomScaffold > | m_scaffold
| The scaffold. More...

## Constructor & Destructor Documentation

## Callback() [1/2]

SurgSim::Devices::PhantomScaffold::Callback::Callback | ( |  | ) |

inline

## ~Callback()

SurgSim::Devices::PhantomScaffold::Callback::~Callback | ( |  | ) |

inline

## Callback() [2/2]

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

private

## Member Function Documentation

## create()

bool SurgSim::Devices::PhantomScaffold::Callback::create | ( |  | ) |

inline

## destroy()

bool SurgSim::Devices::PhantomScaffold::Callback::destroy | ( |  | ) |

inline

## isValid()

bool SurgSim::Devices::PhantomScaffold::Callback::isValid | ( |  | ) | const

inline

## operator=()

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

private

## run()

HDCallbackCode HDCALLBACK SurgSim::Devices::PhantomScaffold::Callback::run | ( | void * | data | ) |

static private

The callback wrapper passed to OpenHaptics.

Parameters

  [in,out] | data | The user data (in our case, the scaffold pointer).

Returns
  HD_CALLBACK_CONTINUE to wait for the next frame, or HD_CALLBACK_DONE to terminate further calls.

## Member Data Documentation

## m_callbackHandle

HDSchedulerHandle SurgSim::Devices::PhantomScaffold::Callback::m_callbackHandle

private

The haptic loop callback handle.

## m_haveCallback

bool SurgSim::Devices::PhantomScaffold::Callback::m_haveCallback

private

True if the callback has been created (and not destroyed).

## m_scaffold

std::shared_ptr<PhantomScaffold> SurgSim::Devices::PhantomScaffold::Callback::m_scaffold

private

The scaffold.

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

- SurgSim/Devices/Phantom/PhantomScaffold.cpp