FCDTScale Class Reference
[COLLADA Document Object Model.]

A COLLADA non-uniform scale. More...

#include <FCDTransform.h>

Inheritance diagram for FCDTScale:

List of all members.

Public Member Functions
	FCDTScale (FCDocument *document, FCDSceneNode *parent)
	Constructor: do not use directly.
virtual	~FCDTScale ()
	Destructor: do not use directly.
virtual Type	GetType () const
	Retrieves the transformation class type for the non-uniform scale.
FMVector3 &	GetScale ()
	Retrieves the factors of the non-uniform scale.
const FMVector3 &	GetScale () const
	See above.
void	SetScale (const FMVector3 &_scale)
	Sets the factors of the non-uniform scale.
void	SetScale (float x, float y, float z)
	Sets the factors of the non-uniform scale.
virtual FMMatrix44	ToMatrix () const
	Converts the non-uniform scale into a matrix.
virtual bool	IsAnimated () const
	Retrieves whether the factors of the non-uniform scale are animated.
virtual FCDAnimated *	GetAnimated ()
	Retrieves the animated element for the non-uniform scale factors.
virtual FCDTransform *	Clone (FCDSceneNode *newParent)
	Creates a copy of the non-uniform scale.
virtual FUStatus	LoadFromXML (xmlNode *scaleNode)
	[INTERNAL] Reads in the non-uniform scale from a given COLLADA XML tree node.
virtual xmlNode *	WriteToXML (xmlNode *parentNode) const
	[INTERNAL] Writes out the non-uniform scale to the given COLLADA XML tree node.

---

Detailed Description

A COLLADA non-uniform scale.

A non-uniform scale contains three scale factors.

---

Constructor & Destructor Documentation

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

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

virtual FCDTScale::~FCDTScale (   )  [virtual]

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

---

Member Function Documentation

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

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

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

Retrieves the animated element for the non-uniform scale factors. See also: FCDAnimatedPoint3 Returns: The animated element. This pointer will be NULL if the scale factors are not animated. Implements FCDTransform.

FMVector3& FCDTScale::GetScale (   )  [inline]

Retrieves the factors of the non-uniform scale. These factors may be animated. Returns: The scale factors.

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

Retrieves the transformation class type for the non-uniform scale. Returns: The class type: SCALE. Implements FCDTransform.

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

Retrieves whether the factors of the non-uniform scale are animated. Returns: Whether the scale factors are animated. Implements FCDTransform.

virtual FUStatus FCDTScale::LoadFromXML (  xmlNode *  scaleNode  )  [virtual]

[INTERNAL] Reads in the non-uniform scale from a given COLLADA XML tree node. Parameters: scaleNode  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 FCDTScale::SetScale (  float  x, float  y, float  z )  [inline]

Sets the factors of the non-uniform scale. Parameters: x  The x-component scale factor. y  The y-component scale factor. z  The z-component scale factor.

void FCDTScale::SetScale (  const FMVector3 &  _scale  )  [inline]

Sets the factors of the non-uniform scale. Parameters: _scale  The scale factors.

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

Converts the non-uniform scale into a matrix. Returns: A matrix equivalent of the non-uniform scale. Implements FCDTransform.

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

[INTERNAL] Writes out the non-uniform scale 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

---