FCDEffectParameterFloat2 Class Reference

A COLLADA 2D vector of floats. More...

#include <FCDEffectParameter.h>

Inheritance diagram for FCDEffectParameterFloat2:

List of all members.

Public Types
enum	FloatType { FLOAT, HALF }
	The supported types of float-point values. More...
Public Member Functions
	FCDEffectParameterFloat2 (FCDocument *document)
	Constructor: do not use directly.
virtual	~FCDEffectParameterFloat2 ()
	Destructor: do not use directly.
virtual 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 &	GetValueX ()
	Retrieves the first floating-point value of the effect parameter.
const float &	GetValueX () const
	See above.
void	SetValueX (float value)
	Sets the first floating-point value of the effect parameter.
float &	GetValueY ()
	Retrieves the second floating-point value of the effect parameter.
const float &	GetValueY () const
	See above.
void	SetValueY (float value)
	Sets the second floating-point value of 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 2D vector of floats.

Contains two, possibly animated, floating-point values. The type of the floating-point values may be HALF or FLOAT.

---

Member Enumeration Documentation

enum FCDEffectParameterFloat2::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

FCDEffectParameterFloat2::FCDEffectParameterFloat2 (  FCDocument *  document  )

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

virtual FCDEffectParameterFloat2::~FCDEffectParameterFloat2 (   )  [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* FCDEffectParameterFloat2::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 FCDEffectParameterFloat2::GetFloatType (   )  const [inline]

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

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

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

float& FCDEffectParameterFloat2::GetValueX (   )  [inline]

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

float& FCDEffectParameterFloat2::GetValueY (   )  [inline]

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

virtual FUStatus FCDEffectParameterFloat2::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 FCDEffectParameterFloat2::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 FCDEffectParameterFloat2::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 FCDEffectParameterFloat2::SetValueX (  float  value  )  [inline]

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

void FCDEffectParameterFloat2::SetValueY (  float  value  )  [inline]

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

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

---