MXI functions

Owned by dario (Unlicensed)
Last updated: 06 Dec, 2012 by Mihai Iliuta (Unlicensed)Version comment
4 min read

• Function: string activeCamera( void );
• Description: Returns the camera name of the active camera.
• Parameters: Nothing
• Returned Value: String: camera name.

• Function: void setActiveCamera( string name );
• Description: Sets the active camera name.
• Parameters: String name: New camera name.
• Returned Value: Nothing

• Function: double iso( void );
• Description: Returns the current ISO value.
• Parameters: Nothing
• Returned Value: Double: ISO value.

• Function: void setIso( double value );
• Description: Sets the ISO value.
• Parameters: Double value: New ISO value
• Returned Value: Nothing.

• Function: double shutter( void );
• Description: Returns the current Shutter value.
• Parameters: Nothing
• Returned Value: Double: shutter value.

• Function: void setShutter( double value );
• Description: Sets the Shutter value.
• Parameters: Double value: New Shutter value
• Returned Value: Nothing.

• Function: int colorSpace( void );
• Description: Returns the 0-index of the color space of the current scene. See the Maxwell Render GUI for more info about available color spaces and their indexes.
• Parameters: Nothing
• Returned Value: INT: index of color space

• Function: void setColorSpace( int value );
• Description: Sets the 0-index of the color space of the current scene.
• Parameters: INT value: New color space index.
• Returned Value: Nothing

• Function: double burn( void );
• Description: Returns the current burn value.
• Parameters: Nothing
• Returned Value: Double: burn value.

• Function: void setBurn( double value );
• Description: Sets the burn value.
• Parameters: Double value: New burn value.
• Returned Value: Nothing.

• Function: double gamma( void );
• Description: Returns the current gamma value.
• Parameters: Nothing
• Returned Value: Double: gamma value.

• Function: void setGamma( double value );
• Description: Sets the gamma value.
• Parameters: Double value: New gamma value.
• Returned Value: Nothing

• Function: double fStop( void );
• Description: Returns the current fStop value.
• Parameters: Nothing
• Returned Value: Double: fStop value.

• Function: void setFStop( double value );
• Description: Sets the fStop value.
• Parameters: Double value: New fStop value
• Returned Value: Nothing

• Function: double intensity( void );
• Description: Returns the current intensity value.
• Parameters: Nothing
• Returned Value: Double: intensity value.

• Function: void setIntensity( double value );
• Description: Sets the intensity value.
• Parameters: Double value: New intensity value.
• Returned Value: Nothing

• Function: string apertureMap( void );
• Description: Returns the current aperture map.
• Parameters: Nothing
• Returned Value: String: aperture map path.

• Function: void setApertureMap( string path );
• Description: Sets the aperture map.
• Parameters: String path: New aperture map path.
• Returned Value: Nothing

• Function: string obstacleMap( void );
• Description: Returns the current obstacle map.
• Parameters: Nothing
• Returned Value: String: obstacle map path.

• Function: void setObstacleMap( string path );
• Description: Sets the obstacle map.
• Parameters: String path: New obstacle map path.
• Returned Value: Nothing

• Function: bool diffractionEnabled( void );
• Description: Returns whether diffraction is enabled or disabled.
• Parameters: Nothing
• Returned Value: Bool: True if diffraction is enabled, False if it is disabled.

• Function: void setDiffractionEnabled( bool state );
• Description: Sets diffraction to enabled or disabled.
• Parameters: Bool status: New diffraction state.
• Returned Value: Nothing

• Function: double diffraction( void );
• Description: Returns the current diffraction value.
• Parameters: Nothing
• Returned Value: Double: diffraction value.

• Function: void setDiffraction( double value );
• Description: Sets the diffraction value.
• Parameters: Double value: New diffraction value.
• Returned Value: Nothing

• Function: double frequency( void );
• Description: Returns the current frequency value.
• Parameters: Nothing
• Returned Value: Double: frequency value.

• Function: void setFrequency( double value );
• Description: Sets the frequency value.
• Parameters: Double value: New frequency value.
• Returned Value: Nothing

• Function: bool scatteringEnabled( void );
• Description: Returns whether scattering is enabled or disabled.
• Parameters: Nothing
• Returned Value: Bool: True if scattering is enabled, False if it is disabled.

• Function: void setScatteringEnabled( bool state );
• Description: Sets scattering to enabled or disabled.
• Parameters: Bool status: New scattering state.
• Returned Value: Nothing

• Function: double scattering( void );
• Description: Returns the current scattering value .
• Parameters: Nothing
• Returned Value: Double: scattering value.

• Function: void setScattering( double value );
• Description: Sets the scattering value.
• Parameters: Double value: New scattering value.
• Returned Value: Nothing

• Function: bool vignettingEnabled( void );
• Description: Returns whether vignetting is enabled or disabled.
• Parameters: Nothing
• Returned Value: Bool: True if vignetting is enabled, False if it is disabled.

• Function: void setVignettingEnabled( bool state );
• Description: Sets vignetting to enabled or disabled.
• Parameters: Bool status: New vignetting state.
• Returned Value: Nothing

• Function: double vignetting( void );
• Description: Returns the current vignetting value.
• Parameters: Nothing
• Returned Value: Double: vignetting value.

• Function: void setVignetting( double value );
• Description: Sets the vignetting value.
• Parameters: Double value: New vignetting value.
• Returned Value: Nothing

• Function: void updatePreview( void );
• Description: Updates the preview window with the current settings.
• Parameters: Nothing
• Returned Value: Nothing

• Function: void updateDisplay( void );
• Description: Updates the main display buffer with the current settings.
• Parameters: Nothing
• Returned Value: Nothing

 

Â