FCDTSkew Class Reference
[COLLADA Document Object Model.]

A COLLADA skew. More...

#include <FCDTransform.h>

Inheritance diagram for FCDTSkew:

List of all members.

Public Member Functions
	FCDTSkew (FCDocument *document, FCDSceneNode *parent)
	Constructor: do not use directly.
virtual	~FCDTSkew ()
	Destructor: do not use directly.
virtual Type	GetType () const
	Retrieves the transformation class type for the transformation.
const FMVector3 &	GetRotateAxis () const
	Retrieves the axis which is rotated.
void	SetRotateAxis (const FMVector3 &axis)
	Sets the axis which is rotated.
const FMVector3 &	GetAroundAxis () const
	Retrieves the axis around which the rotation is done.
void	SetAroundAxis (const FMVector3 &axis)
	Sets the axis around which the rotation is done.
const float &	GetAngle ()
	Retrieves the rotation angle.
void	SetAngle (float _angle)
	Sets the rotation angle.
virtual FMMatrix44	ToMatrix () const
	Converts the skew into a matrix.
virtual bool	IsAnimated () const
	Retrieves whether the transformation is animated.
virtual FCDAnimated *	GetAnimated ()
	Retrieves the animated element for the skew.
virtual FCDTransform *	Clone (FCDSceneNode *newParent)
	Creates a copy of the skew.
virtual FUStatus	LoadFromXML (xmlNode *skewNode)
	[INTERNAL] Reads in the skew from a given COLLADA XML tree node.
virtual xmlNode *	WriteToXML (xmlNode *parentNode) const
	[INTERNAL] Writes out the skew to the given COLLADA XML tree node.

---

Detailed Description

A COLLADA skew.

In COLLADA, the skew transformation follows the Renderman convention. A skew is defined by two axis and one angle: the axis which is rotated, the axis around which the rotation is done and the angle of the rotation.

---

Constructor & Destructor Documentation

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

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

virtual FCDTSkew::~FCDTSkew (   )  [virtual]

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

---

Member Function Documentation

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

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

const float& FCDTSkew::GetAngle (   )  [inline]

Retrieves the rotation angle. Returns: The rotation angle.

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

Retrieves the animated element for the skew. Returns: FCollada doesn't support animated skews: NULL. Implements FCDTransform.

const FMVector3& FCDTSkew::GetAroundAxis (   )  const [inline]

Retrieves the axis around which the rotation is done. Returns: The rotation axis.

const FMVector3& FCDTSkew::GetRotateAxis (   )  const [inline]

Retrieves the axis which is rotated. Returns: The rotated axis.

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

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

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

Retrieves whether the transformation is animated. Returns: FCollada doesn't support animated skews: false. Implements FCDTransform.

virtual FUStatus FCDTSkew::LoadFromXML (  xmlNode *  skewNode  )  [virtual]

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

void FCDTSkew::SetAngle (  float  _angle  )  [inline]

Sets the rotation angle. Parameters: _angle  The rotation angle.

void FCDTSkew::SetAroundAxis (  const FMVector3 &  axis  )  [inline]

Sets the axis around which the rotation is done. Parameters: axis  The rotation axis.

void FCDTSkew::SetRotateAxis (  const FMVector3 &  axis  )  [inline]

Sets the axis which is rotated. Parameters: axis  The rotated axis.

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

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

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

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

---

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

• FCDocument/FCDTransform.h

---