Scene functions

Owned by dario (Unlicensed)
Last updated: 03 Dec, 2013 by Mihai Iliuta (Unlicensed)Version comment
8 min read

• 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: int time( void );
• Description: Returns the maximum render time specified for the current scene in minutes.
• Parameters: Nothing
• Returned Value: INT: time (in minutes).

• Function: void setTime( int value );
• Description: Sets the maximum render time for the current scene in minutes.
• Parameters: INT value: New time value.
• Returned Value: Nothing

• Function: int samplingLevel( void );
• Description: Returns the maximum sampling level for the current scene.
• Parameters: Nothing
• Returned Value: INT: sampling level.

• Function: void setSamplingLevel( int value );
• Description: Sets the maximum sampling level for the current scene.
• Parameters: INT value: New sampling level value.
• Returned Value: Nothing

• Function: string animationString( void );
• Description: Returns the current frame list.
• Parameters: Nothing
• Returned Value: String: frame list.

• Function: void setAnimationString( string frames );
• Description: Sets the frame list.
• Parameters: String frames: New frame list.
• Returned Value: Nothing

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

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

• Function: int multilightType( void );
• Description: Returns the active Multilight type.

  • 0 = NO MULTILIGHT
  • 1 = INTENSITY MULTILIGHT
  • 2 = COLOR MULTILIGHT

• Parameters: Nothing
• Returned Value: INT: multilightType.

• Function: void setMultilightType( double type );
• Description: Sets the active Multilight type. See multilightType for more info.
• Parameters: Double value: New Multilight type.
• Returned Value: Nothing

• Function: bool resumeRenderEnabled( void );
• Description: Returns whether the resume render flag is enabled or disabled.
• Parameters: Nothing
• Returned Value: Bool: True if resume render is enabled, False if it is disabled.

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

• Function: int cpuID( void );
• Description: Returns the CPU ID for the current scene.
• Parameters: Nothing
• Returned Value: INT: cpu ID

• Function: void setCpuThreads( int value );
• Description: Sets the CPU ID for the current scene.
• Parameters: INT value: New CPU ID.
• Returned Value: Nothing

• Function: int cpuThreads( void );
• Description: Returns the CPU threads for the current scene.
• Parameters: Nothing
• Returned Value: INT: cpu threads

• Function: void setCpuID( int value );
• Description: Sets the CPU threads for the current scene.
• Parameters: INT value: New CPU threads.
• Returned Value: Nothing

• Function: int resX( void );
• Description: Returns the horizontal resolution for the current scene.
• Parameters: Nothing
• Returned Value: INT: horizontal resolution.

• Function: void setResX( int value );
• Description: Sets the horizontal resolution for the current scene.
• Parameters: INT value: New horizontal resolution.
• Returned Value: Nothing

• Function: int resY( void );
• Description: Returns the vertical resolution for the current scene.
• Parameters: Nothing
• Returned Value: INT: vertical resolution.

• Function: void setResY( int value );
• Description: Sets the vertical resolution for the current scene.
• Parameters: INT value: New vertical resolution.
• Returned Value: Nothing

• Function: bool lockAspectRatioEnabled( void );
• Description: Returns whether the lock aspect ratio flag is enabled or disabled.
• Parameters: Nothing
• Returned Value: Bool: True if lock aspect ratio is enabled, False if it is disabled.

• Function: void setLockAspectRatioEnabled( bool state );
• Description: Sets the lock aspect ratio flag to enabled or disabled.
• Parameters: Bool status: New lock aspect ratio state.
• Returned Value: Nothing

• Function: bool overrideMaterialEnabled( void );
• Description: Returns whether the override material flag is enabled or disabled.
• Parameters: Nothing
• Returned Value: Bool: True if override material is enabled, False if it is disabled.

• Function: void setOverrideMaterialEnabled( bool state );
• Description: Sets the override material flag to enabled or disabled.
• Parameters: Bool status: New override material state.
• Returned Value: Nothing

• Function: string overrideMaterialPath( void );
• Description: Returns the current override material path.
• Parameters: Nothing
• Returned Value: String: override material path.

• Function: void setOverrideMaterialPath( string path );
• Description: Sets the override material path.
• Parameters: String path: New override material path.
• Returned Value: Nothing

• Function: string defaultMaterialPath( void );
• Description: Returns the current default material path.
• Parameters: Nothing
• Returned Value: String: default material path.

• Function: void setDefaultMaterialPath( string path );
• Description: Sets the default material path.
• Parameters: String path: New default material path.
• Returned Value: Nothing

• Function: string bitmapsDefaultPath( void );
• Description: Returns the current bitmaps path.
• Parameters: Nothing
• Returned Value: String: bitmaps path.

• Function: void setBitmapsDefaultPath( string path );
• Description: Sets the bitmaps path.
• Parameters: String path: New bitmaps path.
• Returned Value: Nothing

• Function: int getSceneDependenciesCount( void );
• Description: Returns the number of dependencies (external files needed for rendering) of the current scene.
• Parameters: Nothing
• Returned Value: INT: number of files.

• Function: stringlist getSceneDependencies( void );
• Description: Returns the paths of all the dependencies (external files needed for rendering) of the current scene.
• Parameters: Nothing
• Returned Value: List: list of file paths.

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

• Function: void setRenderChannelEnabled( bool state );
• Description: Sets the render channel to enabled or disabled.
• Parameters: Bool status: New render channel state.
• Returned Value: Nothing

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

• Function: void setAlphaChannelEnabled( bool state );
• Description: Sets the alpha channel to enabled or disabled.
• Parameters: Bool status: New alpha channel state.
• Returned Value: Nothing

• Function: bool alphaOpaqueChannelEnabled( void );
• Description: Returns whether the alpha opaque channel is enabled or disabled.
• Parameters: Nothing
• Returned Value: Bool: True if the alpha opaque channel is enabled, False if it is disabled.

• Function: void setAlphaOpaqueChannelEnabled( bool state );
• Description: Sets the alpha opaque channel to enabled or disabled.
• Parameters: Bool status: New alpha opaque channel state.
• Returned Value: Nothing

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

• Function: void setShadowChannelEnabled( bool state );
• Description: Sets the shadow channel to enabled or disabled.
• Parameters: Bool status: New shadow channel state.
• Returned Value: Nothing

• Function: bool materialIDChannelEnabled( void );
• Description: Returns whether the material ID channel is enabled or disabled.
• Parameters: Nothing
• Returned Value: Bool: True if the material ID channel is enabled, False if it is disabled.

• Function: void setMaterialIDChannelEnabled( bool state );
• Description: Sets the material ID channel to enabled or disabled.
• Parameters: Bool status: New material ID channel state.
• Returned Value: Nothing

• Function: bool objectIDChannelEnabled( void );
• Description: Returns whether the object ID channel is enabled or disabled.
• Parameters: Nothing
• Returned Value: Bool: True if the object ID channel is enabled, False if it is disabled.

• Function: void setObjectIDChannelEnabled( bool state );
• Description: Sets the object ID channel to enabled or disabled.
• Parameters: Bool status: New object ID channel state.
• Returned Value: Nothing

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

• Function: void setMotionChannelEnabled ( bool state );
• Description: Sets the motion vector channel to enabled or disabled.
• Parameters: Bool status: New motion vector channel state.
• Returned Value: Nothing

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

• Function: void setZBufferChannelEnabled( bool state );
• Description: Sets the ZBuffer channel to enabled or disabled.
• Parameters: Bool status: New ZBuffer channel state.
• Returned Value: Nothing

• Function: int zBufferMin( void );
• Description: Returns the minimum Z depth value of the Z buffer channel.
• Parameters: Nothing
• Returned Value: INT: minimum Z value.

• Function: void setZBufferMin( int value );
• Description: Sets the minimum Z depth value of the Z buffer channel.
• Parameters: INT value: New minimum Z depth value.
• Returned Value: Nothing

• Function: int zBufferMax( void );
• Description: Returns the maximum Z depth value of the Z buffer channel.
• Parameters: Nothing
• Returned Value: INT: maximum Z value.

• Function: void setZBufferMax( int value );
• Description: Sets the maximum Z depth value of the Z buffer channel.
• Parameters: INT value: New maximum Z depth value.
• Returned Value: Nothing

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

• Function: void setRoughnessChannelEnabled( bool state );
• Description: Sets the roughness channel to enabled or disabled.
• Parameters: Bool status: New roughness channel state.
• Returned Value: Nothing

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

• Function: void setFresnelChannelEnabled( bool state );
• Description: Sets the Fresnel channel to enabled or disabled.
• Parameters: Bool status: New Fresnel channel state.
• Returned Value: Nothing

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

• Function: void setDiffusePassEnabled( bool state );
• Description: Sets the diffuse pass to enabled or disabled.
• Parameters: Bool status: New diffuse pass state.
• Returned Value: Nothing

• Function: int renderChannelType( void );

  • 0 = DIFFUSE + REFLECTIONS
  • 1 = DIFFUSE
  • 2 = REFLECTIONS

• Description: Returns the active render type.
• Parameters: Nothing
• Returned Value: int: Active render type.

• Function: void setRenderChannelType( int type );
• Description: Sets the render channel type.
• Parameters: int type: New render type.
• Returned Value: Nothing