SurgSim::Devices::KeyboardScaffold Class Reference

A class that implements the behavior of KeyboardDevice objects. More...

#include <KeyboardScaffold.h>

Classes
struct	DeviceData
	Struct to hold a KeyboardDevice object, a KeyboardHandler object, and a mutex for data passing. More...

Public Member Functions
	KeyboardScaffold ()
	Constructor.
	~KeyboardScaffold ()
	Destructor.

Static Public Member Functions
static std::shared_ptr< KeyboardScaffold >	getOrCreateSharedInstance ()
	Gets or creates the scaffold shared by all KeyboardDevice instances. More...

Friends
class	KeyboardDevice
class	KeyboardDeviceTest
class	OsgKeyboardHandler

Detailed Description

A class that implements the behavior of KeyboardDevice objects.

See also

SurgSim::Devices::KeyboardDevice

Member Function Documentation

getOrCreateSharedInstance()

std::shared_ptr< KeyboardScaffold > SurgSim::Devices::KeyboardScaffold::getOrCreateSharedInstance ( )

static

Gets or creates the scaffold shared by all KeyboardDevice instances.

The scaffold is managed using a SharedInstance object, so it will be destroyed when all devices are released.

Returns

the scaffold object.

---

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

• SurgSim/Devices/Keyboard/KeyboardScaffold.h
• SurgSim/Devices/Keyboard/KeyboardScaffold.cpp