Custom UI Messages

Action Messages

• CUSTOM_OVERLAY_SET_MODE - Control the visibility of a particular custom overlay interface, created with a plug-in.

  Parameters:

  • customOverlayName (str) - The user defined, unique name of the custom overlay interface to control.

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

• CUSTOM_UI_ACTIVATE - Switches to the given UI name, providing it was properly created. An invalid name will remove the custom UI. This message will trigger the following response messages: CUSTOM_UI_ACTIVATED. This default maximum wait time for this message is 10.

  Parameters:

  • uiName (unicode) - The name of the custom UI as specified in the scene file.

• CUSTOM_UI_ADD - Adds the specified custom UI to the custom UI list. If either the name or the page already exists the entry is replaced. The name is searched for first, then the page. Use the layout and leadWin parameters to position the UI in the application window, as follows: left - 'row', 'browser'; right - 'row', '3d'; top - 'column', 'browser'; bottom - 'column', '3d'. This message will trigger the following response messages: CUSTOM_UI_ADDED. This default maximum wait time for this message is 10.

  Parameters:

  • activate (bool) - True to activate the added page.

  • name (unicode) - The name for the custom UI. Used in CUSTOM_UI_ACTIVATE.

  • page (unicode) - Filename or URL.

  • layout (unicode) - The layout orientation: 'row' or 'column'.

  • leadWin (unicode) - The window that displays first: 'browser' or '3d'.

  • uiSize (int) - The size of the custom UI panel in pixels.

• CUSTOM_UI_SASH_SIZE - Sets the size of the sash separating the custom UI from the 3D window.

  Parameters:

  • size (int) - Set the size of the sash. The default is 2. If set to 0 or a negative number, the sash will not be movable.

• CUSTOM_UI_SET_LAYOUT - Changes the layout of the custom UI. Use the layout and leadWin parameters to position the UI in the application window, as follows: left - 'row', 'browser'; right - 'row', '3d'; top - 'column', 'browser', bottom - 'column', '3d'. This message will trigger the following response messages: CUSTOM_UI_LAYOUT_CHANGED. This default maximum wait time for this message is 10.

  Parameters:

  • name (unicode) - The name of the layout to change. If empty, changes the default.

  • layout (unicode) - The layout orientation: 'row' or 'column'.

  • leadWin (unicode) - The window that displays first: 'browser' or '3d'.

  • uiSize (int) - The size of the custom UI panel in pixels.

• CUSTOM_UI_SET_VISIBILITY - Sets the custom UI visibility.

  Parameters:

  • visibility (bool) - True to display the custom UI, False to hide it.

Information Messages

• CUSTOM_UI_LOADED - Indicates that a custom UI has loaded. The layout and leadWin parameters describe the position of the UI in the application window, as follows: left - 'row', 'browser'; right - 'row', '3d'; top - 'column', 'browser'; bottom - 'column', '3d'.

  Parameters:

  • page (unicode) - Filename or URL of the loaded interface.

  • layout (unicode) - The layout orientation: 'row' or 'column'.

  • leadWin (unicode) - The window that displays first: 'browser' or '3d'.

  • uiSize (int) - The size of the custom UI panel in pixels.

Response Messages

• CUSTOM_UI_ACTIVATED - Indicates that the custom UI has been changed to a different one.

  Parameters:

  • uiName (unicode) - The name of the custom UI that is currently active.

• CUSTOM_UI_ADDED - Indicates that a new custom UI was added. The layout and leadWin parameters describe the position of the UI in the application window, as follows: left - 'row', 'browser'; right - 'row', '3d'; top - 'column', 'browser'; bottom - 'column', '3d'.

  Parameters:

  • name (unicode) - The name of the added the custom UI. Used in CUSTOM_UI_ACTIVATE.

  • page (unicode) - Filename or URL.

  • layout (unicode) - The layout orientation: 'row' or 'column'.

  • leadWin (unicode) - The window that displays first: 'browser' or '3d'.

  • uiSize (int) - The size of the custom UI panel in pixels.

• CUSTOM_UI_LAYOUT_CHANGED - Indicates that the custom UI has been modified. The layout and leadWin parameters describe the position of the UI in the application window, as follows: left - 'row', 'browser'; right - 'row', '3d'; top - 'column', 'browser'; bottom - 'column', '3d'.

  Parameters:

  • name (unicode) - The name of the layout that was modified.

  • layout (unicode) - The layout orientation: 'row' or 'column'.

  • leadWin (unicode) - The window that displays first: 'browser' or '3d'.

  • uiSize (int) - The size of the custom UI panel in pixels.

• CUSTOM_UI_VISIBILITY_CHANGED - Indicates that the visibility status of the custom UI dialog changed. This message will trigger the following response messages: CUSTOM_UI_VISIBILITY_CHANGED. This default maximum wait time for this message is 10.

  Parameters:

  • visibility (bool) - True if visible, False otherwise.