FCDTTranslation Class Reference
[COLLADA Document Object Model.]

A COLLADA translation. More...

#include <FCDTransform.h>

Inheritance diagram for FCDTTranslation:

List of all members.

Public Member Functions
	FCDTTranslation (FCDocument *document, FCDSceneNode *parent)
	Constructor: do not use directly.
virtual	~FCDTTranslation ()
	Destructor: do not use directly.
virtual Type	GetType () const
	Retrieves the transformation class type for the translation.
FMVector3 &	GetTranslation ()
	Retrieves the translation 3D displacement vector.
const FMVector3 &	GetTranslation () const
	See above.
void	SetTranslation (const FMVector3 &_translation)
	Sets the translation 3D displacement vector.
void	SetTranslation (float x, float y, float z)
	Sets the translation 3D displacement vector.
virtual FMMatrix44	ToMatrix () const
	Converts the translation into a matrix.
virtual bool	IsAnimated () const
	Retrieves whether this translation is affected by an animation.
virtual FCDAnimated *	GetAnimated ()
	Retrieves the animated element for the translation.
virtual bool	IsInverse (const FCDTransform *transform) const
	Retrieves whether a given transform is the exact opposite of this translation.
virtual FCDTransform *	Clone (FCDSceneNode *newParent)
	Creates a copy of the translation.
virtual FUStatus	LoadFromXML (xmlNode *translationNode)
	[INTERNAL] Reads in the translation from a given COLLADA XML tree node.
virtual xmlNode *	WriteToXML (xmlNode *parentNode) const
	[INTERNAL] Writes out the translation to the given COLLADA XML tree node.

---

Detailed Description

A COLLADA translation.

A translation is a simple 3D displacement.

---

Constructor & Destructor Documentation

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

Constructor: do not use directly. Instead, use the FCDSceneNode::AddTransform function with the TRANSLATION transformation type. Parameters: document  The COLLADA document that owns the translation. parent  The visual scene node that contains the translation. Set this pointer to NULL if the translation is not owned by a visual scene node.

virtual FCDTTranslation::~FCDTTranslation (   )  [virtual]

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

---

Member Function Documentation

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

Creates a copy of the translation. Parameters: newParent  The visual scene node that will contain the clone. Returns: The cloned translation. Implements FCDTransform.

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

Retrieves the animated element for the translation. See also: FCDAnimatedPoint3 Returns: The animated element. This pointer will be NULL if the translation is not animated. Implements FCDTransform.

FMVector3& FCDTTranslation::GetTranslation (   )  [inline]

Retrieves the translation 3D displacement vector. This displacement vector may be animated. Returns: The displacement vector.

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

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

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

Retrieves whether this translation is affected by an animation. Returns: Whether the translation is animated. Implements FCDTransform.

virtual bool FCDTTranslation::IsInverse (  const FCDTransform *  transform  )  const [virtual]

Retrieves whether a given transform is the exact opposite of this translation. The opposite of a translation has a displacement vector with all the components multiplied by -1. Parameters: transform  A second transformation. Returns: Whether the two transformations are opposites. Reimplemented from FCDTransform.

virtual FUStatus FCDTTranslation::LoadFromXML (  xmlNode *  translationNode  )  [virtual]

[INTERNAL] Reads in the translation from a given COLLADA XML tree node. Parameters: translationNode  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 translation. Implements FCDTransform.

void FCDTTranslation::SetTranslation (  float  x, float  y, float  z )  [inline]

Sets the translation 3D displacement vector. Parameters: x  The x-component displacement. y  The y-component displacement. z  The z-component displacement.

void FCDTTranslation::SetTranslation (  const FMVector3 &  _translation  )  [inline]

Sets the translation 3D displacement vector. Parameters: _translation  The displacement vector.

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

Converts the translation into a matrix. Returns: A matrix equivalent of the translation. Implements FCDTransform.

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

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

---

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

• FCDocument/FCDTransform.h

---