#include <FCDEffectProfile.h>
Inheritance diagram for FCDEffectProfile:
Public Member Functions | |
FCDEffectProfile (FCDocument *document, FCDEffect *parent) | |
Constructor: do not use directly. | |
virtual | ~FCDEffectProfile () |
Destructor. | |
virtual FUDaeProfileType::Type | GetType () const =0 |
Retrieves the profile type for this effect. | |
FCDEffect * | GetParent () |
Retrieves the parent effect. | |
const FCDEffect * | GetParent () const |
See above. | |
DEPRECATED (3.05A, GetParent()->GetDaeId) const fm | |
[INTERNAL] Retrieves the COLLADA id of the parent effect. | |
FCDExtra * | GetExtra () |
Retrieves the extra information tree for this effect profile. | |
const FCDExtra * | GetExtra () const |
See above. | |
virtual FCDEffectProfile * | Clone (FCDEffectProfile *clone=NULL) const |
Clones the profile effect and its parameters. | |
size_t | GetEffectParameterCount () const |
Retrieves the number of local effect parameters. | |
FCDEffectParameter * | GetEffectParameter (size_t index) |
Retrieves a given local effect parameter. | |
const FCDEffectParameter * | GetEffectParameter (size_t index) const |
FCDEffectParameter * | AddEffectParameter (uint32 type) |
Adds a local effect parameter to the local list. | |
DEPRECATED (3.05A, not recommended) void Flatten() | |
[INTERNAL] Flattens this effect profile, pushing all the effect parameter overrides into the effect parameter generators and moving all the parameters to the effect technique level of abstraction. |
COLLADA has multiple effect profiles: CG, HLSL, GLSL, GLES and the COMMON profile. For each profile, there is a class which implements this abstract class. This abstract class solely holds the parent effect and allows access to the profile type.
|
Constructor: do not use directly. Instead, use the FCDEffect::AddProfile function.
|
|
Adds a local effect parameter to the local list.
|
|
Clones the profile effect and its parameters.
Reimplemented in FCDEffectProfileFX, and FCDEffectStandard. |
|
[INTERNAL] Flattens this effect profile, pushing all the effect parameter overrides into the effect parameter generators and moving all the parameters to the effect technique level of abstraction. To flatten the material, use the FCDMaterialInstance::FlattenMaterial function. Reimplemented in FCDEffectProfileFX, and FCDEffectStandard. |
|
[INTERNAL] Retrieves the COLLADA id of the parent effect. This function is useful when reporting errors and warnings.
|
|
Retrieves a given local effect parameter.
|
|
Retrieves the number of local effect parameters.
|
|
Retrieves the extra information tree for this effect profile. The prefered way to save extra information in FCollada is at the entity level: FCDEffect.
|
|
Retrieves the parent effect. This is the effect which contains this profile.
|
|
Retrieves the profile type for this effect. This function allows you to up-cast the pointer safely to a more specific effect profile class.
Implemented in FCDEffectProfileFX, and FCDEffectStandard. |