A class implementing the communication with Oculus Rift DK2. More...

#include <OculusDevice.h>

Inheritance diagram for SurgSim::Devices::OculusDevice:

Public Member Functions
	OculusDevice (const std::string &name)
	Constructor. More...

	SURGSIM_CLASSNAME (SurgSim::Devices::OculusDevice)

virtual	~OculusDevice ()
	Destructor.

bool	initialize () override
	Fully initialize the device. More...

bool	isInitialized () const override

void	setNearPlane (float nearPlane)
	Set the near plane. More...

float	getNearPlane () const

void	setFarPlane (float farPlane)
	Set the far plane. More...

float	getFarPlane () const

Public Member Functions inherited from SurgSim::Input::CommonDevice
	CommonDevice (const std::string &name)
	Constructor. More...

	CommonDevice (const std::string &name, const DataStructures::DataGroup &inputData)
	Constructor. More...

	CommonDevice (const std::string &name, DataStructures::DataGroup &&inputData)
	Constructor. More...

virtual	~CommonDevice ()
	Destructor.

std::string	getName () const override
	Return a (hopefully unique) device name.

std::string	getClassName () const override
	The class name for this class. More...

void	setNameForCallback (const std::string &name)
	Set the name used for calling the input consumers and output producer. More...

std::string	getNameForCallback () const
	Get the name used for calling the input consumers and output producer. More...

bool	addInputConsumer (std::shared_ptr< InputConsumerInterface > inputConsumer) override
	Adds an input consumer that will be notified when the application input state is updated. More...

bool	removeInputConsumer (std::shared_ptr< InputConsumerInterface > inputConsumer) override
	Removes an input consumer previously added via addInputConsumer. More...

void	clearInputConsumers () override
	Removes all InputConsumers.

bool	setOutputProducer (std::shared_ptr< OutputProducerInterface > outputProducer) override
	Sets an output producer that will be asked for application output state when the device needs it. More...

bool	removeOutputProducer (std::shared_ptr< OutputProducerInterface > outputProducer) override
	Removes an output producer previously added via setOutputProducer. More...

bool	hasOutputProducer () override
	Query if this object has output producer. More...

void	clearOutputProducer () override
	Removes any OutputProducer.

Public Member Functions inherited from SurgSim::Input::DeviceInterface
virtual	~DeviceInterface ()
	Virtual destructor (empty).

Public Member Functions inherited from SurgSim::Framework::Accessible
	Accessible ()
	Default Constructor.

	~Accessible ()
	Destructor.

template<class T >
T	getValue (const std::string &name) const
	Retrieves the value with the name by executing the getter if it is found and tries to convert it to the given type. More...

boost::any	getValue (const std::string &name) const
	Retrieves the value with the name by executing the getter if it is found. More...

template<class T >
bool	getValue (const std::string &name, T *value) const
	Retrieves the value with the name by executing the getter if it is found, and converts it to the type of the output parameter. More...

void	setValue (const std::string &name, const boost::any &value)
	Sets a value of a property that has setter. More...

bool	isReadable (const std::string &name) const
	Check whether a property is readable. More...

bool	isWriteable (const std::string &name) const
	Check whether a property is writable. More...

void	setGetter (const std::string &name, GetterType func)
	Sets a getter for a given property. More...

void	setSetter (const std::string &name, SetterType func)
	Sets a setter for a given property. More...

void	setAccessors (const std::string &name, GetterType getter, SetterType setter)
	Sets the accessors getter and setter in one function. More...

void	removeAccessors (const std::string &name)
	Removes all the accessors (getter and setter) for a given property. More...

void	forwardProperty (const std::string &name, const Accessible &target, const std::string &targetProperty)
	Adds a property with the given name that uses the targets accessors, in effect forwarding the value to the target. More...

void	setSerializable (const std::string &name, EncoderType encoder, DecoderType decoder)
	Sets the functions used to convert data from and to a YAML::Node. More...

void	setDecoder (const std::string &name, DecoderType decoder)
	Sets the functions used to convert data from a YAML::Node. More...

YAML::Node	encode () const
	Encode this Accessible to a YAML::Node. More...

void	decode (const YAML::Node &node, const std::vector< std::string > &ignoredProperties=std::vector< std::string >())
	Decode this Accessible from a YAML::Node, will throw an exception if the data type cannot be converted. More...

std::vector< std::string >	getProperties ()

template<>
boost::any	getValue (const std::string &name) const

Friends
class	OculusScaffold

Additional Inherited Members
Public Types inherited from SurgSim::Framework::Accessible
typedef std::function< boost::any(void)>	GetterType

typedef std::function< void(boost::any)>	SetterType

typedef std::function< YAML::Node(void)>	EncoderType

typedef std::function< void(const YAML::Node *)>	DecoderType

Public Types inherited from SurgSim::Framework::FactoryBase1< DeviceInterface, std::string >
typedef ObjectFactory1< DeviceInterface, std::string >	FactoryType

Static Public Member Functions inherited from SurgSim::Framework::FactoryBase1< DeviceInterface, std::string >
static FactoryType &	getFactory ()

Protected Member Functions inherited from SurgSim::Input::CommonDevice
virtual void	pushInput ()
	Push application input to consumers.

virtual bool	pullOutput ()
	Pull application output from a producer.

DataStructures::DataGroup &	getInputData ()
	Getter for the input data DataGroup. More...

const DataStructures::DataGroup &	getOutputData () const
	Getter for the output data DataGroup. More...

Detailed Description

A class implementing the communication with Oculus Rift DK2.

Application input provided by the device:

type	name
pose	"pose"	Device pose (units are meters).
matrix	"leftProjectionMatix"	Projection matrix for left eye
matrix	"rghtProjectionMatix"	Projection matrix for right eye

Application output used by the device: none.

Note: The axes of the pose of the HMD are a right-handed system: X & Z are in the plane of the floor, with X pointing to the camera's left (i.e. to the HMD's right) and Z pointing towards the camera, while Y points up from the floor. By default the tracking origin is located one meter away from the positional tracking camera in the direction of the optical axis but with the same height as the camera.

See also: SurgSim::Input::CommonDevice, SurgSim::Input::DeviceInterface

Constructor & Destructor Documentation

§ OculusDevice()

SurgSim::Devices::OculusDevice::OculusDevice ( const std::string & name )

explicit

Constructor.

Parameters

name	A unique name for the device.

Member Function Documentation

§ getFarPlane()

float SurgSim::Devices::OculusDevice::getFarPlane ( ) const

Returns: The far plane

§ getNearPlane()

float SurgSim::Devices::OculusDevice::getNearPlane ( ) const

Returns: The near plane

§ initialize()

bool SurgSim::Devices::OculusDevice::initialize ( )

overridevirtual

Fully initialize the device.

When the manager object creates the device, the internal state of the device usually isn't fully initialized yet. This method performs any needed initialization.

Implements SurgSim::Input::DeviceInterface.

§ isInitialized()

bool SurgSim::Devices::OculusDevice::isInitialized ( ) const

overridevirtual

Returns: true if the device has been initialized and has not yet been finalized.

Implements SurgSim::Input::DeviceInterface.

§ setFarPlane()

void SurgSim::Devices::OculusDevice::setFarPlane ( float farPlane )

Set the far plane.

Parameters

farPlane The far plane

§ setNearPlane()

void SurgSim::Devices::OculusDevice::setNearPlane ( float nearPlane )

Set the near plane.

Parameters

nearPlane The near plane

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

SurgSim/Devices/Oculus/OculusDevice.h
SurgSim/Devices/Oculus/OculusDevice.cpp

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ OculusDevice()

Member Function Documentation

§ getFarPlane()

§ getNearPlane()

§ initialize()

§ isInitialized()

§ setFarPlane()

§ setNearPlane()