User manual

© Next Limit Technologies 2010
Maxwell Render 2.5 User Manual
Chapter 17. Appendix IV. Scripting References | 142
• Function: void refreshAllLights( void );
• Description: Refresh all the lights.
• Parameters: Nothing.
• Returned Value: Nothing.
• Function: double getLightIntensity( int index );
• Description: Returns the intensity of the light with the given index. The units of the
intensity depend on the emitter type (read getLightEmissionType).
• Parameters: INT index: Index of the light
• Returned Value: Double: Intensity.
• Function: void setLightIntensity( int index, double intensity );
• Description: Sets the intensity of the light with the given index.
• Parameters: INT index: Index of the light / Double intensity: intensity of the light.
• Returned Value: Nothing.
• Function: int getLightEmissionType( int index );
• Description: Returns the emission type of the light with the given index.
0 = COLOR + LUMINANCE
1 = TEMPERATURE
2 = MULTIEMITTER (more than one emitter layer)
3 = IES
4 = SKY
5 = HDRI
• Parameters: INT index: Index of the light
• Returned Value: INT: Emission type
• Function: void setLightEmissionType( int index, int type);
• Description: Sets the emission type of the light with the given index. / See
getLightEmissionType description.
• Parameters: INT index: Index of the light / INT type: emission type
• Returned Value: Nothing.
• Function: int getLightEmissionColorType( int index );
• Description: Returns the emission color type of the light with the given index.
0 = RGB
1 = CORRELATED TEMPERATURE
• Parameters: INT index: Index of the light
• Returned Value: INT: Emission color type
• Function: void setLightEmissionColorType( int index, int type);
• Description: Sets the emission color type of the light with the given index. / See
getLightEmissionColorType description.
• Parameters: INT index: Index of the light / INT int: emission color type
• Returned Value: Nothing.
• Function: nt getLightLuminanceType( int index );
• Description: Returns the luminance type of the light with the given index. The
luminance type is only used when the emission type is set to
0 = WATTS + EFFICACY
1 = LUMENS
2 = LUX
3 = CANDELA
4 = LUMINANCE
• Parameters: INT index: Index of the light
• Returned Value: INT: Emission luminance type
• Function: void setLightLuminanceType( int index, int type);
• Description: Sets the emission luminance type of the light with the given index. See
getLightLuminanceType description.
• Parameters: INT index: Index of the light / INT int: emission luminance type
• Returned Value: Nothing.
• Function: bool isLightMuted( int index );
• Description: Returns whether or not the light with the given index is muted.
• Parameters: INT index: Index of the light
• Returned Value: Bool: True if the light is muted.
• Function: bool isLightSolo( int index );
• Description: Returns whether or not the light with the given index is in solo mode.
• Parameters: INT index: Index of the light
• Returned Value: Bool: True if the light is in solo mode.
• Function: bool loadEmixerData ( string path );
• Description: Loads an emixer le (extension “.emixer”) and refreshes the Multilight
stage with it.
• Parameters: String path: Path of the emixer le to load
• Returned Value: Bool: returns True if the le was loaded successfully, False if not.