MaxwellMayaEmitter class

MaxwellMayaEmitter class

Description

This class allows you to manipulate emitter components. Each material layer can contain one emitter. See here for a description of the Maxwell emitter mode.

Texturable attributes: mxi (AttrType_Double, value used as intensity multiplier when textured, ignored when not textured).

Base class: MaxwellMayaMaterialComponent.

Methods

void

Destroy()

void

SetEnabled(bool enabled)

bool

GetEnabled() const

void

SetEmissionType(EmissionType type)

EmissionType

GetEmissionType() const

void

SetColorType(ColorType type)

ColorType

GetColorType() const

void

SetRGBColor(const MFloatVector& color)

void

GetRGBColor(MFloatVector& color) const

void

SetCorrelatedColor(double temperature)

double

GetCorrelatedColor() const

void

SetOutputType(OutputType type)

OutputType

GetOutputType() const

void

SetWatts(double watts)

double

GetWatts() const

void

SetEfficacy(double efficacy)

double

GetEfficacy() const

void

SetLuminance(double luminance)

double

GetLuminance() const

void

SetIES(const MString& file, double intensity)

void

GetIES(MString& file, double& intensity) const

void

SetTemperature(double temperature)

double

GetTemperature() const

 

Inherited methods

void Destroy()

Destroys the emitter, removing it from the parent layer.

void SetEnabled(bool enabled)
bool GetEnabled() const

Emitters can be disabled, in which case they do not participate in rendering in any way.

Attribute name: enabled (AttrType_Bool).

void SetEmissionType(EmissionType type)
EmissionType GetEmissionType() const

Maxwell supports the following types of emitters:

  • EmissionType_ColorLuminance: an analytic model based on color and luminance.

  • EmissionType_Temperature: the emitter is defined by a single value called emission temperature which controls both the color and intensity of the light.

  • EmissionType_MXI: texture-based emission.

See here for a more in-depth explanation of the three types.

Attribute name: emissionType (AttrType_Int).

void SetColorType(ColorType type)
ColorType GetColorType() const

When the emitter type is set to EmissionType_ColorLuminance, this attribute controls how the light color is specified:

  • ColorType_RGB: as a RGB value.

  • ColorType_Correlated: as a color temperature value.

See here for details.