Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

se_core::AxisAngle4 Class Reference

A 4 element axis angle represented by x,y,z,angle components. More...

#include <AxisAngle4.hpp>

List of all members.

Public Types

typedef coor_t value_type
 the type for values

Public Member Functions

 AxisAngle4 (coor_t xvalue, coor_t yvalue, coor_t zvalue, bray_t anglevalue)
 Constructs and initializes an AxisAngle4 from the specified x, y, z, and angle.
 AxisAngle4 ()
 Constructs an uninitializes AxisAngle4.
 AxisAngle4 (const Vector3 &axis, bray_t ang)
 Constructs and initializes an AxisAngle4f from the specified axis and angle.
 AxisAngle4 (const coor_t len, const Euler3 &a1)
void setIdentity ()
void set (const Vector3 &axis, bray_t ang)
 Sets the value of this AxisAngle4f to the specified axis and angle.
void set (coor_t x, coor_t y, coor_t z, bray_t angle)
 Sets the value of this axis angle to the specified x,y,z,angle.
void set (const AxisAngle4 &a1)
 Sets the value of this axis angle to the value of axis angle t1.
void set (const Quat4 &q1)
 Sets the value of this axis-angle to the rotational equivalent of the passed quaternion.
void set (const coor_t len, const bray_t yaw)
void set (const coor_t len, const bray_t yaw, const bray_t pitch)
void set (const coor_t len, const Euler3 &a1)
bool equals (const AxisAngle4 &a1) const
 Returns true if all of the data members of AxisAngle4 t1 are equal to the corresponding data members in this.
bool epsilonEquals (const AxisAngle4 &a1, coor_t epsilon, bray_t epsilonAngle=1) const
 Returns true if the L-infinite distance between this axis-angle and axis-angle t1 is less than or equal to the epsilon parameter, otherwise returns false.
bool operator== (const AxisAngle4 &m1) const
const char * toLog () const

Public Attributes

coor_t x_
 The x coordinate.
coor_t y_
 The y coordinate.
coor_t z_
 The z coordinate.
bray_t angle_
 The angle.

Protected Member Functions

void setFromQuat (coor_t x, coor_t y, coor_t z, coor_t w)

Detailed Description

A 4 element axis angle represented by x,y,z,angle components.

An axis angle is a rotation of angle (radians) about the vector (x,y,z).

Version:
specification 1.1, implementation
Revision
1.4
,
Date
1999/10/06 02:52:46
Author:
Kenji hiranabe

Definition at line 39 of file AxisAngle4.hpp.

Member Typedef Documentation

typedef coor_t se_core::AxisAngle4::value_type
 

the type for values

Definition at line 47 of file AxisAngle4.hpp.

Constructor & Destructor Documentation

se_core::AxisAngle4::AxisAngle4 (  coor_t  xvalue,
coor_t  yvalue,
coor_t  zvalue,
bray_t  anglevalue
)  [inline]
 

Constructs and initializes an AxisAngle4 from the specified x, y, z, and angle.

Parameters:
xvalue the x coordinate
yvalue the y coordinate
zvalue the z coordinate
anglevalue the angle.

Definition at line 77 of file AxisAngle4.hpp.

se_core::AxisAngle4::AxisAngle4 (   )  [inline]
 

Constructs an uninitializes AxisAngle4.

Definition at line 83 of file AxisAngle4.hpp.

se_core::AxisAngle4::AxisAngle4 (  const Vector3 &  axis,
bray_t  ang
)  [inline]
 

Constructs and initializes an AxisAngle4f from the specified axis and angle.

Parameters:
axis the axis
ang the angle
Since:
Java 3D 1.2

Definition at line 93 of file AxisAngle4.hpp.

se_core::AxisAngle4::AxisAngle4 (  const coor_t  len,
const Euler3 &  a1
)  [inline]
 

Definition at line 96 of file AxisAngle4.hpp.

Member Function Documentation

bool se_core::AxisAngle4::epsilonEquals (  const AxisAngle4 &  a1,
coor_t  epsilon,
bray_t  epsilonAngle = 1
)  const [inline]
 

Returns true if the L-infinite distance between this axis-angle and axis-angle t1 is less than or equal to the epsilon parameter, otherwise returns false.

The L-infinite distance is equal to MAX[abs(x1-x2), abs(y1-y2), abs(z1-z2), abs(angle1-angle2)].

Parameters:
a1 the axis-angle to be compared to this axis-angle
epsilon the threshold value

Definition at line 180 of file AxisAngle4.hpp.

References abs, angle_, x_, y_, and z_.

bool se_core::AxisAngle4::equals (  const AxisAngle4 &  a1  )  const [inline]
 

Returns true if all of the data members of AxisAngle4 t1 are equal to the corresponding data members in this.

Parameters:
a1 the vector with which the comparison is made.

Definition at line 169 of file AxisAngle4.hpp.

References angle_, x_, y_, and z_.

bool se_core::AxisAngle4::operator== (  const AxisAngle4 &  m1  )  const [inline]
 

Definition at line 189 of file AxisAngle4.hpp.

void se_core::AxisAngle4::set (  const coor_t  len,
const Euler3 &  a1
) 
 

Definition at line 74 of file AxisAngle4.cpp.

References se_core::Euler3::pitch_, se_core::Euler3::roll_, and se_core::Euler3::yaw_.

void se_core::AxisAngle4::set (  const coor_t  len,
const bray_t  yaw,
const bray_t  pitch
) 
 

Definition at line 64 of file AxisAngle4.cpp.

void se_core::AxisAngle4::set (  const coor_t  len,
const bray_t  yaw
) 
 

Definition at line 57 of file AxisAngle4.cpp.

void se_core::AxisAngle4::set (  const Quat4 &  q1  ) 
 

Sets the value of this axis-angle to the rotational equivalent of the passed quaternion.

Parameters:
q1 the Quat4

Definition at line 35 of file AxisAngle4.cpp.

References se_core::Tuple4::w_, se_core::Tuple4::x_, se_core::Tuple4::y_, and se_core::Tuple4::z_.

void se_core::AxisAngle4::set (  const AxisAngle4 &  a1  )  [inline]
 

Sets the value of this axis angle to the value of axis angle t1.

Parameters:
t1 the axis angle to be copied

Definition at line 139 of file AxisAngle4.hpp.

References angle_, x_, y_, and z_.

void se_core::AxisAngle4::set (  coor_t  x,
coor_t  y,
coor_t  z,
bray_t  angle
)  [inline]
 

Sets the value of this axis angle to the specified x,y,z,angle.

Parameters:
x the x coordinate
y the y coordinate
z the z coordinate
angle the angle

Definition at line 128 of file AxisAngle4.hpp.

void se_core::AxisAngle4::set (  const Vector3 &  axis,
bray_t  ang
)  [inline]
 

Sets the value of this AxisAngle4f to the specified axis and angle.

Parameters:
axis the axis
ang the angle
Since:
Java 3D 1.2

Definition at line 114 of file AxisAngle4.hpp.

References se_core::Tuple3::x_, se_core::Tuple3::y_, and se_core::Tuple3::z_.

void se_core::AxisAngle4::setFromQuat (  coor_t  x,
coor_t  y,
coor_t  z,
coor_t  w
)  [protected]
 

Definition at line 40 of file AxisAngle4.cpp.

References coor_t.

void se_core::AxisAngle4::setIdentity (   )  [inline]
 

Definition at line 101 of file AxisAngle4.hpp.

const char * se_core::AxisAngle4::toLog (   )  const
 

Definition at line 81 of file AxisAngle4.cpp.

References log_msg().

Member Data Documentation

bray_t se_core::AxisAngle4::angle_
 

The angle.

Definition at line 67 of file AxisAngle4.hpp.

Referenced by epsilonEquals(), equals(), se_core::Quat4::set(), and set().

coor_t se_core::AxisAngle4::x_
 

The x coordinate.

Definition at line 52 of file AxisAngle4.hpp.

Referenced by epsilonEquals(), equals(), se_core::Quat4::set(), and set().

coor_t se_core::AxisAngle4::y_
 

The y coordinate.

Definition at line 57 of file AxisAngle4.hpp.

Referenced by epsilonEquals(), equals(), se_core::Quat4::set(), and set().

coor_t se_core::AxisAngle4::z_
 

The z coordinate.

Definition at line 62 of file AxisAngle4.hpp.

Referenced by epsilonEquals(), equals(), se_core::Quat4::set(), and set().

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

Home Page | SagaEngine trunk (updated nightly) reference generated Sun Dec 2 20:06:31 2007 by Doxygen version 1.3.9.1.

SourceForge.net Logo