A class that manages OpenNI devices.
More...
#include <SurgSim/Devices/OpenNI/OpenNIScaffold.h>
|
bool | doInitialize () override |
|
bool | doStartUp () override |
|
bool | doUpdate (double dt) override |
| Implementation of actual work function for this thread, this has a default implementation to handle destruction better, as it could be called while the thread is under destruction, if left unimplemented this would trigger a call to a pure virtual function. More...
|
|
bool | initialize () |
| Trigger the initialization of this object, this will be called before all other threads doStartup() are called. More...
|
|
bool | startUp () |
| Trigger the startup of this object, this will be called after all other threads doInit() was called the thread will only enter the run loop triggering upated() if all threads doInit() and doStartup() returned true. More...
|
|
bool | waitForBarrier (bool success) |
|
virtual bool | executeInitialization () |
|
A class that manages OpenNI devices.
- See also
- SurgSim::Devices::OpenNIDevice
§ ~OpenNIScaffold()
SurgSim::Devices::OpenNIScaffold::~OpenNIScaffold |
( |
| ) |
|
|
virtual |
§ OpenNIScaffold()
SurgSim::Devices::OpenNIScaffold::OpenNIScaffold |
( |
| ) |
|
|
private |
§ buildDeviceInputData()
Builds the data layout for the application input (i.e. device output).
§ doInitialize()
bool SurgSim::Devices::OpenNIScaffold::doInitialize |
( |
| ) |
|
|
overrideprotectedvirtual |
§ doRegisterDevice()
bool SurgSim::Devices::OpenNIScaffold::doRegisterDevice |
( |
DeviceData * |
info | ) |
|
|
private |
Do the OpenNI specific registration.
- Parameters
-
- Returns
- true on success, false on failure.
§ doStartUp()
bool SurgSim::Devices::OpenNIScaffold::doStartUp |
( |
| ) |
|
|
overrideprotectedvirtual |
§ doUnregisterDevice()
bool SurgSim::Devices::OpenNIScaffold::doUnregisterDevice |
( |
DeviceData * |
info | ) |
|
|
private |
Do the OpenNI specific unregistration.
- Parameters
-
- Returns
- true on success, false on failure.
§ doUpdate()
bool SurgSim::Devices::OpenNIScaffold::doUpdate |
( |
double |
dt | ) |
|
|
overrideprotectedvirtual |
Implementation of actual work function for this thread, this has a default implementation to handle destruction better, as it could be called while the thread is under destruction, if left unimplemented this would trigger a call to a pure virtual function.
- Returns
- false when the thread is done, this will stop execution
Reimplemented from SurgSim::Framework::BasicThread.
§ getOrCreateSharedInstance()
std::shared_ptr< OpenNIScaffold > SurgSim::Devices::OpenNIScaffold::getOrCreateSharedInstance |
( |
| ) |
|
|
staticprivate |
Gets or creates the scaffold shared by all OpenNIDevice instances.
The scaffold is managed using a SharedInstance object, so it will be destroyed when all devices are released.
- Returns
- the scaffold object.
§ registerDevice()
bool SurgSim::Devices::OpenNIScaffold::registerDevice |
( |
OpenNIDevice * |
device | ) |
|
|
private |
Registers the specified device object.
- Parameters
-
device | The device object to be used |
- Returns
- True if the initialization succeeds, false if it fails.
§ unregisterDevice()
bool SurgSim::Devices::OpenNIScaffold::unregisterDevice |
( |
const OpenNIDevice * |
device | ) |
|
|
private |
Unregisters the specified device object.
- Parameters
-
- Returns
- true on success, false on failure.
§ OpenNIDevice
§ m_logger
Logger used by the scaffold.
§ m_state
std::unique_ptr<StateData> SurgSim::Devices::OpenNIScaffold::m_state |
|
private |
The documentation for this class was generated from the following files: