OSVR Framework (Internal Development Docs)  0.6-1962-g59773924
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
osvr::common::Location2DComponent Class Reference

BaseDevice component. More...

#include <osvr/Common/Location2DComponent.h>

Inheritance diagram for osvr::common::Location2DComponent:
osvr::common::DeviceComponent

Public Types

typedef std::function< void(LocationData
const &, util::time::TimeValue
const &)> 
LocationHandler
 
- Public Types inherited from osvr::common::DeviceComponent
typedef BaseDevice Parent
 

Public Member Functions

void sendLocationData (OSVR_Location2DState location, OSVR_ChannelCount sensor, OSVR_TimeValue const &timestamp)
 
void registerLocationHandler (LocationHandler cb)
 
- Public Member Functions inherited from osvr::common::DeviceComponent
void recordParent (Parent &dev)
 Called (only) by BaseDevice when being added: effectively records a "parent pointer" that does not convey ownership.
 
void update ()
 Called during mainloop.
 

Static Public Member Functions

static shared_ptr
< Location2DComponent
create (OSVR_ChannelCount numSensor=1)
 Factory method. More...
 

Public Attributes

messages::LocationRecord locationRecord
 Message from server to client, containing 2D location data.
 

Additional Inherited Members

- Protected Member Functions inherited from osvr::common::DeviceComponent
 DeviceComponent ()
 Protected constructor, to require subclassing.
 
bool m_hasParent () const
 Returns true if we have a parent registered.
 
Parentm_getParent ()
 Gets the parent - only call if m_hasParent() is true.
 
void m_registerHandler (vrpn_MESSAGEHANDLER handler, void *userdata, RawMessageType const &msgType)
 Registers a handler whose lifetime is tied to the lifetime of the component. More...
 
virtual void m_update ()
 Implementation-specific (optional) stuff to do during mainloop.
 

Detailed Description

BaseDevice component.

Definition at line 61 of file Location2DComponent.h.

Member Function Documentation

shared_ptr< Location2DComponent > osvr::common::Location2DComponent::create ( OSVR_ChannelCount  numSensor = 1)
static

Factory method.

Required to ensure that allocation and deallocation stay on the same side of a DLL line.

Definition at line 68 of file Location2DComponent.cpp.


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