LeapScaffold.h
Go to the documentation of this file.
1 // This file is a part of the OpenSurgSim project.
2 // Copyright 2013-2015, SimQuest Solutions Inc.
3 //
4 // Licensed under the Apache License, Version 2.0 (the "License");
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 // http://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15 
16 #ifndef SURGSIM_DEVICES_LEAP_LEAPSCAFFOLD_H
17 #define SURGSIM_DEVICES_LEAP_LEAPSCAFFOLD_H
18 
19 #include <memory>
20 
23 
24 
25 namespace SurgSim
26 {
27 
28 namespace Framework
29 {
30 class Logger;
31 };
32 
33 namespace Devices
34 {
35 
36 class LeapDevice;
37 
42 {
43 public:
45  virtual ~LeapScaffold();
46 
47 private:
49  struct StateData;
50 
52  struct DeviceData;
53 
55  class Listener;
56 
57  friend class LeapDevice;
58 
60  LeapScaffold();
61 
65  static std::shared_ptr<LeapScaffold> getOrCreateSharedInstance();
66 
70  bool registerDevice(LeapDevice* device);
71 
75  bool unregisterDevice(const LeapDevice* device);
76 
80  bool doRegisterDevice(DeviceData* info);
81 
83  void handleFrame();
84 
86  void handleConnect();
87 
89  void updateHandData();
90 
92  void updateImageData();
93 
96 
98  std::unique_ptr<StateData> m_state;
99 
102  void setUseHmdTrackingMode(bool useHmdTrackingMode);
103 
106  bool isUsingHmdTrackingMode() const;
107 
109  std::shared_ptr<Framework::Logger> m_logger;
110 };
111 
112 }; // namespace Devices
113 }; // namespace SurgSim
114 
115 #endif // SURGSIM_DEVICES_LEAP_LEAPSCAFFOLD_H
SurgSim::Devices::LeapScaffold::LeapScaffold
LeapScaffold()
Constructor.
Definition: LeapScaffold.cpp:151
SurgSim::Devices::LeapScaffold::DeviceData
Definition: LeapScaffold.cpp:122
SurgSim::Devices::LeapScaffold::setUseHmdTrackingMode
void setUseHmdTrackingMode(bool useHmdTrackingMode)
Set using HMD Tracking Mode.
Definition: LeapScaffold.cpp:449
SurgSim::Devices::LeapScaffold::updateImageData
void updateImageData()
Update the image data.
Definition: LeapScaffold.cpp:337
SurgSim::Devices::LeapScaffold::doRegisterDevice
bool doRegisterDevice(DeviceData *info)
Do the Leap specific registration.
Definition: LeapScaffold.cpp:201
SurgSim::Devices::LeapScaffold::m_state
std::unique_ptr< StateData > m_state
Internal scaffold state.
Definition: LeapScaffold.h:98
SurgSim::Devices::LeapScaffold::updateHandData
void updateHandData()
Update the hand data.
Definition: LeapScaffold.cpp:280
SurgSim::Devices::LeapScaffold::handleConnect
void handleConnect()
Handle initial connection to SDK.
Definition: LeapScaffold.cpp:255
SurgSim::Devices::LeapScaffold::registerDevice
bool registerDevice(LeapDevice *device)
Registers the specified device object.
Definition: LeapScaffold.cpp:165
SurgSim::Devices::LeapScaffold
A class that manages Leap devices.
Definition: LeapScaffold.h:42
SurgSim::Devices::LeapScaffold::isUsingHmdTrackingMode
bool isUsingHmdTrackingMode() const
Is Using HMD Tracking Mode.
Definition: LeapScaffold.cpp:461
SurgSim
Definition: CompoundShapeToGraphics.cpp:30
SurgSim::DataStructures::DataGroup
A collection of NamedData objects.
Definition: DataGroup.h:69
SurgSim::Devices::LeapScaffold::Listener
Definition: LeapScaffold.cpp:84
SurgSim::Devices::LeapScaffold::handleFrame
void handleFrame()
Handle a new frame of data.
Definition: LeapScaffold.cpp:269
SurgSim::Devices::LeapScaffold::getOrCreateSharedInstance
static std::shared_ptr< LeapScaffold > getOrCreateSharedInstance()
Gets or creates the scaffold shared by all LeapDevice instances.
Definition: LeapScaffold.cpp:378
SurgSim::Devices::LeapDevice
A class implementing the communication with one hand tracked by Leap Motion camera.
Definition: LeapDevice.h:66
SurgSim::Devices::LeapScaffold::~LeapScaffold
virtual ~LeapScaffold()
Destructor.
Definition: LeapScaffold.cpp:157
DataGroup.h
SurgSim::Devices::LeapScaffold::m_logger
std::shared_ptr< Framework::Logger > m_logger
Logger used by the scaffold.
Definition: LeapScaffold.h:109
LeapDevice.h
SurgSim::Devices::LeapScaffold::unregisterDevice
bool unregisterDevice(const LeapDevice *device)
Unregisters the specified device object.
Definition: LeapScaffold.cpp:217
SurgSim::Devices::LeapScaffold::buildDeviceInputData
static DataStructures::DataGroup buildDeviceInputData()
Builds the data layout for the application input (i.e. device output).
Definition: LeapScaffold.cpp:388
SurgSim::Devices::LeapScaffold::StateData
Definition: LeapScaffold.cpp:137