FCDEffectParameterAnimatableT< PrimitiveType, Qualifiers > Class Template Reference
[COLLADA Effect Classes [ColladaFX]]

A COLLADA non-animatable effect parameter template. More...

#include <FCDEffectParameter.h>

Inheritance diagram for FCDEffectParameterAnimatableT< PrimitiveType, Qualifiers >:

List of all members.

Public Types
enum	FloatType {   FLOAT,   HALF }
	The supported types of float-point values. More...
Public Member Functions
	FCDEffectParameterAnimatableT (FCDocument *document)
	Constructor: do not use directly.
virtual	~FCDEffectParameterAnimatableT ()
	Destructor.
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.
FCDParameterAnimatableT< PrimitiveType, Qualifiers > &	GetValue ()
	Retrieves the value of the effect parameter.
const FCDParameterAnimatableT< PrimitiveType, Qualifiers > &	GetValue () const
	See above.
void	SetValue (const PrimitiveType &_value)
	Sets the integer value of the effect parameter.
virtual bool	IsValueEqual (FCDEffectParameter *parameter)
	Compares this parameter's value with another.
virtual FCDEffectParameter *	Clone (FCDEffectParameter *clone=NULL) const
	Creates a full copy of the effect parameter.
virtual void	Overwrite (FCDEffectParameter *target)
	[INTERNAL] Overwrites the target parameter with this parameter.

---

Detailed Description

template<class PrimitiveType, int Qualifiers>
class FCDEffectParameterAnimatableT< PrimitiveType, Qualifiers >

A COLLADA non-animatable effect parameter template.

---

Member Enumeration Documentation

template<class PrimitiveType, int Qualifiers> enum FCDEffectParameterAnimatableT::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

template<class PrimitiveType, int Qualifiers> FCDEffectParameterAnimatableT< PrimitiveType, Qualifiers >::FCDEffectParameterAnimatableT (  FCDocument *  document  )

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

---

Member Function Documentation

template<class PrimitiveType, int Qualifiers> FCDEffectParameter * FCDEffectParameterAnimatableT< PrimitiveType, Qualifiers >::Clone (  FCDEffectParameter *  clone = NULL  )  const [virtual]

Creates a full copy of the effect parameter. Parameters: clone  The cloned effect parameter. If this pointer is NULL, a new effect parameter will be created and you will need to delete this pointer. Returns: The cloned effect parameter. Reimplemented from FCDEffectParameter.

template<class PrimitiveType, int Qualifiers> FloatType FCDEffectParameterAnimatableT< PrimitiveType, Qualifiers >::GetFloatType (   )  const [inline]

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

template<class PrimitiveType, int Qualifiers> virtual Type FCDEffectParameterAnimatableT< PrimitiveType, Qualifiers >::GetType (   )  const [virtual]

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

template<class PrimitiveType, int Qualifiers> FCDParameterAnimatableT<PrimitiveType, Qualifiers>& FCDEffectParameterAnimatableT< PrimitiveType, Qualifiers >::GetValue (   )  [inline]

Retrieves the value of the effect parameter. Returns: The integer value.

template<class PrimitiveType, int Qualifiers> bool FCDEffectParameterAnimatableT< PrimitiveType, Qualifiers >::IsValueEqual (  FCDEffectParameter *  parameter  )  [virtual]

Compares this parameter's value with another. Parameters: parameter  The given parameter to compare with. Returns: true if the values are equal Implements FCDEffectParameter.

template<class PrimitiveType, int Qualifiers> void FCDEffectParameterAnimatableT< PrimitiveType, Qualifiers >::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.

template<class PrimitiveType, int Qualifiers> void FCDEffectParameterAnimatableT< PrimitiveType, Qualifiers >::SetFloatType (  FloatType  type  )  [inline]

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

template<class PrimitiveType, int Qualifiers> void FCDEffectParameterAnimatableT< PrimitiveType, Qualifiers >::SetValue (  const PrimitiveType &  _value  )  [inline]

Sets the integer value of the effect parameter. Parameters: _value  The integer value.

---

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

• FCDocument/FCDEffectParameter.h
• FCDocument/FCDEffectParameter.hpp

---