FCDEffectParameterFloat Class Reference

A COLLADA float effect parameter. More...

#include <FCDEffectParameter.h>

Inheritance diagram for FCDEffectParameterFloat:

List of all members.

Public Types
enum	FloatType { FLOAT, HALF }
	The supported types of float-point values. More...
Public Member Functions
	FCDEffectParameterFloat (FCDocument *document)
	Constructor: do not use directly.
virtual	~FCDEffectParameterFloat ()
	Destructor: do not use directly.
virtual FCDEffectParameter::Type	GetType () const
	Retrieves the type of effect parameter class.
FloatType	GetFloatType () const
	Retrieves the type of floating-point value held by this effect parameter.
void	SetFloatType (FloatType type)
	Sets the type of floating-point value held by this effect parameter.
float &	GetValue ()
	Retrieves the floating-point value of the effect parameter.
const float &	GetValue () const
	See above.
void	SetValue (float _value)
	Sets the floating-point value of the effect parameter.
float	GetMin () const
	Retrieves the minimum value for the UI widget created for this effect parameter.
void	SetMin (float _min)
	Sets the minimum value for the UI widget created for this effect parameter.
float	GetMax () const
	Retrieves the maximum value for the UI widget created for this effect parameter.
void	SetMax (float _max)
	Sets the maximum value for the UI widget created for this 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 float effect parameter.

Contains a single, possibly animated, floating-point value. The type of the floating-point value may be HALF or FLOAT.

---

Member Enumeration Documentation

enum FCDEffectParameterFloat::FloatType

The supported types of float-point values. Enumerator: FLOAT  A single floating-pointer value effect parameter. HALF  Probably implies a 16-bit floating-point value.

---

Constructor & Destructor Documentation

FCDEffectParameterFloat::FCDEffectParameterFloat (  FCDocument *  document  )

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

virtual FCDEffectParameterFloat::~FCDEffectParameterFloat (   )  [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* FCDEffectParameterFloat::Clone (   )  [virtual]

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

FloatType FCDEffectParameterFloat::GetFloatType (   )  const [inline]

Retrieves the type of floating-point value held by this effect parameter. Returns: The type of floating-point value.

float FCDEffectParameterFloat::GetMax (   )  const [inline]

Retrieves the maximum value for the UI widget created for this effect parameter. This value is for UI purposes only and has no real impact on the value. Returns: The maximum value.

float FCDEffectParameterFloat::GetMin (   )  const [inline]

Retrieves the minimum value for the UI widget created for this effect parameter. This value is for UI purposes only and has no real impact on the value. Returns: The minimum value.

virtual FCDEffectParameter::Type FCDEffectParameterFloat::GetType (   )  const [inline, virtual]

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

float& FCDEffectParameterFloat::GetValue (   )  [inline]

Retrieves the floating-point value of the effect parameter. Returns: The floating-point value.

virtual FUStatus FCDEffectParameterFloat::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 FCDEffectParameterFloat::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 FCDEffectParameterFloat::SetFloatType (  FloatType  type  )  [inline]

Sets the type of floating-point value held by this effect parameter. Parameters: type  The type of floating-point value.

void FCDEffectParameterFloat::SetMax (  float  _max  )  [inline]

Sets the maximum value for the UI widget created for this effect parameter. This value is for UI purposes only and has no real impact on the value. Parameters: _max  The maximum value.

void FCDEffectParameterFloat::SetMin (  float  _min  )  [inline]

Sets the minimum value for the UI widget created for this effect parameter. This value is for UI purposes only and has no real impact on the value. Parameters: _min  The minimum value.

void FCDEffectParameterFloat::SetValue (  float  _value  )  [inline]

Sets the floating-point value of the effect parameter. Parameters: _value  The floating-point value.

virtual xmlNode* FCDEffectParameterFloat::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

---