Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

C++Python
Cmaxwell::CmultiValue::CemitterPairCemitterPair

Methods

NameDescription
CemitterPairClass constructor.

Properties

NameDescription
rgb Cmaxwell::Cmultivalue::pType = "pair.color.rgb".
xyz Cmaxwell::Cmultivalue::pType = "pair.color.xyz".
temperature Cmaxwell::Cmultivalue::pType = "pair.color.temperature".
watts Cmaxwell::Cmultivalue::pType = "pair.wattsAndLuminousEfficacy".
luminousEfficacy Cmaxwell::Cmultivalue::pType = "pair.wattsAndLuminousEfficacy".
luminousPower Cmaxwell::Cmultivalue::pType = "pair.luminousPower".
illuminance Cmaxwell::Cmultivalue::pType = "pair.illuminance".
liminousIntensity Cmaxwell::Cmultivalue::pType = "pair.luminousIntensity".
luminance Cmaxwell::Cmultivalue::pType = "pair.luminance".

Anchor
cmaxwellcmultivaluecemitterpairctor
cmaxwellcmultivaluecemitterpairctor

CemitterPair

Class constructor.

 

Examples

Code Block
languagecpp
titleC++
Cmaxwell::CmultiValue::CemitterPair emitterPair;
emitterPair.rgb.assign( rgb_color );
emitterPair.xyz.assign( xyz_color );
emitterPair.temperature = 6500.0;
emitterPair.watts = 40.0;
emitterPair.luminousEfficacy = 17.6;
emitterPair.luminousPower = 100.0;
emitterPair.illuminance = 100.0;
emitterPair.luminousIntensity = 100.0;
emitterPair.luminance = 100.0;
newEmitter.setPair( emitterPair ); 
Code Block
languagejavascript
titlePython
emitterPait = CemitterPair();
emitterPair.rgb.assign( rgb_color );
emitterPair.xyz.assign( xyz_color );
emitterPair.temperature = 6500.0;
emitterPair.watts = 40.0;
emitterPair.luminousEfficacy = 17.6;
emitterPair.luminousPower = 100.0;
emitterPair.illuminance = 100.0;
emitterPair.luminousIntensity = 100.0;
emitterPair.luminance = 100.0;
newEmitter.setPair( emitterPair );