Viewer Messages

Action Messages

• DISPLAY_ANTIALIASING_ON_IDLE - Toggles an option to enable or increase the anti-aliasing quality when there is an idle event.

  Parameters:

  • enableAntiAliasOnIdle (bool) - True to enable the quality of the anti-aliasing on idle events.

  • increaseAntiAliasOnIdle (bool) - True to gradually increase the quality of the anti-aliasing on idle events, False to increase it immediately to the highest level.

• DISPLAY_AUTO_MIN_ANTIALIAS - Sets the minimum anti-aliasing quality when the automatic quality is on. For no minimum quality, set minQuality to 0.

  Parameters:

  • minAntiAliasLevel (int) - The minimum anti-aliasing quality: (0-9).

• DISPLAY_DISABLE_ANTIALIAS_DRAW - Disables the anti-alias draw.

  Parameters:

  • disableAntiAliasDraw (bool) - True to disable anti-alias draw, False to enable it.

• DISPLAY_IGNORE_IDLE_REFRESH - Ignores the idle refresh to avoid starting the anti-alias draw.

  Parameters:

  • ignoreIdleRefresh (bool) - True to ignore, False otherwise.

• DISPLAY_IMPROVE_ON_IDLE - Toggles an option to improve the quality of the models (level of detail) when there is idle event.

  Parameters:

  • improveOnIdle (bool) - True to improve the quality of the models on idle events.

• DISPLAY_LOCK_ANTIALIAS - Locks the scene anti-aliasing setting at the given value.

  Parameters:

  • lockAntiAliasLevel (int) - The scene anti-aliasing value: (0-9)

• DISPLAY_ONE_TO_ONE - Enables or disables the 1:1 mode. This message is broadcastable.

  Parameters:

  • enable (bool) - True to enable, False to disable.

• DISPLAY_ONE_TO_ONE_REQUEST_PARAMETERS - Used by the host to trigger other messages which any listening clients then use to synchronize themselves with the host's 1:1 state.

• DISPLAY_RESET - Clear display before closing scene, to avoid crashes when different threads modify same data

• DISPLAY_SET_NEAR_CLIP - Sets the distance from the camera to the near clip plane. This is the distance the near clip is set to *IF* the camera is inside the environment. Outside the environment, the display clip will be set to fit the entire model in the view. This message is broadcastable.

  Parameters:

  • nearDistance (float) - The near clipping plane distance.

• DISPLAY_SET_ONE_TO_ONE_DISTANCE - Sets how far the ortho camera should be from the ortho plane to display objects in real world scale.

  Parameters:

  • distance (float) - Distance from the ortho camera eye to the ortho plane (0).

• DISPLAY_SET_PROJECTION_MODE - Sets the display to the specified projection mode. This message is broadcastable.

  Parameters:

  • mode (unicode) - The display projection mode: 'Orthographic' or 'Perspective'. (See "Class ProjectionMode" in the Showcase API Reference documentation.)

• DISPLAY_SET_VERTICAL_FOV - Adjusts the field of view to the specified value (in degrees). If reposition is set to true, the camera's location is also adjusted to keep objects at the COI distance a constant size in the view. This message is broadcastable. This message will trigger the following response messages: DISPLAY_VERTICAL_FOV_CHANGED. This default maximum wait time for this message is 10.

  Parameters:

  • fov (float) - The new vertical field-of-view in degrees.

  • reposition (bool) - True if the camera is to be repositioned, False otherwise.

• DISPLAY_SET_VIEWPORT_SPLIT - Sets the display viewport to split across multiple clients/machines so that each system renders only a sub-region of the current view. Sets how the screen is to be sub-divided and which of the sub-divisions to display.

  Parameters:

  • enabled (bool) - True to enable the viewport split, False to disable it.

  • columns (int) - The number of columns to split the display into.

  • rows (int) - The number of rows to split the display into.

  • columnIndex (int) - The column coordinate of the cell that the current display is to show. Column 0 refers to the left-most column.

  • rowIndex (int) - The row coordinate of the cell that the current display is to show. Row 0 refers to the top-most row.

  • horizontalOverlap (int) - The pixel overlap of each cell with its neighbors in the horizontal direction.

  • verticalOverlap (int) - The pixel overlap of each cell with its neighbors in the vertical direction.

• DISPLAY_UPDATE_CALIBRATIONS - Creates/updates the set of 1:1 display calibrations and the current calibration index.

  Parameters:

  • calibrations (tionPreferenceIO.CalibrationDataLi) - Calibrations preferences. (See "CalibrationDataList" object in the Showcase API Reference documentation.)

• LOCK_LOD - Locks the level of detail on all objects to the given percentage. This default maximum wait time for this message is 10.

  Parameters:

  • percent (int) - The level of detail on all objects: percentage (0-100).

• LOCK_MIN_FPS - Sets a minumum framerate. The viewer will try to keep the framerate above the given value. However, it will not let the level of detail quality go below the given percentage.

  Parameters:

  • fps (int) - The minimum frame rate.

  • minQuality (int) - The minimum level of detail quality: percentage (0-100). For no minimum quality, set to 0.

• RESET_DISPLAY_BACKGROUND_COLOR - Reset the background color to the default value.

• SET_DRAW_MODE - Sets the draw mode to a particular style. This message is broadcastable.

  Parameters:

  • style (unicode) - The draw style: WIREFRAME or SHADED. (See "Class DrawMode" in the Showcase API Reference documentation.)

• SET_DRAW_ROOT - Sets a new scene draw root node. All objects are attached to this root.

  Parameters:

  • drawRoot ('RTFapi.GroupRef) - The group node to be set as the new draw root. (See "awScene::Group" in the Showcase API Reference documentation.)

• SET_ORTHO_DRAW_ROOT - Sets a new scene orthographic draw root node. All objects that need to be drawn orthographically are attached to this root.

  Parameters:

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

• SET_VIEWER_WINDOW - Specifies the window object containing the viewer. This message is sent during UI initialization to notify interested interpreters.

  Parameters:

  • window ('wx._core.Window) - The window object. (For information, refer to the wxPython GUI toolkit documentation.)

Information Messages

• APPLICATION_VIEW_POSITION_AND_SIZE_CHANGED - Indicates that the view (main window) size and location have changed.

  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.

  • state (unicode) - The state of the window: 'Window', 'FullScreen', 'Iconized' or 'Maximized'.

• DISPLAY_PROJECTION_MODE_CHANGED - Indicates that the projection mode changed. (Response message to DISPLAY_SET_PROJECTION_MODE.)

  Parameters:

  • mode (unicode) - The current projection mode: 'Orthographic' or 'Perspective'.

• DISPLAY_VIEWPORT_SPLIT_CHANGED - Indicates that the display viewport values have changed. Indicates the current screen sub-divisions and which of the sub-divisions is being displayed.

  Parameters:

  • enabled (bool) - True indicates the viewport split is enabled, False indicates the split is disabled.

  • columns (int) - The number of columns in the split display.

  • rows (int) - The number of rows in the split display.

  • columnIndex (int) - The column coordinate of the cell of the current display. Column 0 refers to the left-most column.

  • rowIndex (int) - The row coordinate of the cell of the current display. Row 0 refers to the top-most row.

  • horizontalOverlap (int) - The pixel overlap of each cell with its neighbors in the horizontal direction.

  • verticalOverlap (int) - The pixel overlap of each cell with its neighbors in the vertical direction.

• DRAW_MODE_CHANGED - Indicates that the draw mode has changed.

  Parameters:

  • style (unicode) - The draw style: 'WIREFRAME' or 'SHADED'.

Response Messages

• DISPLAY_NEAR_CLIP_CHANGED - Indicates that the near clip plane distance has been modified. This distance is the near clip *IF* the camera is inside the environment. Outside the environment, the display clip will be set to fit the entire model in the view. This message will trigger the following response messages: DISPLAY_NEAR_CLIP_CHANGED. This default maximum wait time for this message is 10.

  Parameters:

  • nearDistance (float) - The modified near clip plane distance.

• DISPLAY_VERTICAL_FOV_CHANGED - Indicates that the vertical FOV has been adjusted, so that UI elements can update themselves.

  Parameters:

  • fov (float) - The new vertical field-of-view in degrees.