FCDEffectParameterString Class Reference

A COLLADA string effect parameter. More...

#include <FCDEffectParameter.h>

Inheritance diagram for FCDEffectParameterString:

List of all members.

Public Member Functions
	FCDEffectParameterString (FCDocument *document)
	Constructor: do not use directly.
virtual	~FCDEffectParameterString ()
	Destructor: do not use directly.
virtual Type	GetType () const
	Retrieves the type of effect parameter class.
const string &	GetValue () const
	Retrieves the string contained in the effect parameter.
void	SetValue (const string &_value)
	Sets the string contained in the effect parameter.
virtual FCDEffectParameter *	Clone ()
	Creates a full copy of the effect parameter.
virtual void	Overwrite (FCDEffectParameter *target)
	[INTERNAL] Overwrites the target parameter with this parameter.
virtual FUStatus	LoadFromXML (xmlNode *parameterNode)
	[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node.
virtual xmlNode *	WriteToXML (xmlNode *parentNode) const
	[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node.

---

Detailed Description

A COLLADA string effect parameter.

Contains a single, unanimated string.

---

Constructor & Destructor Documentation

FCDEffectParameterString::FCDEffectParameterString (  FCDocument *  document  )

Constructor: do not use directly. Instead, use the FCDEffectParameterList::AddParameter function. Parameters: document  The COLLADA document that owns the effect parameter.

virtual FCDEffectParameterString::~FCDEffectParameterString (   )  [virtual]

Destructor: do not use directly. Instead, use the FCDEffectParameterList::ReleaseParameter function. When released, the effect parameter list will also release all its parameters, if it owns them.

---

Member Function Documentation

virtual FCDEffectParameter* FCDEffectParameterString::Clone (   )  [virtual]

Creates a full copy of the effect parameter. Returns: The cloned effect parameter. You will need to delete this pointer. Implements FCDEffectParameter.

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

Retrieves the type of effect parameter class. Returns: The parameter class type: STRING. Implements FCDEffectParameter.

const string& FCDEffectParameterString::GetValue (   )  const [inline]

Retrieves the string contained in the effect parameter. Returns: The string.

virtual FUStatus FCDEffectParameterString::LoadFromXML (  xmlNode *  parameterNode  )  [virtual]

[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node. Parameters: parameterNode  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 parameter. Reimplemented from FCDEffectParameter.

virtual void FCDEffectParameterString::Overwrite (  FCDEffectParameter *  target  )  [virtual]

[INTERNAL] Overwrites the target parameter with this parameter. This function is used during the flattening of materials. Parameters: target  The target parameter to overwrite. Reimplemented from FCDEffectParameter.

void FCDEffectParameterString::SetValue (  const string &  _value  )  [inline]

Sets the string contained in the effect parameter. Parameters: _value  The string.

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

[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node. Parameters: parentNode  The COLLADA XML parent node in which to insert the parameter. Returns: The created element XML tree node. Reimplemented from FCDEffectParameter.

---

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

• FCDocument/FCDEffectParameter.h

---