VTK  9.4.20241222
Public Member Functions | List of all members
vtkQuaternionf Class Reference

#include <vtkQuaternion.h>

Inheritance diagram for vtkQuaternionf:
[legend]
Collaboration diagram for vtkQuaternionf:
[legend]

Public Member Functions

 vtkQuaternionf ()=default
 
 vtkQuaternionf (float w, float x, float y, float z)
 
 vtkQuaternionf (float scalar)
 
 vtkQuaternionf (const float *init)
 
 vtkQuaternionOperatorMacro (vtkQuaternionf, float)
 
- Public Member Functions inherited from vtkQuaternion< float >
 vtkQuaternion ()
 Default constructor.
 
 vtkQuaternion (const float &scalar)
 Initialize all of the quaternion's elements with the supplied scalar.
 
 vtkQuaternion (const float *init)
 Initialize the quaternion's elements with the elements of the supplied array.
 
 vtkQuaternion (const float &w, const float &x, const float &y, const float &z)
 Initialize the quaternion element explicitly.
 
float SquaredNorm () const
 Get the squared norm of the quaternion.
 
float Norm () const
 Get the norm of the quaternion, i.e.
 
void ToIdentity ()
 Set the quaternion to identity in place.
 
float Normalize ()
 Normalize the quaternion in place.
 
vtkQuaternion< float > Normalized () const
 Return the normalized form of this quaternion.
 
void Conjugate ()
 Conjugate the quaternion in place.
 
vtkQuaternion< float > Conjugated () const
 Return the conjugate form of this quaternion.
 
void Invert ()
 Invert the quaternion in place.
 
vtkQuaternion< float > Inverse () const
 Return the inverted form of this quaternion.
 
void ToUnitLog ()
 Convert this quaternion to a unit log quaternion.
 
vtkQuaternion< float > UnitLog () const
 Return the unit log version of this quaternion.
 
void ToUnitExp ()
 Convert this quaternion to a unit exponential quaternion.
 
vtkQuaternion< float > UnitExp () const
 Return the unit exponential version of this quaternion.
 
void NormalizeWithAngleInDegrees ()
 Normalize a quaternion in place and transform it to so its angle is in degrees and its axis normalized.
 
vtkQuaternion< float > NormalizedWithAngleInDegrees () const
 Returns a quaternion normalized and transformed so its angle is in degrees and its axis normalized.
 
vtkQuaternion< CastTo > Cast () const
 Cast the quaternion to the specified type and return the result.
 
void ToMatrix3x3 (float A[3][3]) const
 Convert a quaternion to a 3x3 rotation matrix.
 
void FromMatrix3x3 (const float A[3][3])
 Convert a 3x3 matrix into a quaternion.
 
vtkQuaternion< float > Slerp (float t, const vtkQuaternion< float > &q) const
 Interpolate quaternions using spherical linear interpolation between this quaternion and q1 to produce the output.
 
vtkQuaternion< float > InnerPoint (const vtkQuaternion< float > &q1, const vtkQuaternion< float > &q2) const
 Interpolates between quaternions, using spherical quadrangle interpolation.
 
vtkQuaternion< float > operator+ (const vtkQuaternion< float > &q) const
 Performs addition of quaternion of the same basic type.
 
vtkQuaternion< float > operator- (const vtkQuaternion< float > &q) const
 Performs subtraction of quaternions of the same basic type.
 
vtkQuaternion< float > operator* (const vtkQuaternion< float > &q) const
 Performs multiplication of quaternion of the same basic type.
 
vtkQuaternion< float > operator* (const float &scalar) const
 Performs multiplication of the quaternions by a scalar value.
 
void operator*= (const float &scalar) const
 Performs in place multiplication of the quaternions by a scalar value.
 
vtkQuaternion< float > operator/ (const vtkQuaternion< float > &q) const
 Performs division of quaternions of the same type.
 
vtkQuaternion< float > operator/ (const float &scalar) const
 Performs division of the quaternions by a scalar value.
 
void Set (const float &w, const float &x, const float &y, const float &z)
 Set/Get the w, x, y and z components of the quaternion.
 
void Set (float quat[4])
 Set/Get the w, x, y and z components of the quaternion.
 
void Get (float quat[4]) const
 Set/Get the w, x, y and z components of the quaternion.
 
void SetW (const float &w)
 Set/Get the w component of the quaternion, i.e.
 
const float & GetW () const
 Set/Get the w component of the quaternion, i.e.
 
void SetX (const float &x)
 Set/Get the x component of the quaternion, i.e.
 
const float & GetX () const
 Set/Get the x component of the quaternion, i.e.
 
void SetY (const float &y)
 Set/Get the y component of the quaternion, i.e.
 
const float & GetY () const
 Set/Get the y component of the quaternion, i.e.
 
void SetZ (const float &z)
 Set/Get the y component of the quaternion, i.e.
 
const float & GetZ () const
 Set/Get the y component of the quaternion, i.e.
 
float GetRotationAngleAndAxis (float axis[3]) const
 Set/Get the angle (in radians) and the axis corresponding to the axis-angle rotation of this quaternion.
 
void SetRotationAngleAndAxis (float angle, float axis[3])
 Set/Get the angle (in radians) and the axis corresponding to the axis-angle rotation of this quaternion.
 
void SetRotationAngleAndAxis (const float &angle, const float &x, const float &y, const float &z)
 Set/Get the angle (in radians) and the axis corresponding to the axis-angle rotation of this quaternion.
 
void operator/= (const float &scalar)
 Performs in place division of the quaternions by a scalar value.
 
- Public Member Functions inherited from vtkTuple< T, Size >
 vtkTuple ()=default
 The default constructor does not initialize values.
 
 vtkTuple (const T &scalar)
 Initialize all of the tuple's elements with the supplied scalar.
 
 vtkTuple (const T *init)
 Initialize the tuple's elements with the elements of the supplied array.
 
 vtkTuple (const std::array< T, Size > &values)
 Initialize the tuple's elements using a std::array for matching type and size.
 
int GetSize () const
 Get the size of the tuple.
 
T * GetData ()
 Get a pointer to the underlying data of the tuple.
 
const T * GetData () const
 
T & operator[] (int i)
 Get a reference to the underlying data element of the tuple.
 
const T & operator[] (int i) const
 
operator() (int i) const
 Get the value of the tuple at the index specified.
 
bool Compare (const vtkTuple< T, Size > &other, const T &tol) const
 Equality operator with a tolerance to allow fuzzy comparisons.
 
template<typename TR >
vtkTuple< TR, Size > Cast () const
 Cast the tuple to the specified type, returning the result.
 

Additional Inherited Members

- Static Public Member Functions inherited from vtkQuaternion< float >
static vtkQuaternion< float > Identity ()
 Return the identity quaternion.
 
- Protected Attributes inherited from vtkTuple< T, Size >
Data [Size]
 The only thing stored in memory!
 

Detailed Description

Definition at line 393 of file vtkQuaternion.h.

Constructor & Destructor Documentation

◆ vtkQuaternionf() [1/4]

vtkQuaternionf::vtkQuaternionf ( )
default

◆ vtkQuaternionf() [2/4]

vtkQuaternionf::vtkQuaternionf ( float  w,
float  x,
float  y,
float  z 
)
inlineexplicit

Definition at line 397 of file vtkQuaternion.h.

◆ vtkQuaternionf() [3/4]

vtkQuaternionf::vtkQuaternionf ( float  scalar)
inlineexplicit

Definition at line 401 of file vtkQuaternion.h.

◆ vtkQuaternionf() [4/4]

vtkQuaternionf::vtkQuaternionf ( const float *  init)
inlineexplicit

Definition at line 405 of file vtkQuaternion.h.

Member Function Documentation

◆ vtkQuaternionOperatorMacro()

vtkQuaternionf::vtkQuaternionOperatorMacro ( vtkQuaternionf  ,
float   
)

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