FCDTLookAt Class Reference

A COLLADA 'look-at' transformation. More...

#include <FCDTransform.h>

Inheritance diagram for FCDTLookAt:

List of all members.

Public Member Functions
	FCDTLookAt (FCDocument *document, FCDSceneNode *parent)
	Constructor: do not use directly.
virtual	~FCDTLookAt ()
	Destructor: do not use directly.
virtual Type	GetType () const
	Retrieves the transformation class type for the transformation.
FMVector3 &	GetPosition ()
	Retrieves the viewer's position.
const FMVector3 &	GetPosition () const
	See above.
void	SetPosition (const FMVector3 &pos)
	Sets the viewer's position.
void	SetPosition (float x, float y, float z)
	Sets the viewer's position.
FMVector3 &	GetTarget ()
	Retrieves the position that the viewer is looking at.
const FMVector3 &	GetTarget () const
	See above.
void	SetTarget (const FMVector3 &_target)
	Sets the position that the viewer is looking at.
void	SetTarget (float x, float y, float z)
	Sets the position that the viewer is looking at.
FMVector3 &	GetUp ()
	Retrieves the viewer's up-vector.
const FMVector3 &	GetUp () const
	See above.
void	SetUp (const FMVector3 &_up)
	Sets the viewer's up-vector.
void	SetUp (float x, float y, float z)
	Sets the viewer's up-vector.
virtual FMMatrix44	ToMatrix () const
	Converts the transformation into a matrix.
virtual bool	IsAnimated () const
	Retrieves whether the transformation is animated.
virtual FCDAnimated *	GetAnimated ()
	Retrieves the animated element for the transformation matrix.
virtual FCDTransform *	Clone (FCDSceneNode *newParent)
	Creates a copy of the transformation.
virtual FUStatus	LoadFromXML (xmlNode *lookAtNode)
	[INTERNAL] Reads in the transformation from a given COLLADA XML tree node.
virtual xmlNode *	WriteToXML (xmlNode *parentNode) const
	[INTERNAL] Writes out the transformation to the given COLLADA XML tree node.

---

Detailed Description

A COLLADA 'look-at' transformation.

This transformation type fully defines a position and an orientation with a 3D world by using three 3D vectors: the viewer's position, the position that the viewer is looking at, and the up-vector for camera rolls.

---

Constructor & Destructor Documentation

FCDTLookAt::FCDTLookAt (  FCDocument *  document, FCDSceneNode *  parent )

Constructor: do not use directly. Instead, use the FCDSceneNode::AddTransform function with the transformation type: LOOKAT. Parameters: document  The COLLADA document that owns the transformation. parent  The visual scene node that contains the transformation.

virtual FCDTLookAt::~FCDTLookAt (   )  [virtual]

Destructor: do not use directly. Instead, use the FCDSceneNode::ReleaseTransform function.

---

Member Function Documentation

virtual FCDTransform* FCDTLookAt::Clone (  FCDSceneNode *  newParent  )  [virtual]

Creates a copy of the transformation. Parameters: newParent  The visual scene node that will contain the clone. Returns: The cloned 'look-at' transformation. Implements FCDTransform.

virtual FCDAnimated* FCDTLookAt::GetAnimated (   )  [virtual]

Retrieves the animated element for the transformation matrix. Returns: FCollada doesn't support animated 'look-at' transforms: NULL. Implements FCDTransform.

FMVector3& FCDTLookAt::GetPosition (   )  [inline]

Retrieves the viewer's position. See also: FCDAnimatedPoint3 Returns: The viewer's position.

FMVector3& FCDTLookAt::GetTarget (   )  [inline]

Retrieves the position that the viewer is looking at. See also: FCDAnimatedPoint3 Returns: The viewer's target.

virtual Type FCDTLookAt::GetType (   )  const [inline, virtual]

Retrieves the transformation class type for the transformation. Returns: The class type: LOOKAT. Implements FCDTransform.

FMVector3& FCDTLookAt::GetUp (   )  [inline]

Retrieves the viewer's up-vector. See also: FCDAnimatedPoint3 Returns: The up-vector.

virtual bool FCDTLookAt::IsAnimated (   )  const [virtual]

Retrieves whether the transformation is animated. Returns: FCollada doesn't support animated 'look-at' transforms: false. Implements FCDTransform.

virtual FUStatus FCDTLookAt::LoadFromXML (  xmlNode *  lookAtNode  )  [virtual]

[INTERNAL] Reads in the transformation from a given COLLADA XML tree node. Parameters: lookAtNode  The COLLADA XML tree node. Returns: The status of the import. If the status is not successful, it may be dangerous to extract information from the transformation. Implements FCDTransform.

void FCDTLookAt::SetPosition (  float  x, float  y, float  z )  [inline]

Sets the viewer's position. Parameters: x  The x-component of the position. y  The y-component of the position. z  The z-component of the position.

void FCDTLookAt::SetPosition (  const FMVector3 &  pos  )  [inline]

Sets the viewer's position. Parameters: pos  The viewer's position.

void FCDTLookAt::SetTarget (  float  x, float  y, float  z )  [inline]

Sets the position that the viewer is looking at. Parameters: x  The x-component of the target position. y  The y-component of the target position. z  The z-component of the target position.

void FCDTLookAt::SetTarget (  const FMVector3 &  _target  )  [inline]

Sets the position that the viewer is looking at. Parameters: _target  The target position.

void FCDTLookAt::SetUp (  float  x, float  y, float  z )  [inline]

Sets the viewer's up-vector. Parameters: x  The x-component of the up-vector. y  The y-component of the up-vector. z  The z-component of the up-vector.

void FCDTLookAt::SetUp (  const FMVector3 &  _up  )  [inline]

Sets the viewer's up-vector. Parameters: _up  The up-vector.

virtual FMMatrix44 FCDTLookAt::ToMatrix (   )  const [virtual]

Converts the transformation into a matrix. Returns: The transformation matrix. Implements FCDTransform.

virtual xmlNode* FCDTLookAt::WriteToXML (  xmlNode *  parentNode  )  const [virtual]

[INTERNAL] Writes out the transformation to the given COLLADA XML tree node. Parameters: parentNode  The COLLADA XML parent node in which to insert the transformation. Returns: The created XML tree node. Implements FCDTransform.

---

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

• FCDocument/FCDTransform.h

---