vtTransform Class Reference
[Scene Graph]

Inheritance diagram for vtTransform:

[legend]List of all members.

---

Detailed Description

A Transform node allows you to apply a transform (scale, rotate, translate) to all its child nodes.

Public Member Functions
void	Release ()
void	Identity ()
void	SetTrans (const FPoint3 &pos)
FPoint3	GetTrans () const
void	Translate1 (const FPoint3 &pos)
void	TranslateLocal (const FPoint3 &pos)
void	Rotate2 (const FPoint3 &axis, double angle)
void	RotateLocal (const FPoint3 &axis, double angle)
void	RotateParent (const FPoint3 &axis, double angle)
FQuat	GetOrient () const
FPoint3	GetDirection () const
void	SetDirection (const FPoint3 &point, bool bPitch=true)
void	Scale3 (float x, float y, float z)
void	SetTransform1 (const FMatrix4 &mat)
void	GetTransform1 (FMatrix4 &mat) const
void	PointTowards (const FPoint3 &point, bool bPitch=true)

---

Member Function Documentation

FPoint3 vtTransform::GetDirection (   )  const [virtual]

Get the direction, which by convention is shorthand for the -Z axis of the local frame. For oriented objects such as the camera, this is the direction the object is facing. Implements vtTransformBase.

FQuat vtTransform::GetOrient (   )  const

Get the orientation (rotate relative to default) of the transform

FPoint3 vtTransform::GetTrans (   )  const [virtual]

Get the translation component of the transform Implements vtTransformBase.

void vtTransform::GetTransform1 (  FMatrix4 &  mat  )  const [virtual]

Get the entire transform as a 4x4 matrix. Implements vtTransformBase.

void vtTransform::Identity (   )  [virtual]

Set this transform to identity (no scale, rotation, or translation). Implements vtTransformBase.

void vtTransform::PointTowards (  const FPoint3 &  point, bool  bPitch = true )

Rotate the object such that it points toward a given point. By convention, this means that the object's -Z axis points in the desired direction.

void vtTransform::Release (   )  [virtual]

Releases a node. Use this method instead of C++'s delete operator when you are done with a node. Internally, the node is reference counted so it is not deleted until all references to it are removed. Reimplemented from vtGroup.

void vtTransform::Rotate2 (  const FPoint3 &  axis, double  angle )  [virtual]

Rotate around a given axis by a given angle, in radians. Implements vtTransformBase.

void vtTransform::RotateLocal (  const FPoint3 &  axis, double  angle )  [virtual]

Similar to Rotate2, but operates in the local frame of reference. Implements vtTransformBase.

void vtTransform::RotateParent (  const FPoint3 &  axis, double  angle )  [virtual]

Similar to Rotate2, but the rotation occurs in the parent's frame of reference. Implements vtTransformBase.

void vtTransform::Scale3 (  float  x, float  y, float  z )  [virtual]

Scale (stretch) by given factors in the x,y,z dimensions. Implements vtTransformBase.

void vtTransform::SetDirection (  const FPoint3 &  point, bool  bPitch = true )

Set the direction, which by convention is shorthand for the -Z axis of the local frame. For oriented objects such as the camera, this is the direction the object is facing.

void vtTransform::SetTrans (  const FPoint3 &  pos  )  [virtual]

Set the translation component of the transform Implements vtTransformBase.

void vtTransform::SetTransform1 (  const FMatrix4 &  mat  )  [virtual]

Set the entire transform with a 4x4 matrix. Implements vtTransformBase.

void vtTransform::Translate1 (  const FPoint3 &  pos  )  [virtual]

Apply a relative offset (translation) to the transform, in the frame of its parent. Implements vtTransformBase.

void vtTransform::TranslateLocal (  const FPoint3 &  pos  )  [virtual]

Apply a relative offset (translation) to the transform, in its own frame of reference. Implements vtTransformBase.

---