C++ Syntax

class MKI_ENUMEFFECT_DATA

{

public:

double m_dTransparency,

m_dBrightness,

m_dSaturation,

m_dTint;

MKI_COLORVALUE m_cTintColor;

MKI_COLORMODEL m_cTintColorMode;

void

Init( void );

bool

IsIdentical( const MKI_ENUMEFFECT_DATA& f_rData ) const;

bool

SetDisplayEffect( MKI_CONST_DISPLAY_EFFECT_REF f_rData );

void

AddDisplayEffect( MKI_CONST_DISPLAY_EFFECT_REF f_rData );

bool

ApplyToColor( MKI_COLORVALUE_REF f_rColor, MKI_COLORMODEL f_cColorMode ) const;

bool

ApplyToAlpha( MKI_ALPHAVALUE_REF f_rAlpha ) const;

};

This structure contains enumeration dyeing effects. Dyeing does not change the properties of objects, it only changes their rendering.

This class is similar to MKI_DISPLAY_EFFECT, but uses a different value range (doubles relative to 1.0 instead of integer percent).

Element Description

m_dTransparency

[double] Relative transparency to be applied to all subordinate objects. Allowed values are -1.0 to 1.0. Negative values make all subordinate objects less transparent, positive values make all subordinate more transparent.

m_dBrightness

[double] Relative brightness to be applied to all subordinate objects. Allowed values are -1.0 to 1.0. Negative values make all subordinate objects darker, positive values make all subordinate objects lighter.

m_dSaturation

[double] Relative saturation to be applied to all subordinate objects. Allowed values are -1.0 to 1.0. Negative values make all subordinate objects less saturated (towards gray), positive values make all subordinate objects more saturated (intense colors).

m_dTint

[double] Amount of tinting with m_cTintColor / m_cTintColorMode to be applied to all subordinate objects. Allowed values are 0 to 1.0.

m_cTintColor

[MKI_COLORVALUE] Tinting color (only used if m_nTint is non-zero).

m_cTintColorMode

[MKI_COLORMODEL] Tinting color model (only used if m_nTint is non-zero).