Render Messages

Action Messages

• ENABLE_ALTERNATIVE_RT_SELECTION - Alternative selection mode in Ray Tracing. This message is broadcastable.

  Parameters:

  • disable (bool) - Alternative Ray Tracing selection enable/disable

• RT_CLUSTER_SWITCH - Ray Tracing Cluster is used when the switch is on. OpenGL or single machine ray tracing is used when the switch is off. This message is broadcastable.

  Parameters:

  • enable (bool) - Ray Tracing Cluster enable/disable

• RT_CLUSTER_SWITCH_REQUEST - This is a request to toggle Ray Tracing Cluster on/off. The actual switch is caused by a delayed RT_CLUSTER_SWITCH message.

  Parameters:

  • enable (bool) - Ray Tracing Cluster enable/disable request

• RT_SWITCH - Ray Tracing is used when the switch is on. Normal tringle raster mode is used when the switch is off. This message is broadcastable. This default maximum wait time for this message is 10000.

  Parameters:

  • enable (bool) - Ray Tracing enable/disable

• RT_SWITCH_REQUEST - This is a request to toggle Ray Tracing on/off. The actual switch is caused by RT_SWITCH which is delayed after RT_SWITCH_REQUEST has arrived.

  Parameters:

  • enable (bool) - Ray Tracing enable/disable request

• RT_UI_SET_MODE - Shows or hides the Ray Tracing Control interface.

  Parameters:

  • visible (int) - True to show the interface, False to hide it.

• SET_RT_PRESET_QUALITY - Sets the quality parameters for Raytracing.

  Parameters:

  • minRate (int) - Minumum sampling quality.

  • maxRate (int) - Maximum sampling quality.

  • progressive (bool) - Increase sample quality

  • preset (tuple) - Preset quality for raytracing

• RENDER_SCENE - Renders the scene. This message will trigger the following response messages: RENDER_SCENE_DONE. This default maximum wait time for this message is 300.

  Parameters:

  • unknown (unicode)

Response Messages

• RENDER_SCENE_DONE - Indicates the the scene render is finished.

  Parameters:

  • unknown ()

• VIEWER_LAYOUT - Indicates that the window has been set into multiple viewports

  Parameters:

  • viewportNameAndMask (tuple) - A tuple of (<viewportName>, <visibility mask>) pairs.