libalmath  2.5.7.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | List of all members
AL::Math::Displacement Struct Reference

Struct composed of a Position3D and a Quaternion More...

#include <aldisplacement.h>

Public Member Functions

 Displacement ()
 Create a Displacement initialized with default values More...
 
 Displacement (const Position3D &pos3d, const Quaternion &quat=Quaternion())
 Create a Displacement with the given Position3D and Quaternion More...
 
Displacementoperator*= (const Displacement &pDisp)
 Defining composition of Displacement with * sign More...
 
Displacement operator* (const Displacement &pDisp)
 Define the binary operation of a composition of Displacements. More...
 
bool isNear (const Displacement &pDisp2, const float pEpsilon=0.0001f) const
 Check if the current Displacement is Near the one given in argument. More...
 

Public Attributes

Position3D P
 Translation of the Displacement More...
 
Quaternion Q
 Rotation of the Displacement More...
 

Detailed Description

Struct composed of a Position3D and a Quaternion

Definition at line 21 of file aldisplacement.h.

Constructor & Destructor Documentation

AL::Math::Displacement::Displacement ( )
explicit

Create a Displacement initialized with default values

AL::Math::Displacement::Displacement ( const Position3D pos3d,
const Quaternion quat = Quaternion() 
)

Create a Displacement with the given Position3D and Quaternion

Parameters
pos3dthe pose of the created Displacement
quatthe rotation of the created Displacement - default: identity

Member Function Documentation

bool AL::Math::Displacement::isNear ( const Displacement pDisp2,
const float  pEpsilon = 0.0001f 
) const

Check if the current Displacement is Near the one given in argument.

Parameters
pDisp2the second Displacement
pEpsilonan optional epsilon distance
Returns
true if the distance between the two Displacement is less than pEpsilon
Displacement AL::Math::Displacement::operator* ( const Displacement pDisp)

Define the binary operation of a composition of Displacements.

Parameters
pDispsecond operand of the composition
Returns
The resulting Displacement
Displacement& AL::Math::Displacement::operator*= ( const Displacement pDisp)

Defining composition of Displacement with * sign

Parameters
pDispthe displacement that is composed with the current displacement
Returns
The composed Displacement

Member Data Documentation

Position3D AL::Math::Displacement::P

Translation of the Displacement

Definition at line 24 of file aldisplacement.h.

Quaternion AL::Math::Displacement::Q

Rotation of the Displacement

Definition at line 26 of file aldisplacement.h.


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