FCDAnimationChannel Class Reference
[COLLADA Document Object Model.]

A COLLADA animation channel. More...

#include <FCDAnimationChannel.h>

Inheritance diagram for FCDAnimationChannel:

List of all members.

Public Member Functions
	FCDAnimationChannel (FCDocument *document, FCDAnimation *parent)
	Constructor: do not use directly.
virtual	~FCDAnimationChannel ()
	Destructor: do not use directly.
FCDAnimation *	GetParent ()
	Retrieves the animation sub-tree that contains the animation channel.
const FCDAnimation *	GetParent () const
	See above.
const FCDAnimationCurveList &	GetCurves () const
	Retrieves the list of animation curves contained within the channel.
size_t	GetCurveCount () const
	Retrieves the number of animation curves contained within the channel.
FCDAnimationCurve *	GetCurve (size_t index)
	Retrieves an animation curve contained within the channel.
const FCDAnimationCurve *	GetCurve (size_t index) const
	See above.
FCDAnimationCurve *	AddCurve ()
	Adds a new animation curve to this animation channel.
void	ReleaseCurve (FCDAnimationCurve *curve)
	Releases an animation curve contained within this channel.
const string &	GetTargetPointer () const
	[INTERNAL] Retrieves the target pointer prefix for this animation channel.
const string &	GetTargetQualifier () const
	[INTERNAL] Retrieves the target qualifier for this animation channel.
void	SetTargetPointer (const string &p)
	[INTERNAL] Enforces the tarrget pointer prefix for the animation channel.
bool	LinkDriver (FCDAnimated *animated)
	[INTERNAL] Considers the given animated element as the driver for this animation channel.
FUStatus	CheckDriver ()
	[INTERNAL] Verifies that if a driver is used by this channel, then it was found during the import of the animated elements.
FUStatus	LoadFromXML (xmlNode *channelNode)
	[INTERNAL] Reads in the animation channel from a given COLLADA XML tree node.
void	WriteToXML (xmlNode *parentNode) const
	[INTERNAL] Writes out the animation channel to the given COLLADA XML tree node.

---

Detailed Description

A COLLADA animation channel.

Each animation channel holds the animation curves for one animatable element, such as a single floating-point value, a 3D vector or a matrix.

See also:

FCDAnimated

---

Constructor & Destructor Documentation

FCDAnimationChannel::FCDAnimationChannel (  FCDocument *  document, FCDAnimation *  parent )

Constructor: do not use directly. Instead, call the FCDAnimation::AddChannel function. Parameters: document  The COLLADA document that owns the animation channel. parent  The animation sub-tree that contains the animation channel.

virtual FCDAnimationChannel::~FCDAnimationChannel (   )  [virtual]

Destructor: do not use directly. Instead, call the FCDAnimation::ReleaseChannel function.

---

Member Function Documentation

FCDAnimationCurve* FCDAnimationChannel::AddCurve (   )

Adds a new animation curve to this animation channel. Returns: The new animation curve.

FUStatus FCDAnimationChannel::CheckDriver (   )

[INTERNAL] Verifies that if a driver is used by this channel, then it was found during the import of the animated elements. Returns: The status of the verification.

FCDAnimationCurve* FCDAnimationChannel::GetCurve (  size_t  index  )  [inline]

Retrieves an animation curve contained within the channel. Parameters: index  The index of the animation curve. Returns: The animation curve at the given index. This pointer will be NULL if the index is out-of-bounds.

size_t FCDAnimationChannel::GetCurveCount (   )  const [inline]

Retrieves the number of animation curves contained within the channel. Returns: The number of animation curves.

const FCDAnimationCurveList& FCDAnimationChannel::GetCurves (   )  const [inline]

Retrieves the list of animation curves contained within the channel. Returns: The list of animation curves.

FCDAnimation* FCDAnimationChannel::GetParent (   )  [inline]

Retrieves the animation sub-tree that contains the animation channel. Returns: The parent animation sub-tree.

const string& FCDAnimationChannel::GetTargetPointer (   )  const [inline]

[INTERNAL] Retrieves the target pointer prefix for this animation channel. This function is used during the import of a COLLADA document to match the target pointer prefixes with the animated elements. Returns: The target pointer prefix.

const string& FCDAnimationChannel::GetTargetQualifier (   )  const [inline]

[INTERNAL] Retrieves the target qualifier for this animation channel. This function is used during the import of a COLLADA document. Where there is a target qualifier, there should be only one curve contained by the channel. Returns: The target qualifier. This value may be the empty string if the channel targets all the values targeted by the target pointer prefix.

bool FCDAnimationChannel::LinkDriver (  FCDAnimated *  animated  )

[INTERNAL] Considers the given animated element as the driver for this animation channel. Parameters: animated  An animated element. Returns: Whether the animated element is in fact the driver for the animation channel.

FUStatus FCDAnimationChannel::LoadFromXML (  xmlNode *  channelNode  )

[INTERNAL] Reads in the animation channel from a given COLLADA XML tree node. Parameters: channelNode  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 animation channel.

void FCDAnimationChannel::ReleaseCurve (  FCDAnimationCurve *  curve  )

Releases an animation curve contained within this channel. Todo: This function is not yet implemented, as it requires a lot more memory management than FCollada currently does. Parameters: curve  The animation curve to release.

void FCDAnimationChannel::SetTargetPointer (  const string &  p  )  [inline]

[INTERNAL] Enforces the tarrget pointer prefix for the animation channel. This function is used during the export of a COLLADA document. Parameters: p  The new target pointer prefix.

void FCDAnimationChannel::WriteToXML (  xmlNode *  parentNode  )  const

[INTERNAL] Writes out the animation channel to the given COLLADA XML tree node. Parameters: parentNode  The COLLADA XML parent node in which to insert the animation channel. Returns: The created element XML tree node.

---

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

• FCDocument/FCDAnimationChannel.h

---