UI Messages

Action Messages

• CLIP_SHOW_GRIPS - Shows the clip grips.

  Parameters:

  • showClipGrips (bool) - True to display clip grips, False to hide them.

• COI_SET_MODE - Sets the Center of Interest mode.

  Parameters:

  • visible (bool) - True or False.

• DIALOG_DESTROY - A dialog sends this message when it wants to be destroyed. This message is only necessary when the dialog is receiving and handling messages (i.e., the dialog previously sent a DIALOG_INTERPRETER_ADD message); this ensures that the dialog does not continue to receive messages while it is being destroyed. This message is not necessary if the dialog is to be destroyed on QUIT.

  Parameters:

  • dialog ('wx._core.Window) - The instance of the dialog to be destroyed.

  • dialogId (unicode) - The dialog identifier matching the DialogFactory show() call (typically an empty string).

• HEADS_UP_DISPLAY_SET_MESSAGE - Show the message on the heads up display.

  Parameters:

  • messageText (unicode) - The text of the message to display.

• HEADS_UP_DISPLAY_SET_MODE - Sets the Heads Up Display mode.

  Parameters:

  • visible (bool) - True to turn Heads Up Display on, False to turn it off.

• HEADS_UP_DISPLAY_SET_MODE_ITEM - Sets the Heads Up Display mode for a specified item.

  Parameters:

  • item (unicode) - What to control. Choices are framerate (for frames per second values), info (for informational and warnings messages), speed (for navigation speed) and session (for hosted session information)

  • visible (bool) - True to turn Heads Up Display on, False to turn it off for the item.

• SCREEN_SET_MODE - Sets the screen mode.

  Parameters:

  • mode (unicode) - 'Fullscreen' or 'Window'.

• SET_BACKPLATE_DRAW_ROOT - Sets a new scene backplate draw root node. All objects that need to be drawn orthographically at the back are attached to this root.

  Parameters:

  • plateDrawRoot ('RTFapi.ProjectionRef) - The node to be set as the new backplate draw root. (See "awScene::Projection" in the Showcase API Reference documentation.)

• SET_DISPLAY - Sets the display to the value specified in the first argument.

  Parameters:

  • display ('RTFapi.Display) - The new value for the display.

• SET_DISPLAY_BACKGROUND_COLOR - Set the background color to the specified value.

  Parameters:

  • red (float) - Red channel value between 0 and 1.

  • green (float) - Green channel value between 0 and 1.

  • blue (float) - Blue channel value between 0 and 1.

• SET_DISPLAY_POSITION_AND_SIZE - Resets the display size and location on the screen. If the values are invalid, the size and location will not change.

  Parameters:

  • horizontal (int) - The position of the screen on the horizontal axis.

  • vertical (int) - The position of the screen on the vertical axis.

  • width (int) - The display size in the horizontal direction.

  • height (int) - The display size in the vertical direction.

• SET_DISPLAY_SIZE - Resets the display size on the screen. If the values are invalid, the size will not change.

  Parameters:

  • width (int) - The display size in the horizontal direction.

  • height (int) - The display size in the vertical direction.

• STATUSBAR_SET_TEXT - Sends the string to the status bar.

  Parameters:

  • tex (unicode) - The text to show in the status bar.

• UI_ANNOTATION_CHANGED - Indicates that an annotation has changed. This message is broadcastable.

  Parameters:

  • annotationList (list) - List of items that changed.

• UI_CONFIRM_DIALOG - Opens a modal confirm dialog box.

  Parameters:

  • title (unicode) - The window title to display on the dialog. If the string is empty, the title defaults to the product name.

  • message (unicode) - The message string to display within the dialog.

  • button (unicode) - A button title to display within the dialog. If the string is empty, an OK button is displayed.

• UI_CONFIRM_DIALOG_CALLBACK - Opens a modal confirm dialog box.

  Parameters:

  • title (unicode) - The window title to display on the dialog. If the string is empty, the title defaults to the product name.

  • message (unicode) - The message string to display within the dialog.

  • buttons (tuple) - The button titles to display within the dialog. If the tuple is empty, an OK button displays. The tuple must not contain any empty strings.

  • callback (instancemethod) - A callback to be invoked with the title of the selected button.

• UI_DEFER_POPUP_MENU - Causes an equivalent UI_DISPLAY_POPOP_MENU to be queued, the result being equivalent to invoking UI_DISPLAY_POPOP_MENU except that the menu is delayed by one message cycle thus allowing other messages to be processed before the modal menu is invoked.

  Parameters:

  • title (unicode) - The title to display in the menu (if any).

  • popupMenu (list) - A list of menu items. (See "Class GenericPopupMenuItem" in the Showcase API Reference documentation.)

• UI_DISPLAY_POPUP_MENU - Invokes a popup menu under the current cursor position.

  Parameters:

  • title (unicode) - The title to display in the menu (if any).

  • popupMenu (list) - A list of menu items. (See "Class GenericPopupMenuItem" in the Showcase API Reference documentation.)

• UI_NUMERICAL_INPUT_IN_PLACE - Invokes a numerical input text box on the screen.

  Parameters:

  • value (float) - The current value to display.

  • field (tuple) - The position for the field.

  • size (tuple) - The size of the field.

  • message (unicode) - The name of the application message that will be sent when the user presses Enter.

  • function (object) - A callable function that will take the value and return valid message data for the given message.

• UI_NUMERICAL_LENGTH_INPUT_IN_PLACE - Invokes a numerical input text box on the screen. Allows user to enter numbers with supported units such as 1m or 1cm.

  Parameters:

  • value (float) - The current value to display.

  • field (tuple) - The position for the field.

  • size (tuple) - The size of the field.

  • message (unicode) - The name of the application message that will be sent when the user presses Enter.

  • function (object) - A callable function that will take the value and return valid message data for the given message.

  • lengthUnit (str) - The length unit in use.

• UI_OPEN_INPUT_DIALOG - Opens a modal dialog box requesting an input string from the user.

  Parameters:

  • title (unicode) - The window title to display on the dialog.

  • prompt (unicode) - The prompt string to display within the dialog box.

  • callback (instancemethod) - A callback function to be invoked upon success with the input string and the userdata parameter.

  • initial (unicode) - An initial value for the input string (if any).

  • userdata (tuple) - The user data to be returned to the callback function.

• UI_RENAME_IN_PLACE - Invokes a rename input box on the screen.

  Parameters:

  • oldName (unicode) - The current name of the object.

  • position (tuple) - The position where the field should appear.

  • size (tuple) - The size of the field.

  • message (unicode) - The message that should be sent when the rename is completed.

  • userdata (tuple) - The data to be sent with the message. Note that the new name will be added to the end.

• UI_TOOLTIP - Opens a window that looks like a tooltip. This window floats over all others so it cannot be clobbered by a redraw of, say, the 3D viewport. To hide the tooltip, set the text to "".

  Parameters:

  • text (unicode) - The tooltip text.

• UI_TOOLTIP_ENABLE - Specifies whether the display of popup tooltips should be enabled or disabled. Pass true to enable and false to disable. Tooltips are enabled by default.

  Parameters:

  • state (bool) - Boolean flag indicating the desired enable state.

• UI3D_COI_SET_POSITION - Positions the center of interest icon.

  Parameters:

  • x (float) - X location for the icon.

  • y (float) - Y location for the icon.

  • z (float) - Z location for the icon.

• UI3D_COI_SET_VISIBLE - Shows or hides the center of interest icon.

  Parameters:

  • showOrHide (bool) - True to show the center of interest icon, False to hide the icon.

• VIEW_CUBE_SET_PROPERTIES - Change the properties of the view cube. This message is undoable.

  Parameters:

  • properties (eManipulator.ViewCubeProperti) - An instance of the ViewCubeProperties class

• VIEW_CUBE_SHOW_PROPERTIES - Shows the properties window for the view cube.

• VIEWER_SET_LAYOUT - Splits the window into multiple viewports. For example, two viewports side-by-side will split the window into left and right sides, with matching camera positions. This message is broadcastable. This message will trigger the following response messages: VIEWER_LAYOUT. This default maximum wait time for this message is 10.

  Parameters:

  • howMany (int) - The number of viewports. Currently, the maximum number is 2.

  • layout (unicode) - 'SideBySide' or 'Single'.

• WINDOW_SET_SIZE - Sets the size of the main window. Also automatically resizes the display.

  Parameters:

  • width (int) - The new width of the main window.

  • height (int) - The new height of the main window.

• WINDOW_SHOW_BORDERS - Hides/Shows the main window's borders.

  Parameters:

  • show (bool) - True to show borders, False to hide them.

Information Messages

• DISPLAY_BACKGROUND_COLOR_CHANGED - Information message sent when the background color changes.

  Parameters:

  • red (float) - Red channel value between 0 and 1.

  • green (float) - Green channel value between 0 and 1.

  • blue (float) - Blue channel value between 0 and 1.

• HEADS_UP_DISPLAY_MODE_CHANGED - Indicates that the Heads Up Display mode changed.

  Parameters:

  • visibleInfo (bool) - Are informational messages visible in the HUD, True or False.

  • visibleFramerate (bool) - Is framerate visible in the HUD, True or False.

  • visibleSpeed (bool) - Is speed indication visible in the HUD, True or False.

  • visibleSession (bool) - Is network session information visible in the HUD, True or False.

• VIEW_CUBE_PROPERTIES_CHANGED - An information message indicating that the properties of the view cube have been changed.

  Parameters:

  • properties (eManipulator.ViewCubeProperti) - An instance of the ViewCubePropertiesClass