
© Next Limit Technologies 2010
Maxwell Render 2.5 User Manual
Chapter 17. Appendix IV. Scripting References | 145
• 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
17.02.05 Scene
• Function: string mxsPath( void );
• Description: Returns the current scene path.
• Parameters: Nothing
• Returned Value: String: scene path
• Function: void setMxsPath( string path );
• Description: Sets the scene path.
• Parameters: String path: New scene path.
• Returned Value: Nothing
• Function: string imagePath( void );
• Description: Returns the current image path.
• Parameters: Nothing
• Returned Value: String: image path.
• Function: void setImagePath( string path );
• Description: Sets the image path.
• Parameters: String path: New image path.
• Returned Value: Nothing
• Function: string mxiPath( void );
• Description: Returns the current MXI path.
• Parameters: Nothing
• Returned Value: String: MXI path.
• Function: void setMxiPath( string path );
• Description: Sets the MXI path.
• Parameters: String path: New MXI path.
• Returned Value: Nothing
• 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
Comentários a estes Manuais