#include <FCDEffectStandard.h>
Inheritance diagram for FCDEffectStandard:
Public Types | |
enum | LightingType { CONSTANT, LAMBERT, PHONG, BLINN, UNKNOWN } |
The list of the lighting models supported by the COMMON profile of COLLADA. More... | |
enum | TransparencyMode { A_ONE, RGB_ZERO } |
The list of transparency modes supported by the COMMON profile of COLLADA. More... | |
Public Member Functions | |
FCDEffectStandard (FCDocument *document, FCDEffect *parent) | |
Constructor: do not use directly. | |
virtual | ~FCDEffectStandard () |
Destructor. | |
LightingType | GetLightingType () const |
Retrieves the lighting model to be used for this profile. | |
void | SetLightingType (LightingType _type) |
Sets the lighting model to be used for this profile. | |
virtual FUDaeProfileType::Type | GetType () const |
Retrieves the profile type for this effect. | |
FCDTexture ** | GetTextureBucket (uint32 bucket) |
Retrieves the list of textures belonging to a specific channel. | |
const FCDTexture ** | GetTextureBucket (uint32 bucket) const |
See above. | |
size_t | GetTextureCount (uint32 bucket) const |
Retrieves the number of textures belonging to a specific channel. | |
FCDTexture * | GetTexture (uint32 bucket, size_t index) |
Retrieves a texture. | |
const FCDTexture * | GetTexture (uint32 bucket, size_t index) const |
See above. | |
FCDTexture * | AddTexture (uint32 bucket) |
Adds a texture to a specific channel. | |
DEPRECATED (3.05A, texture->Release()) void ReleaseTexture(FCDTexture *texture) | |
Releases a texture contained within this effect profile. | |
FCDEffectParameter * | GetParam (const fm::string &semantic, bool *isFloat) |
Retrieves a parameter based on the semantic. | |
FMVector4 & | GetTranslucencyColor () |
Retrieves the base translucency color. | |
const FMVector4 & | GetTranslucencyColor () const |
See above. | |
FCDEffectParameterColor4 * | GetTranslucencyColorParam () |
Retrieves the parameter pointer that contains the translucency color. | |
const FCDEffectParameterColor4 * | GetTranslucencyColorParam () const |
See above. | |
void | SetTranslucencyColor (const FMVector4 &color) |
Sets the base translucency color. | |
float & | GetTranslucencyFactor () |
Retrieves the translucency factor. | |
const float & | GetTranslucencyFactor () const |
See above. | |
FCDEffectParameterFloat * | GetTranslucencyFactorParam () |
Retrieves the parameter pointer that contains the translucency factor. | |
const FCDEffectParameterFloat * | GetTranslucencyFactorParam () const |
See above. | |
void | SetTranslucencyFactor (float factor) |
Sets the translucency factor. | |
TransparencyMode | GetTransparencyMode () const |
Retrieves the transparency mode. | |
void | SetTransparencyMode (TransparencyMode mode) |
Sets the transparency mode. | |
float | GetOpacity () const |
Retrieves the flat opacity. | |
FMVector4 & | GetEmissionColor () |
Retrieves the base emission/self-illumination color. | |
const FMVector4 & | GetEmissionColor () const |
See above. | |
FCDEffectParameterColor4 * | GetEmissionColorParam () |
Retrieves the parameter pointer that contains the emission color. | |
const FCDEffectParameterColor4 * | GetEmissionColorParam () const |
See above. | |
void | SetEmissionColor (const FMVector4 &color) |
Sets the base emission/self-illumination color. | |
float & | GetEmissionFactor () |
Retrieves the emission/self-illumination factor. | |
const float & | GetEmissionFactor () const |
See above. | |
FCDEffectParameterFloat * | GetEmissionFactorParam () |
Retrieves the parameter pointer that contains the emission/self-illumination factor. | |
const FCDEffectParameterFloat * | GetEmissionFactorParam () const |
See above. | |
void | SetEmissionFactor (float factor) |
Sets the emission/self-illumination factor. | |
bool | IsEmissionFactor () const |
Retrieves whether the emission factor was used, rather than the emission color. | |
void | SetIsEmissionFactor (bool useFactor) |
Sets whether the emission factor is to be used, rather than the emission color. | |
FMVector4 & | GetDiffuseColor () |
Retrieves the diffuse color. | |
const FMVector4 & | GetDiffuseColor () const |
See above. | |
FCDEffectParameterColor4 * | GetDiffuseColorParam () |
Retrieves the parameter pointer that contains the diffuse color. | |
const FCDEffectParameterColor4 * | GetDiffuseColorParam () const |
See above. | |
void | SetDiffuseColor (const FMVector4 &color) |
Sets the diffuse color. | |
FMVector4 & | GetAmbientColor () |
Retrieves the ambient color. | |
const FMVector4 & | GetAmbientColor () const |
See above. | |
FCDEffectParameterColor4 * | GetAmbientColorParam () |
Retrieves the parameter pointer that contains the ambient color. | |
const FCDEffectParameterColor4 * | GetAmbientColorParam () const |
See above. | |
void | SetAmbientColor (const FMVector4 &color) |
Sets the ambient color. | |
FMVector4 & | GetSpecularColor () |
Retrieves the base specular color. | |
const FMVector4 & | GetSpecularColor () const |
See above. | |
FCDEffectParameterColor4 * | GetSpecularColorParam () |
Retrieves the parameter pointer that contains the specular color. | |
const FCDEffectParameterColor4 * | GetSpecularColorParam () const |
See above. | |
void | SetSpecularColor (const FMVector4 &color) |
Sets the specular color. | |
float & | GetSpecularFactor () |
Retrieves the specular factor. | |
const float & | GetSpecularFactor () const |
See above. | |
FCDEffectParameterFloat * | GetSpecularFactorParam () |
Retrieves the parameter pointer that contains the specular factor. | |
const FCDEffectParameterFloat * | GetSpecularFactorParam () const |
See above. | |
void | SetSpecularFactor (float factor) |
Sets the specular factor. | |
float & | GetShininess () |
Retrieves the specular shininess. | |
const float & | GetShininess () const |
See above. | |
FCDEffectParameterFloat * | GetShininessParam () |
Retrieves the parameter pointer that contains the specular shininess. | |
const FCDEffectParameterFloat * | GetShininessParam () const |
See above. | |
void | SetShininess (float _shininess) |
Sets the specular shininess. | |
bool | IsReflective () const |
Retrieves the reflectivity state. | |
void | SetReflective (bool r) |
Sets the reflectivity state. | |
FMVector4 & | GetReflectivityColor () |
Retrieves the base reflectivity color. | |
const FMVector4 & | GetReflectivityColor () const |
See above. | |
FCDEffectParameterColor4 * | GetReflectivityColorParam () |
Retrieves the parameter pointer that contains the reflectivity color. | |
const FCDEffectParameterColor4 * | GetReflectivityColorParam () const |
See above. | |
void | SetReflectivityColor (const FMVector4 &color) |
Sets the base reflectivity color. | |
float & | GetReflectivityFactor () |
Retrieves the reflectivity factor. | |
const float & | GetReflectivityFactor () const |
See above. | |
FCDEffectParameterFloat * | GetReflectivityFactorParam () |
Retrieves the parameter pointer that contains the reflectivity factor. | |
const FCDEffectParameterFloat * | GetReflectivityFactorParam () const |
See above. | |
void | SetReflectivityFactor (float factor) |
Sets the reflectivity factor. | |
float | GetReflectivity () const |
Retrieves the flat reflectivity. | |
bool | IsRefractive () const |
Retrieves the refractive state. | |
void | SetRefractive (bool r) |
Sets the refractive state. | |
float & | GetIndexOfRefraction () |
Retrieves the index of refraction. | |
const float & | GetIndexOfRefraction () const |
See above. | |
FCDEffectParameterFloat * | GetIndexOfRefractionParam () |
Retrieves the parameter pointer that contains the index of refraction. | |
const FCDEffectParameterFloat * | GetIndexOfRefractionParam () const |
See above. | |
void | SetIndexOfRefraction (float index) |
Sets the index of refraction. | |
virtual FCDEffectProfile * | Clone (FCDEffectProfile *clone=NULL) const |
Clones the COMMON profile effect and its parameters. | |
DEPRECATED (3.05A, not recommended) void Flatten() | |
[INTERNAL] Flattens the profile. | |
void | AddExtraAttribute (const char *profile, const char *key, const fchar *value) |
Adds an extra attribute to the given profile. | |
const fchar * | GetExtraAttribute (const char *profile, const char *key) const |
Get the extra attribute value corresponding to the given profile and key values. | |
Static Public Attributes | |
static const fm::string | EmissionColorSemantic |
static const fm::string | EmissionFactorSemantic |
static const fm::string | ReflectivityColorSemantic |
static const fm::string | ReflectivityFactorSemantic |
static const fm::string | IndexOfRefractionSemantic |
static const fm::string | TranslucencyColorSemantic |
static const fm::string | TranslucencyFactorSemantic |
static const fm::string | DiffuseColorSemantic |
static const fm::string | AmbientColorSemantic |
static const fm::string | SpecularColorSemantic |
static const fm::string | SpecularFactorSemantic |
static const fm::string | ShininessSemantic |
The COMMON effect profile holds the information necessary to render your polygon sets using the well-defined lighting models.
COLLADA supports four lighting models: constant, Lambert, Phong and Blinn.
|
|
The list of transparency modes supported by the COMMON profile of COLLADA.
|
|
Constructor: do not use directly. Instead, use the FCDEffect::AddProfile function with the FUDaeProfileType::COMMON parameter.
|
|
Adds an extra attribute to the given profile.
|
|
Adds a texture to a specific channel.
|
|
Clones the COMMON profile effect and its parameters.
Reimplemented from FCDEffectProfile. |
|
[INTERNAL] Flattens the profile. Does nothing on the common profile. Reimplemented from FCDEffectProfile. |
|
Releases a texture contained within this effect profile.
|
|
Retrieves the ambient color. This value is used in the Lambert lighting model.
|
|
Retrieves the parameter pointer that contains the ambient color. Use this function to modify the value, the semantic, reference or annotations of the parameter. Note: in order to be linked with the profile_COMMON's parameter list, the parameter needs to have a valid semantic and reference. Otherwise it is treated as a simple color.
|
|
Retrieves the diffuse color. This value is used in the Lambert lighting model.
|
|
Retrieves the parameter pointer that contains the diffuse color. Use this function to modify the value, the semantic, reference or annotations of the parameter. Note: in order to be linked with the profile_COMMON's parameter list, the parameter needs to have a valid semantic and reference. Otherwise it is treated as a simple color.
|
|
Retrieves the base emission/self-illumination color. This value must be multiplied with the emission factor to get the real emission color. This value is used in all lighting models.
|
|
Retrieves the parameter pointer that contains the emission color. Use this function to modify the value, the semantic, reference or annotations of the parameter. Note: in order to be linked with the profile_COMMON's parameter list, the parameter needs to have a valid semantic and reference. Otherwise it is treated as a simple color.
|
|
Retrieves the emission/self-illumination factor. This value must be multiplied with the base emission color to get the real emission color.
|
|
Retrieves the parameter pointer that contains the emission/self-illumination factor. Use this function to modify the value, the semantic, reference or annotations of the parameter. Note: in order to be linked with the profile_COMMON's parameter list, the parameter needs to have a valid semantic and reference. Otherwise it is treated as a simple float.
|
|
Get the extra attribute value corresponding to the given profile and key values.
|
|
Retrieves the index of refraction. The index of refraction defaults to 1.0f.
|
|
Retrieves the parameter pointer that contains the index of refraction. Use this function to modify the value, the semantic, reference or annotations of the parameter. Note: in order to be linked with the profile_COMMON's parameter list, the parameter needs to have a valid semantic and reference. Otherwise it is treated as a simple float.
|
|
Retrieves the lighting model to be used for this profile.
|
|
Retrieves the flat opacity. This is a calculated value and will not take into consideration any animations that affect either the base translucency color or the translucency factor. This value can be used in all lighting models.
|
|
Retrieves a parameter based on the semantic.
|
|
Retrieves the flat reflectivity. This is a calculated value and will not take into consideration any animations that affect either the base reflectivity color or the reflectivity factor. This value can be used in the Phong and Blinn lighting models.
|
|
Retrieves the base reflectivity color. This value must be multiplied to the reflectivity factor to get the real reflectivity color. This value is used in the Phong and Blinn lighting models.
|
|
Retrieves the parameter pointer that contains the reflectivity color. Use this function to modify the value, the semantic, reference or annotations of the parameter. Note: in order to be linked with the profile_COMMON's parameter list, the parameter needs to have a valid semantic and reference. Otherwise it is treated as a simple color.
|
|
Retrieves the reflectivity factor. This value must be multiplied to the base reflectivity color to get the real reflectivity color. This value is used in the Phong and Blinn lighting models.
|
|
Retrieves the parameter pointer that contains the reflectivity factor. Use this function to modify the value, the semantic, reference or annotations of the parameter. Note: in order to be linked with the profile_COMMON's parameter list, the parameter needs to have a valid semantic and reference. Otherwise it is treated as a simple float.
|
|
Retrieves the specular shininess. This value represents the exponent to which you must raise the dot-product between the view vector and reflected light vectors: as such, it is usually a number greater than 1. This value is used in the Phong and Blinn lighting models.
|
|
Retrieves the parameter pointer that contains the specular shininess. Use this function to modify the value, the semantic, reference or annotations of the parameter. Note: in order to be linked with the profile_COMMON's parameter list, the parameter needs to have a valid semantic and reference. Otherwise it is treated as a simple float.
|
|
Retrieves the base specular color. This value must be multiplied with the specular factor to get the real specular color. This value is used in the Phong and Blinn lighting models.
|
|
Retrieves the parameter pointer that contains the specular color. Use this function to modify the value, the semantic, reference or annotations of the parameter. Note: in order to be linked with the profile_COMMON's parameter list, the parameter needs to have a valid semantic and reference. Otherwise it is treated as a simple color.
|
|
Retrieves the specular factor. This value must be multiplied with the base specular color to get the real specular color. This value is used in the Phong and Blinn lighting models.
|
|
Retrieves the parameter pointer that contains the specular factor. Use this function to modify the value, the semantic, reference or annotations of the parameter. Note: in order to be linked with the profile_COMMON's parameter list, the parameter needs to have a valid semantic and reference. Otherwise it is treated as a simple float.
|
|
Retrieves a texture.
|
|
Retrieves the list of textures belonging to a specific channel.
|
|
Retrieves the number of textures belonging to a specific channel.
|
|
Retrieves the base translucency color. This value must be multiplied with the translucency factor to get the real translucency color. Use the RGB channels in case of a RGB_ZERO transparency mode, and the A channel in case of a A_ONE transparency mode This value is used in all lighting models.
|
|
Retrieves the parameter pointer that contains the translucency color. Use this function to modify the value, the semantic, reference or annotations of the parameter. Note: in order to be linked with the profile_COMMON's parameter list, the parameter needs to have a valid semantic and reference. Otherwise it is treated as a simple color.
|
|
Retrieves the translucency factor. This value must be multiplied with the translucency color to get the real translucency color. This value is used in all lighting models.
|
|
Retrieves the parameter pointer that contains the translucency factor. Use this function to modify the value, the semantic, reference or annotations of the parameter. Note: in order to be linked with the profile_COMMON's parameter list, the parameter needs to have a valid semantic and reference. Otherwise it is treated as a simple float.
|
|
Retrieves the transparency mode.
|
|
Retrieves the profile type for this effect. This function is a part of the FCDEffectProfile interface and allows you to up-cast an effect profile pointer safely to this class.
Implements FCDEffectProfile. |
|
Retrieves whether the emission factor was used, rather than the emission color. This value is used in conjunction with 3dsMax, in which the self-illumination color and the self-illumination factor are mutually exclusive.
|
|
Retrieves the reflectivity state.
|
|
Retrieves the refractive state.
|
|
Sets the ambient color.
|
|
Sets the diffuse color.
|
|
Sets the base emission/self-illumination color.
|
|
Sets the emission/self-illumination factor.
|
|
Sets the index of refraction.
|
|
Sets whether the emission factor is to be used, rather than the emission color. This value is used in conjunction with 3dsMax, in which the self-illumination color and the self-illumination factor are mutually exclusive.
|
|
Sets the lighting model to be used for this profile. Note that which parameters are exported depends on the lighting model.
|
|
Sets the reflectivity state.
|
|
Sets the base reflectivity color.
|
|
Sets the reflectivity factor.
|
|
Sets the refractive state.
|
|
Sets the specular shininess. This value represents the exponent to which you must raise the dot-product between the view vector and reflected light vectors: as such, it is usually a number greater than 1.
|
|
Sets the specular color.
|
|
Sets the specular factor.
|
|
Sets the base translucency color.
|
|
Sets the translucency factor.
|
|
Sets the transparency mode.
|