FCDEffectParameterList Class Reference
[COLLADA Effect Classes [ColladaFX]]

A searchable list of COLLADA effect parameters. More...

#include <FCDEffectParameterList.h>

Inheritance diagram for FCDEffectParameterList:

List of all members.

Public Member Functions
	FCDEffectParameterList (FCDocument *document=NULL, bool ownParameters=false)
	Constructor.
virtual	~FCDEffectParameterList ()
	Destructor.
FCDEffectParameter *	AddParameter (uint32 type)
	Creates a new parameters within this list.
void	ReleaseParameter (FCDEffectParameter *parameter)
	Releases a parameter contained within this list.
FCDEffectParameter *	FindReference (const char *reference)
	Retrieves the first effect parameter with the given reference.
const FCDEffectParameter *	FindReference (const char *reference) const
	See above.
FCDEffectParameter *	FindReference (const string &reference)
	See above.
const FCDEffectParameter *	FindReference (const string &reference) const
	See above.
FCDEffectParameter *	FindSemantic (const char *semantic)
	Retrieves the first effect parameter with the given semantic.
const FCDEffectParameter *	FindSemantic (const char *semantic) const
	See above.
FCDEffectParameter *	FindSemantic (const string &semantic)
	See above.
const FCDEffectParameter *	FindSemantic (const string &semantic) const
	See above.
void	FindReference (const char *reference, FCDEffectParameterList &list)
	Retrieves a subset of this parameter list.
void	FindReference (const string &reference, FCDEffectParameterList &list)
	See above.
void	FindSemantic (const char *semantic, FCDEffectParameterList &list)
	Retrieves a subset of this parameter list.
void	FindSemantic (const string &semantic, FCDEffectParameterList &list)
	See above.
FCDEffectParameterList *	Clone () const
	Creates a full copy of the list of parameters and its content.

---

Detailed Description

A searchable list of COLLADA effect parameters.

This class is based on the STL vector class and adds some useful search methods: by reference and by semantic.

---

Constructor & Destructor Documentation

FCDEffectParameterList::FCDEffectParameterList (  FCDocument *  document = NULL, bool  ownParameters = false )

Constructor. All the objects that need a parameter list will create it when necessary. You may also create new lists for the retrieval of parameters during a search. Parameters: document  The COLLADA document that owns this parameter list. This pointer can remain NULL unless you expect to create new parameters within this list. ownParameters  Whether this list should release the contained parameters during its destruction.

---

Member Function Documentation

FCDEffectParameter* FCDEffectParameterList::AddParameter (  uint32  type  )

Creates a new parameters within this list. Parameters: type  The effect parameter type. Returns: The new effect parameter. This pointer will be NULL if this list does not own its parameters.

FCDEffectParameterList* FCDEffectParameterList::Clone (   )  const

Creates a full copy of the list of parameters and its content. Returns: The cloned list. You will need to delete this pointer.

void FCDEffectParameterList::FindReference (  const char *  reference, FCDEffectParameterList &  list )

Retrieves a subset of this parameter list. All the effects that match the given reference will be added to the given list. For effect parameter generators, the sub-id is used instead of the reference. Parameters: reference  A reference to match. list  The effect parameter list to fill in with the matched parameters. This list is not clear.

FCDEffectParameter* FCDEffectParameterList::FindReference (  const char *  reference  )

Retrieves the first effect parameter with the given reference. For effect parameter generators, the sub-id is used instead of the reference. Parameters: reference  A reference to match. Returns: The effect parameter that matches the reference. This pointer will be NULL, if no parameter matches the reference.

void FCDEffectParameterList::FindSemantic (  const char *  semantic, FCDEffectParameterList &  list )

Retrieves a subset of this parameter list. All the effects that match the given semantic will be added to the given list. Parameters: semantic  A semantic to match. list  The effect parameter list to fill in with the matched parameters. This list is not clear.

FCDEffectParameter* FCDEffectParameterList::FindSemantic (  const char *  semantic  )

Retrieves the first effect parameter with the given semantic. Parameters: semantic  A semantic to match. Returns: The effect parameter that matches the semantic. This pointer will be NULL if no parameter matches the semantic.

void FCDEffectParameterList::ReleaseParameter (  FCDEffectParameter *  parameter  )

Releases a parameter contained within this list. The memory used by this parameter will be released only if this list owns the parameters. Parameters: parameter  The effect parameter to release.

---

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

• FCDocument/FCDEffectParameterList.h

---