HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdHoudiniHoudiniXformCommonAPI::Rotation Class Reference

#include <houdiniXformCommonAPI.h>

Public Member Functions

 Rotation ()
 
 Rotation (const GfVec3f &eulerAngles, RotationOrder order)
 
 Rotation (const GfQuatf &orient)
 Construct a quaternion orientation. More...
 
bool IsEuler () const
 Returns true if this rotation is represented as Euler angles. More...
 
bool IsOrient () const
 Returns true if this rotation is represented as a quaternion. More...
 
GfVec3f GetEulerAngles () const
 
GfVec3f GetEulerAnglesWithOrder (RotationOrder order) const
 
RotationOrder GetRotationOrder () const
 
GfQuatf GetQuaternion () const
 

Detailed Description

Represents a rotation as either Euler angles with a rotation order, or a quaternion orientation. Used by SetXformVectors(), GetXformVectors(), and SetRotate() to handle both rotation representations uniformly.

Definition at line 177 of file houdiniXformCommonAPI.h.

Constructor & Destructor Documentation

UsdHoudiniHoudiniXformCommonAPI::Rotation::Rotation ( )

Default constructor: identity Euler rotation (XYZ order, all zeros).

UsdHoudiniHoudiniXformCommonAPI::Rotation::Rotation ( const GfVec3f eulerAngles,
RotationOrder  order 
)

Construct an Euler angle rotation. eulerAngles are in degrees, packed as (X, Y, Z).

UsdHoudiniHoudiniXformCommonAPI::Rotation::Rotation ( const GfQuatf orient)
explicit

Construct a quaternion orientation.

Member Function Documentation

GfVec3f UsdHoudiniHoudiniXformCommonAPI::Rotation::GetEulerAngles ( ) const

Returns the Euler angles in degrees, converting from the quaternion if necessary.

GfVec3f UsdHoudiniHoudiniXformCommonAPI::Rotation::GetEulerAnglesWithOrder ( RotationOrder  order) const

Returns the Euler angles in degrees in a given rotation order, converting from the quaternion or alternative rotation order if necessary.

GfQuatf UsdHoudiniHoudiniXformCommonAPI::Rotation::GetQuaternion ( ) const

Returns the quaternion value, converting from the Euler angles if necessary..

RotationOrder UsdHoudiniHoudiniXformCommonAPI::Rotation::GetRotationOrder ( ) const

Returns the Euler rotation order, converting from the quaternion if necessary..

bool UsdHoudiniHoudiniXformCommonAPI::Rotation::IsEuler ( ) const
inline

Returns true if this rotation is represented as Euler angles.

Definition at line 192 of file houdiniXformCommonAPI.h.

bool UsdHoudiniHoudiniXformCommonAPI::Rotation::IsOrient ( ) const
inline

Returns true if this rotation is represented as a quaternion.

Definition at line 195 of file houdiniXformCommonAPI.h.


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