OgreHaptics::ForceOutput Class Reference

ForceOutput is a simple structure holding data that will be output by a Device. More...

#include <OgreHapticsForceOutput.h>

List of all members.

Public Member Functions
	ForceOutput ()
	Standard constructor.
	ForceOutput (const Vector3 &f, const Vector3 &t)
	Creates and initialises a new instance with the given force and torque.
virtual	~ForceOutput ()
	Virtual destructor.
ForceOutput &	operator= (const ForceOutput &rhs)
	Assigns the value of the other force output.
ForceOutput	operator+ (const ForceOutput &rhs)
ForceOutput	operator* (const Real scalar)
ForceOutput &	operator+= (const ForceOutput &rhs)
ForceOutput &	operator*= (const Real scalar)
void	clear (void)
	Sets both the force and torque of the ouput to Ogre::Vector3::ZERO.
Public Attributes
Vector3	force
	The force in N in device workspace coordinates that will be output.
Vector3	torque
	The torque in N/mm in device workspace coordinates that will be output.
Friends
ForceOutput	operator* (const ForceOutput &lhs, const Real scalar)

---

Detailed Description

ForceOutput is a simple structure holding data that will be output by a Device.

Remarks:

This class implements arithmetic operations and updates to combine forces and torques together to be sent to a device.

Definition at line 38 of file OgreHapticsForceOutput.h.

---

Constructor & Destructor Documentation

OgreHaptics::ForceOutput::ForceOutput

(

)

Standard constructor.

Definition at line 42 of file OgreHapticsForceOutput.h.

OgreHaptics::ForceOutput::ForceOutput	(	const Vector3 &	f,
		const Vector3 &	t
	)

Creates and initialises a new instance with the given force and torque.

Parameters:

	f	The force to be output in device workspace coordinates.
	t	The torque to be output in device workspace coordinates.

Definition at line 52 of file OgreHapticsForceOutput.h.

virtual OgreHaptics::ForceOutput::~ForceOutput

(

)

[virtual]

Virtual destructor.

Definition at line 58 of file OgreHapticsForceOutput.h.

---

Member Function Documentation

ForceOutput& OgreHaptics::ForceOutput::operator=

(

const ForceOutput &

rhs

)

Assigns the value of the other force output.

Definition at line 61 of file OgreHapticsForceOutput.h.

References force, and torque.

ForceOutput OgreHaptics::ForceOutput::operator+

(

const ForceOutput &

rhs

)

Definition at line 69 of file OgreHapticsForceOutput.h.

References force, and torque.

ForceOutput OgreHaptics::ForceOutput::operator*

(

const Real

scalar

)

Definition at line 74 of file OgreHapticsForceOutput.h.

ForceOutput& OgreHaptics::ForceOutput::operator+=

(

const ForceOutput &

rhs

)

Definition at line 80 of file OgreHapticsForceOutput.h.

References force, and torque.

ForceOutput& OgreHaptics::ForceOutput::operator*=

(

const Real

scalar

)

Definition at line 87 of file OgreHapticsForceOutput.h.

void OgreHaptics::ForceOutput::clear

(

void

)

Sets both the force and torque of the ouput to Ogre::Vector3::ZERO.

Definition at line 102 of file OgreHapticsForceOutput.h.

---

Friends And Related Function Documentation

ForceOutput operator*	(	const ForceOutput &	lhs,
		const Real	scalar
	)			[friend]

Definition at line 95 of file OgreHapticsForceOutput.h.

---

Member Data Documentation

Vector3 OgreHaptics::ForceOutput::force

The force in N in device workspace coordinates that will be output.

Definition at line 109 of file OgreHapticsForceOutput.h.

Referenced by operator+(), operator+=(), and operator=().

Vector3 OgreHaptics::ForceOutput::torque

The torque in N/mm in device workspace coordinates that will be output.

Definition at line 111 of file OgreHapticsForceOutput.h.

Referenced by operator+(), operator+=(), and operator=().

---

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

• OgreHapticsForceOutput.h