#include <FCDEffect.h>
Inheritance diagram for FCDEffect:
Public Member Functions | |
FCDEffect (FCDocument *document) | |
Constructor: do not use directly. | |
virtual | ~FCDEffect () |
Destructor. | |
virtual Type | GetType () const |
Retrieves the type for this entity class. | |
size_t | GetProfileCount () const |
Retrieves the number of profiles contained within the effect. | |
FCDEffectProfile * | GetProfile (size_t index) |
Retrieves a profile contained within the effect. | |
const FCDEffectProfile * | GetProfile (size_t index) const |
See above. | |
DEPRECATED (3.05A, GetProfileCount and GetProfile(index)) void GetProfiles() const | |
Retrieves the list of the profiles contained within the effect. | |
const FCDEffectProfile * | FindProfile (FUDaeProfileType::Type type) const |
Retrieves the first profile for a specific profile type. | |
FCDEffectProfile * | FindProfile (FUDaeProfileType::Type type) |
See above. | |
FCDEffectProfile * | FindProfileByTypeAndPlatform (FUDaeProfileType::Type type, const fm::string &platform) |
Retrieves the profile for a specific profile type and platform. | |
const FCDEffectProfile * | FindProfileByTypeAndPlatform (FUDaeProfileType::Type type, const fm::string &platform) const |
See above. | |
bool | HasProfile (FUDaeProfileType::Type type) const |
Retrieves whether the effect contains a profile of the given type. | |
FCDEffectProfile * | AddProfile (FUDaeProfileType::Type type) |
Creates a profile of the given type. | |
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. | |
virtual FCDEntity * | Clone (FCDEntity *clone=NULL, bool cloneChildren=false) const |
Clones the effect object. | |
DEPRECATED (3.05A, not recommended) void Flatten() | |
[INTERNAL] Flattens the effect, pushing all the common effect parameters into to the effect technique level of abstraction. |
A COLLADA effect is one of many abstraction level that defines how to render mesh polygon sets. It contains one or more rendering profile that the application can choose to support. In theory, all the rendering profiles should reach the same render output, using different rendering technologies.
An effect may also declare new general purpose parameters that are common to all the profiles.
|
Constructor: do not use directly. Instead use the FCDLibrary::AddEntity function.
|
|
Adds a local effect parameter to the local list.
|
|
Creates a profile of the given type. If a profile of this type already exists, it will be released, as a COLLADA effect should only contain one profile of each type.
|
|
Clones the effect object.
Reimplemented from FCDEntity. |
|
[INTERNAL] Flattens the effect, pushing all the common effect parameters into to the effect technique level of abstraction. To correctly flatten a material, use the FCDMaterialInstance::FlattenMaterial function. |
|
Retrieves the list of the profiles contained within the effect.
|
|
Retrieves the first profile for a specific profile type. There should only be one profile of each type within an effect. This function allows you to retrieve the profile for a given type.
|
|
Retrieves the profile for a specific profile type and platform. There should only be one profile of each type within an effect. This function allows you to retrieve the profile for a given type.
|
|
Retrieves a given local effect parameter.
|
|
Retrieves the number of local effect parameters.
|
|
Retrieves a profile contained within the effect.
|
|
Retrieves the number of profiles contained within the effect.
|
|
Retrieves the type for this entity class. This function is a part of the FCDEntity interface.
Reimplemented from FCDEntity. |
|
Retrieves whether the effect contains a profile of the given type.
|