CemitterPair

Owned by abraham (Unlicensed)
Last updated: 16 Nov, 2011Version comment
2 min read
C++Python
Cmaxwell::CmultiValue::CemitterPairCemitterPair

Class used to set the emitter pair when the emission type is set to Color + Luminance.

Emitters can be defined:

  • 1. Using color + luminance.
  • 2. Using Temperature of emission.
  • 3. Using an MXI texture.

When emitters are set using color + luminance the color can be set:

  • 1.1.a Using RGB color
  • 1.1.b Using Correlated Temperature color

When emitters are set using color + luminance the luminance can be set:

  • 1.2.a Using Watts and efficacy
  • 1.2.b LuminousPower (Lumen)
  • 1.2.c illuminance (Lumen/m2)
  • 1.2.d luminousIntensity (Cd)
  • 1.2.b luminance (Cd/m2)

Cmaxwell::CmultiValue::CemitterPair is used to read/write each parameter.

Properties --TODO-- revisar

 NameDescription
CrgbrgbColor. Cmaxwell::CmaterialEmitter::Cpair::pEmissionColor = "rgb".
CxyzxyzCorrelated temperature color. Cmaxwell::CmaterialEmitter::Cpair::pEmissionColor = "xyz".
realtemperatureTemperature color. Cmaxwell::CmaterialEmitter::Cpair::pEmissionColor = "temperature".
realwatts

Luminance. Cmaxwell::CmaterialEmitter::Cpair::pLuminance = "wattsAndLuminousEfficacy" and Cmaxwell::CmaterialEmitter::Cpair::pEmissionColor = "rgb" or "xzy".

realluminousEfficacyLuminance. Cmaxwell::CmaterialEmitter::Cpair::pLuminance = "wattsAndLuminousEfficacy"and Cmaxwell::CmaterialEmitter::Cpair::pEmissionColor = "rgb" or "xzy".
realluminousPowerLuminance. Cmaxwell::CmaterialEmitter::Cpair::pLuminance = "luminousPower" and Cmaxwell::CmaterialEmitter::Cpair::pEmissionColor = "rgb" or "xzy".
realilluminanceLuminance. Cmaxwell::CmaterialEmitter::Cpair::pLuminance = "illuminance" and Cmaxwell::CmaterialEmitter::Cpair::pEmissionColor = "rgb" or "xzy".
realliminousIntensityLuminance. Cmaxwell::CmaterialEmitter::Cpair::pLuminance = "luminousIntensity" and Cmaxwell::CmaterialEmitter::Cpair::pEmissionColor = "rgb" or "xzy".
realluminanceLuminance. Cmaxwell::CmaterialEmitter::Cpair::pLuminance = "lluminance" and Cmaxwell::CmaterialEmitter::Cpair::pEmissionColor = "rgb" or "xzy".

Methods

NameDescription
CemitterPairClass constructor.

Examples

C++
// Create and fill an emitter pair.
 
Cmaxwell::CmultiValue::CemitterPair emitterPair;
emitterPair.rgb.assign( rgb_color ); // We will use this color.
emitterPair.xyz.assign( xyz_color );
emitterPair.temperature = 6500.0;
emitterPair.watts = 40.0;
emitterPair.luminousEfficacy = 17.6;
emitterPair.luminousPower = 100.0;   // We will use this luminance.
emitterPair.illuminance = 100.0;
emitterPair.luminousIntensity = 100.0;
emitterPair.luminance = 100.0;

// Apply the emitter pair to the emitter.
 
 newEmitter.setPair( emitterPair );

// Create and fill a material emitter pair (not emitter pair!).
  
Cmaxwell::CmaterialEmitter::Cpair pair;
pair.pEmissionColor = "rgb";
pair.pLuminance = "luminousPower";

// Tell the emitter what parameters of the emitter pair use.
 
newEmitter.setActivePair( pair );
Python
# Create and fill an emitter pair.
emitterPait = CemitterPair();
emitterPair.rgb.assign( rgb_color ); # We will use this color.
emitterPair.xyz.assign( xyz_color );
emitterPair.temperature = 6500.0;
emitterPair.watts = 40.0;
emitterPair.luminousEfficacy = 17.6;
emitterPair.luminousPower = 100.0;   # We will use this luminance.
emitterPair.illuminance = 100.0;
emitterPair.luminousIntensity = 100.0;
emitterPair.luminance = 100.0;

# Apply the emitter pair to the emitter.
  
newEmitter.setPair( emitterPair );

# Create and fill a material emitter pair (not emitter pair!).
  
pair = Cpair();
pair.pEmissionColor = "rgb";
pair.pLuminance = "luminousPower";

# Tell the emitter what parameters of the emitter pair use.
  
newEmitter.setActivePair( pair );

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Â