Multilight functions

Owned by Systems Next Limit (Unlicensed)
Last updated: 12 Jan, 2022 by Next Limit
3 min read

• Function: int getLightsCount( void );
• Description: Returns the number of lights of the current scene/ MXI loaded.
• Parameters: Nothing.
• Returned Value: INT: Number of lights.

• Function: string getLightName( int index );
• Description: Returns the name of the light (emitter material) with the given index.
• Parameters: INT index: Index of the light
• Returned Value: String: Name of the light.

• Function: void refreshLight( int index );
• Description: Refresh the light with the given index.
• Parameters: INT index: Index of the light
• Returned Value: Nothing.

• 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 file (extension “.emixer”) and refreshes the Multilight stage with it.
• Parameters: String path: Path of the emixer file to load
• Returned Value: Bool: returns True if the file was loaded successfully, False if not.

• Function: bool saveEmixerData ( string path);
• Description: Saves the current Multilight state in an emixer file (extension “.emixer”).
• Parameters: String path: Path of the emixer file to save
• Returned Value: Bool: returns True if the file was saved successfully, False if not.