#include <FCDEffectParameter.h>
Inheritance diagram for FCDEffectParameter:
Public Types | |
enum | Type { SAMPLER, INTEGER, BOOLEAN, FLOAT, FLOAT2, FLOAT3, VECTOR, MATRIX, STRING, SURFACE } |
The value type of the effect parameter. More... | |
enum | ParamType { GENERATOR, MODIFIER, ANIMATOR, REFERENCER, CONSTANT } |
The usage type of the effect parameter. More... | |
Public Member Functions | |
FCDEffectParameter (FCDocument *document) | |
Constructor: do not use directly. | |
virtual | ~FCDEffectParameter () |
Destructor. | |
virtual Type | GetType () const =0 |
Retrieves the type of effect parameter class. | |
ParamType | GetParamType () const |
Retrieves the type of parameter. | |
const fm::string & | GetReference () const |
Retrieves the reference for this effect parameter. | |
void | SetReference (const char *_reference) |
Sets the reference for the effect parameter. | |
const fm::string & | GetSemantic () const |
Retrieves the semantic for this effect parameter. | |
void | SetSemantic (const char *_semantic) |
Sets the semantic for this effect parameter. | |
bool | IsGenerator () const |
Retrieves whether this effect parameter is a parameter generator. | |
void | SetGenerator () |
Sets this effect parameter as a generator. | |
bool | IsModifier () const |
Retrieves whether this effect parameter is a parameter modifier. | |
void | SetModifier () |
Sets this effect parameter as a modified. | |
bool | IsAnimator () const |
Retrieves whether this effect is an animated parameter. | |
void | SetAnimator () |
Sets this effect parameter as animated. | |
bool | IsReferencer () const |
Retrieves whether this effect is a referenced parameter. | |
void | SetReferencer () |
Sets this effect parameter as referencer. | |
bool | IsConstant () const |
Retrieves whether this effect is a constant parameter. | |
void | SetConstant () |
Sets this effect parameter as constant. | |
const FCDEffectParameterAnnotation ** | GetAnnotations () const |
Retrieves the list of annotations for this parameter. See above. | |
size_t | GetAnnotationCount () const |
Retrieves the number of annotations for this parameter. | |
FCDEffectParameterAnnotation * | GetAnnotation (size_t index) |
Retrieves an annotation of this parameter. | |
const FCDEffectParameterAnnotation * | GetAnnotation (size_t index) const |
See above. | |
FCDEffectParameterAnnotation * | AddAnnotation () |
Adds a blank annotation to this parameter. | |
void | AddAnnotation (const fchar *name, FCDEffectParameter::Type type, const fchar *value) |
Adds an annotation to this parameter. | |
void | AddAnnotation (const fstring &name, FCDEffectParameter::Type type, const fchar *value) |
See above. | |
void | AddAnnotation (const fchar *name, FCDEffectParameter::Type type, const fstring &value) |
See above. | |
void | AddAnnotation (const fstring &name, FCDEffectParameter::Type type, const fstring &value) |
See above. | |
template<class T> | |
void | AddAnnotation (const fchar *name, FCDEffectParameter::Type type, const T &value) |
See above. | |
template<class T> | |
void | AddAnnotation (const fstring &name, FCDEffectParameter::Type type, const T &value) |
See above. | |
DEPRECATED (3.05A, annotation->Release) inline void ReleaseAnnotation(FCDEffectParameterAnnotation *annotation) | |
Releases an annotation of this parameter. | |
virtual bool | IsValueEqual (FCDEffectParameter *parameter)=0 |
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. |
This interface class is used to define all the valid ColladaFX parameter types. There are many types of parameters: integers, booleans, floating-point values, 2D, 3D and 4D vectors of floating-point values, matrices, strings, surfaces and their samplers.
A COLLADA effect parameter may generate a new effect parameter, in which case it will declare a semantic and a reference: to represent it within the COLLADA document.
|
|
The value type of the effect parameter.
|
|
Constructor: do not use directly. Instead, use the appropriate AddEffectParameter function.
|
|
Adds an annotation to this parameter.
|
|
Adds a blank annotation to this parameter.
|
|
Creates a full copy of the effect parameter.
Reimplemented in FCDEffectParameterT< PrimitiveType >, FCDEffectParameterAnimatableT< PrimitiveType, Qualifiers >, FCDEffectParameterSampler, and FCDEffectParameterSurface. |
|
Releases an annotation of this parameter.
|
|
Retrieves an annotation of this parameter.
|
|
Retrieves the number of annotations for this parameter.
|
|
Retrieves the list of annotations for this parameter. See above.
|
|
Retrieves the type of parameter. The parameter can be a generator (newparam), a modifier (setparam) or an animated param (animator).
|
|
Retrieves the reference for this effect parameter. In the case of generators, the reference string contains the sub-id.
|
|
Retrieves the semantic for this effect parameter.
|
|
Retrieves the type of effect parameter class.
Implemented in FCDEffectParameterT< PrimitiveType >, FCDEffectParameterAnimatableT< PrimitiveType, Qualifiers >, FCDEffectParameterSampler, and FCDEffectParameterSurface. |
|
Retrieves whether this effect is an animated parameter. A ColladaFX parameter must be generated to be modified or bound at higher abstraction levels.
|
|
Retrieves whether this effect is a constant parameter. This type of parameter belongs to the technique and isn't referenced anywhere. It should have an empty reference.
|
|
Retrieves whether this effect parameter is a parameter generator. A ColladaFX parameter must be generated to be modified or bound at higher abstraction levels.
|
|
Retrieves whether this effect parameter is a parameter modifier. A ColladaFX parameter must be generated to be modified or bound at higher abstraction levels.
|
|
Retrieves whether this effect is a referenced parameter. This type of parameter must have a valid reference equal to that of the generator paramater in order to be properly linked.
|
|
Compares this parameter's value with another.
Implemented in FCDEffectParameterT< PrimitiveType >, FCDEffectParameterAnimatableT< PrimitiveType, Qualifiers >, FCDEffectParameterSampler, and FCDEffectParameterSurface. |
|
[INTERNAL] Overwrites the target parameter with this parameter. This function is used during the flattening of materials.
Reimplemented in FCDEffectParameterT< PrimitiveType >, FCDEffectParameterAnimatableT< PrimitiveType, Qualifiers >, FCDEffectParameterSampler, and FCDEffectParameterSurface. |
|
Sets the reference for the effect parameter. In the case of generators, the reference string contains the sub-id.
|
|
Sets the semantic for this effect parameter.
|