FCDMaterialInstance Class Reference
[COLLADA Document Object Model.]

A COLLADA material instance. More...

#include <FCDMaterialInstance.h>

Inheritance diagram for FCDMaterialInstance:

List of all members.

Public Member Functions
	FCDMaterialInstance (FCDocument *document, FCDGeometryInstance *parent)
virtual Type	GetType () const
	Retrieves the entity instance class type.
const fstring &	GetSemantic () const
void	SetSemantic (const fchar *_semantic)
void	SetSemantic (const fstring &_semantic)
FCDMaterial *	GetMaterial ()
const FCDMaterial *	GetMaterial () const
void	SetMaterial (FCDMaterial *_material)
FCDMaterialInstanceBindList &	GetBindings ()
const FCDMaterialInstanceBindList &	GetBindings () const
size_t	GetBindingCount () const
FCDMaterialInstanceBind *	GetBinding (size_t index)
const FCDMaterialInstanceBind *	GetBinding (size_t index) const
FCDMaterialInstanceBind *	AddBinding ()
FCDMaterialInstanceBind *	AddBinding (const char *semantic, const char *target)
FCDMaterialInstanceBind *	AddBinding (const string &semantic, const char *target)
FCDMaterialInstanceBind *	AddBinding (const char *semantic, const string &target)
FCDMaterialInstanceBind *	AddBinding (const string &semantic, const string &target)
void	ReleaseBinding (size_t index)
FCDMaterial *	FlattenMaterial ()
	Creates a flattened version of the instantiated material.
virtual FUStatus	LoadFromXML (xmlNode *instanceNode)
FUStatus	LoadFromId (const string &materialId)
xmlNode *	WriteToXML (xmlNode *parentNode) const
	[INTERNAL] Writes out the entity instance to the given COLLADA XML tree node.

---

Detailed Description

A COLLADA material instance.

A material instance is used to given polygon sets with a COLLADA material entity. It is also used to bind data sources with the inputs of an effect.

---

Member Function Documentation

FCDMaterial* FCDMaterialInstance::FlattenMaterial (   )

Creates a flattened version of the instantiated material. This is the prefered way to generate viewer materials from a COLLADA document. Returns: The flattened version of the instantiated material. You will need to delete this pointer manually. This pointer will be NULL when there is no material attached to this instance.

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

Retrieves the entity instance class type. This is used to determine the up-class for the entity instance object. Returns: The class type: SIMPLE for entity instances with no up-class. Reimplemented from FCDEntityInstance.

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

[INTERNAL] Writes out the entity instance to the given COLLADA XML tree node. Parameters: parentNode  The COLLADA XML parent node in which to insert the node. Returns: The created XML tree node. Reimplemented from FCDEntityInstance.

---

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

• FCDocument/FCDMaterialInstance.h

---