A class that implements the behavior of MouseDevice objects.
More...
#include <SurgSim/Devices/Mouse/MouseScaffold.h>
A class that implements the behavior of MouseDevice objects.
- See also
- SurgSim::Devices::MouseDevice
◆ MouseScaffold()
SurgSim::Devices::MouseScaffold::MouseScaffold |
( |
| ) |
|
◆ ~MouseScaffold()
SurgSim::Devices::MouseScaffold::~MouseScaffold |
( |
| ) |
|
◆ buildDeviceInputData()
Builds the data layout for the application input (i.e. device output).
◆ getMouseHandler()
OsgMouseHandler * SurgSim::Devices::MouseScaffold::getMouseHandler |
( |
| ) |
const |
|
private |
Get mouse handler.
- Returns
- The mouse handler associated with this device
◆ getOrCreateSharedInstance()
std::shared_ptr< MouseScaffold > SurgSim::Devices::MouseScaffold::getOrCreateSharedInstance |
( |
| ) |
|
|
static |
Gets or creates the scaffold shared by all MouseDevice 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::MouseScaffold::registerDevice |
( |
MouseDevice * |
device | ) |
|
|
private |
Registers the specified device object.
If successful, the device object will become connected to an hardware device.
- Parameters
-
device | The device object to be used, which should have a unique name. |
- Returns
- True if the initialization succeeds, false if it fails.
◆ unregisterDevice()
bool SurgSim::Devices::MouseScaffold::unregisterDevice |
( |
| ) |
|
|
private |
Unregisters the specified device object.
The corresponding controller will become unused, and can be re-registered later.
- Returns
- True on success, false on failure.
◆ updateDevice()
bool SurgSim::Devices::MouseScaffold::updateDevice |
( |
int |
buttons, |
|
|
float |
x, |
|
|
float |
y, |
|
|
int |
scrollDeltaX, |
|
|
int |
scrollDeltaY |
|
) |
| |
|
private |
Updates the device information for a single device.
- Parameters
-
buttons | Buttons being pressed. |
x | X-Coordinate for the device. |
y | Y-Coordinate for the device. |
scrollDeltaX | Horizontal indicator for mouse wheel. |
scrollDeltaY | Vertical indicator for mouse wheel. |
- Returns
- True on success.
◆ MouseDevice
◆ MouseDeviceTest
friend class MouseDeviceTest |
|
friend |
◆ OsgMouseHandler
◆ m_device
std::unique_ptr<DeviceData> SurgSim::Devices::MouseScaffold::m_device |
|
private |
The mouse device managed by this scaffold.
◆ m_logger
Logger used by the scaffold and all devices.
The documentation for this class was generated from the following files: