/usr/include/SurgSim/Devices/Mouse/MouseScaffold.h is in libopensurgsim-dev 0.7.0-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 | // This file is a part of the OpenSurgSim project.
// Copyright 2013, SimQuest Solutions Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef SURGSIM_DEVICES_MOUSE_MOUSESCAFFOLD_H
#define SURGSIM_DEVICES_MOUSE_MOUSESCAFFOLD_H
#include <memory>
#include "SurgSim/Framework/Logger.h"
namespace SurgSim
{
namespace DataStructures
{
class DataGroup;
}
namespace Devices
{
class MouseDevice;
class OsgMouseHandler;
/// A class that implements the behavior of MouseDevice objects.
/// \sa SurgSim::Devices::MouseDevice
class MouseScaffold
{
friend class MouseDevice;
friend class MouseDeviceTest;
friend class OsgMouseHandler;
public:
/// Constructor.
MouseScaffold();
/// Destructor
~MouseScaffold();
/// 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.
/// \return the scaffold object.
static std::shared_ptr<MouseScaffold> getOrCreateSharedInstance();
private:
/// Internal per-device information.
struct DeviceData;
/// Registers the specified device object.
/// If successful, the device object will become connected to an hardware device.
/// \param device The device object to be used, which should have a unique name.
/// \return True if the initialization succeeds, false if it fails.
bool registerDevice(MouseDevice* device);
/// Unregisters the specified device object.
/// The corresponding controller will become unused, and can be re-registered later.
/// \return True on success, false on failure.
bool unregisterDevice();
/// Updates the device information for a single device.
/// \param buttons Buttons being pressed.
/// \param x X-Coordinate for the device.
/// \param y Y-Coordinate for the device.
/// \param scrollDeltaX Horizontal indicator for mouse wheel.
/// \param scrollDeltaY Vertical indicator for mouse wheel.
/// \return True on success.
bool updateDevice(int buttons, float x, float y, int scrollDeltaX, int scrollDeltaY);
/// Get mouse handler
/// \return The mouse handler associated with this device
OsgMouseHandler* getMouseHandler() const;
/// Builds the data layout for the application input (i.e. device output).
static SurgSim::DataStructures::DataGroup buildDeviceInputData();
/// Logger used by the scaffold and all devices.
std::shared_ptr<SurgSim::Framework::Logger> m_logger;
/// The mouse device managed by this scaffold
std::unique_ptr<DeviceData> m_device;
};
}; // namespace Devices
}; // namespace SurgSim
#endif // SURGSIM_DEVICES_MOUSE_MOUSESCAFFOLD_H
|