Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
C++Python
Cmaxwell::CmultiValue::CemitterPairCemitterPair

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

...

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

C++Python
Cmaxwell::CmultiValue::CemitterPairCemitterPair

Methods

Properties --TODO-- revisar

 NameDescription
CemitterPairClass constructor.

Properties

CmultivaluepType pair.color.CmultivaluepType pair.color.CmultivaluepType pair.color.CmultivaluepType pair.wattsAndLuminousEfficacy".
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 = "

luminousEfficacyCmaxwell::Cmultivalue::pType = "pair.wattsAndLuminousEfficacy".
luminousPowerCmaxwell::Cmultivalue::pType = "pair.luminousPower".
illuminanceCmaxwell::Cmultivalue::pType = "pair.illuminance".
liminousIntensityCmaxwell::Cmultivalue::pType = "pair.luminousIntensity".
luminanceCmaxwell::Cmultivalue::pType = "pair.luminance".

...

CemitterPair

Class constructor.

...

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.

Anchor
cmaxwellcmultivaluecemitterpairctor
cmaxwellcmultivaluecemitterpairctor

Examples

javascript
Code Block
languagecpp
titleC++
// 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 ); 
Code Block
language


// 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 );  
Code Block
titlePython
# 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 );