CFx SDK Documentation  2022 SP0
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
OdGeQuaternion Class Reference

#include <GeQuaternion.h>

Public Member Functions

 OdGeQuaternion ()
 
 OdGeQuaternion (double ww, double xx, double yy, double zz)
 
OdGeQuaternionset (double ww, double xx, double yy, double zz)
 
OdGeQuaternionset (const OdGeMatrix3d &matrix)
 
OdGeMatrix3d getMatrix () const
 
OdGePoint3d rotate (OdGePoint3d &sourcePoint) const
 
OdGeVector3d rotate (OdGeVector3d &vector) const
 
bool isEqualTo (const OdGeQuaternion &quat, const OdGeTol &tol=OdGeContext::gTol) const
 
bool operator== (const OdGeQuaternion &quat) const
 
bool operator!= (const OdGeQuaternion &quat) const
 

Public Attributes

double w
 
double x
 
double y
 
double z
 

Static Public Attributes

static GE_STATIC_EXPORT const OdGeQuaternion kOrigin
 

Detailed Description

This class represents a rotation quaternion in 3D space.

Remarks
OdGeQuaternion may be viewed as an array[4] of doubles.

Corresponding C++ library: TD_Ge

<group OdGe_Classes>

Definition at line 45 of file GeQuaternion.h.

Constructor & Destructor Documentation

◆ OdGeQuaternion() [1/2]

OdGeQuaternion::OdGeQuaternion ( )
inline

Quaternions are used to specify the rotations necessary for 3d planar orientation. It stores 4 Double variables w, x, y, and z.

Remarks
When called with no arguments, constructs a zero quaternion.

Definition at line 57 of file GeQuaternion.h.

◆ OdGeQuaternion() [2/2]

OdGeQuaternion::OdGeQuaternion ( double  ww,
double  xx,
double  yy,
double  zz 
)
inline

Definition at line 61 of file GeQuaternion.h.

Member Function Documentation

◆ getMatrix()

OdGeMatrix3d OdGeQuaternion::getMatrix ( ) const
inline

Definition at line 113 of file GeQuaternion.h.

◆ isEqualTo()

bool OdGeQuaternion::isEqualTo ( const OdGeQuaternion quat,
const OdGeTol tol = OdGeContext::gTol 
) const
inline

Returns true if and only if quat is identical to this quaternion, within the specified tolerance.

Parameters
quat[in] Any quaternion.
tol[in] Geometric tolerance.

Definition at line 153 of file GeQuaternion.h.

◆ operator!=()

bool OdGeQuaternion::operator!= ( const OdGeQuaternion quat) const
inline

Definition at line 167 of file GeQuaternion.h.

◆ operator==()

bool OdGeQuaternion::operator== ( const OdGeQuaternion quat) const
inline

Definition at line 163 of file GeQuaternion.h.

◆ rotate() [1/2]

OdGePoint3d OdGeQuaternion::rotate ( OdGePoint3d sourcePoint) const
inline

Definition at line 132 of file GeQuaternion.h.

◆ rotate() [2/2]

OdGeVector3d OdGeQuaternion::rotate ( OdGeVector3d vector) const
inline

Definition at line 139 of file GeQuaternion.h.

◆ set() [1/2]

OdGeQuaternion& OdGeQuaternion::set ( const OdGeMatrix3d matrix)
inline

Definition at line 75 of file GeQuaternion.h.

◆ set() [2/2]

OdGeQuaternion& OdGeQuaternion::set ( double  ww,
double  xx,
double  yy,
double  zz 
)
inline

Definition at line 66 of file GeQuaternion.h.

Member Data Documentation

◆ kOrigin

GE_STATIC_EXPORT const OdGeQuaternion OdGeQuaternion::kOrigin
static

Definition at line 177 of file GeQuaternion.h.

◆ w

double OdGeQuaternion::w

Definition at line 172 of file GeQuaternion.h.

◆ x

double OdGeQuaternion::x

Definition at line 173 of file GeQuaternion.h.

◆ y

double OdGeQuaternion::y

Definition at line 174 of file GeQuaternion.h.

◆ z

double OdGeQuaternion::z

Definition at line 175 of file GeQuaternion.h.


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