FCDExtra Class Reference

A COLLADA extra tree. More...

#include <FCDExtra.h>

Inheritance diagram for FCDExtra:

List of all members.

Public Member Functions
	FCDExtra (FCDocument *document)
	Constructor: do not use directly.
virtual	~FCDExtra ()
	Destructor: do not use directly.
FCDETechniqueList &	GetTechniques ()
	Retrieves the list of techniques contained by this extra tree.
const FCDETechniqueList &	GetTechniques () const
	See above.
size_t	GetTechniqueCount () const
	Retrieves the number of techniques contained by this extra tree.
FCDETechnique *	GetTechnique (size_t index)
	Retrieves a specific technique contained by this extra tree.
const FCDETechnique *	GetTechnique (size_t index) const
	See above.
FCDETechnique *	AddTechnique (const char *profile)
	Adds a new application-specific profile technique to the extra tree.
FCDETechnique *	AddTechnique (const string &profile)
	See above.
void	ReleaseTechnique (FCDETechnique *technique)
	Releases a technique contained within the extra tree.
FCDETechnique *	FindTechnique (const char *profile)
	Retrieves a specific technique contained by this extra tree.
const FCDETechnique *	FindTechnique (const char *profile) const
	See above.
FCDETechnique *	FindTechnique (const string &profile)
	See above.
const FCDETechnique *	FindTechnique (const string &profile) const
	See above.
FCDENode *	FindRootNode (const char *name)
	Retrieves the extra tree node that has a given element name.
const FCDENode *	FindRootNode (const char *name) const
	See above.
FCDENode *	FindRootNode (const string &name)
	See above.
const FCDENode *	FindRootNode (const string &name) const
	See above.
FUStatus	LoadFromXML (xmlNode *extraNode)
	[INTERNAL] Reads in the extra tree from a given COLLADA XML tree node.
xmlNode *	WriteToXML (xmlNode *parentNode) const
	[INTERNAL] Writes out the extra tree to the given COLLADA XML tree node.

---

Detailed Description

A COLLADA extra tree.

An extra tree contains the user-defined COLLADA information contained within <extra> elements. For this, the extra tree root simply contains a list of techniques. Each technique belongs to a different application-specific profile.

---

Constructor & Destructor Documentation

FCDExtra::FCDExtra (  FCDocument *  document  )

Constructor: do not use directly. The structures that contain extra trees will create them. Parameters: document  The COLLADA document that owns the extra tree.

virtual FCDExtra::~FCDExtra (   )  [virtual]

Destructor: do not use directly. The structures that contain extra trees will release them.

---

Member Function Documentation

FCDETechnique* FCDExtra::AddTechnique (  const char *  profile  )

Adds a new application-specific profile technique to the extra tree. If the given application-specific profile already exists within the extra tree, the old technique will be returned. Parameters: profile  The application-specific profile name. Returns: A technique for this application-specific profile.

FCDENode* FCDExtra::FindRootNode (  const char *  name  )

Retrieves the extra tree node that has a given element name. This function searches for the extra tree node within all the techniques. Parameters: name  An element name. Returns: The extra tree node that matches the element name. This pointer will be NULL if no extra tree node matches the element name.

FCDETechnique* FCDExtra::FindTechnique (  const char *  profile  )

Retrieves a specific technique contained by this extra tree. Parameters: profile  The application-specific profile name of the technique. Returns: The technique that matches the profile name. This pointer may be NULL if no technique matches the profile name.

FCDETechnique* FCDExtra::GetTechnique (  size_t  index  )  [inline]

Retrieves a specific technique contained by this extra tree. Parameters: index  The index of the technique. Returns: The technique. This pointer will be NULL if the index is out-of-bounds.

size_t FCDExtra::GetTechniqueCount (   )  const [inline]

Retrieves the number of techniques contained by this extra tree. Returns: The number of techniques.

FCDETechniqueList& FCDExtra::GetTechniques (   )  [inline]

Retrieves the list of techniques contained by this extra tree. Returns: The list of techniques.

FUStatus FCDExtra::LoadFromXML (  xmlNode *  extraNode  )

[INTERNAL] Reads in the extra tree from a given COLLADA XML tree node. Parameters: extraNode  The COLLADA <extra> element XML tree node. Returns: The status of the import. If the status is not successful, it may be dangerous to extract information from the entity.

void FCDExtra::ReleaseTechnique (  FCDETechnique *  technique  )

Releases a technique contained within the extra tree. Parameters: technique  The technique to release.

xmlNode* FCDExtra::WriteToXML (  xmlNode *  parentNode  )  const

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

---

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

• FCDocument/FCDExtra.h

---