Navigation Messages

Action Messages

• ADD_NAVIGATOR - Adds a new Navigator to the application.

  Parameters:

  • name (unicode) - The name of the new navigator.

  • type (unicode) - The type of navigator to be added: 'Orbit' or 'Walk'. (See "Class NavigationMode" in the Showcase API Reference documentation.)

  • settings (dict) - The Python 'dict' of navigator parameters to be used.

• NAVIGATION_CAMERA_ROTATE - Changes the direction that the camera is pointing.

  Parameters:

  • deltaAzimuth (float) - The change in azimuth in the range [-1,1].

  • deltaElevation (float) - The change in elevation in the range [-1,1].

• NAVIGATION_COMPUTE_ORTHO_PLANE - Given the current navigator, computes the new ortho view plane which is at a given distance away from the camera. This message is broadcastable.

  Parameters:

  • distance (float) - The distance between the camera and the ortho view plane.

• NAVIGATION_GOTO_ORTHO_VIEW - Sets the current navigator's center of interest. This message is broadcastable.

  Parameters:

  • view (unicode) - The ortho view name: 'Left', 'Right', 'Top', 'Bottom', 'Front' or 'Back'.

• NAVIGATION_GOTO_PERSPECTIVE_VIEW - Sets the current navigator's center of interest in perspective view. This message is broadcastable.

  Parameters:

  • view (unicode) - The perspective view names :'Right','Left','Top','Bottom','Front','Back''RightFront','RightBack','RightTop','RightBottom','LeftFront','LeftBack','LeftTop','LeftBottom','TopFront','TopBack','BottomFront','BottomBack','RightTopFront','RightTopBack','RightBottomFront','RightBottomBack','LeftTopFront','LeftTopBack','LeftBottomFront','LeftBottomBack'.

• NAVIGATION_RESET - Resets all the loaded navigators to the Home bookmark.

• NAVIGATION_RESET_COI - Sets the center of interest to whatever is at the center of the screen. This message is broadcastable.

• NAVIGATION_SCROLL - Simulates a mouse scroll forward event. This message is broadcastable. This default maximum wait time for this message is 1.

  Parameters:

  • direction (int) - A positive value scrolls forwards, a negative value scrolls backwards.

• NAVIGATION_SET_COI - Sets the current navigator's center of interest. This message is broadcastable.

  Parameters:

  • coiList (list) - The [x, y, z] coordinates of the new center of interest.

• NAVIGATION_SET_COLLISION_MODE - Sets the collision mode of the current navigator.

  Parameters:

  • mode (unicode) - Any collision mode defined by CollisionMode: 'none', 'slide' or 'stop'. (See "Class CollisionMode" in the Showcase API Reference documentation.)

• NAVIGATION_SET_MODE - Sets the navigation mode. This message is broadcastable. This message will trigger the following response messages: NAVIGATION_MODE_CHANGED. This default maximum wait time for this message is 10.

  Parameters:

  • navName (unicode) - The navigator to be used: 'Orbit' or 'Walk'. (See "Class NavigationMode" in the Showcase API Reference documentation.)

• NAVIGATION_SET_SPEED - Sets the navigation speed. Not to be confused with the speed multiplier. This is a scene-specific speed setting that is saved in the scene and modified in scene preferences. This message is undoable. This message will trigger the following response messages: NAVIGATION_SPEED_CHANGED. This default maximum wait time for this message is 10.

  Parameters:

  • type (unicode) - The type of navigator whose speed has changed: 'Orbit' or 'Walk'. (See "Class NavigationMode" in the Showcase API Reference documentation.)

  • speed (float) - Requested speed the navigator be set to. The default value is 1.0.

• NAVIGATION_SET_SPEED_FACTOR - Sets the navigation speed factor. This factor is multiplied by the current speed value.

  Parameters:

  • type (unicode) - The type of navigator whose speed factor is being set: 'Orbit' or 'Walk'. (See "Class NavigationMode" in the Showcase API Reference documentation.)

  • x factor (float) - Speed factor in the x direction.

  • y factor (float) - Speed factor in the y direction.

  • z factor (float) - Speed factor in the z direction.

• NAVIGATION_SET_VIEW - Updates the view in the current navigator with the specified location and center of interest. This message is broadcastable.

  Parameters:

  • navState (orState.NavigatorSta) - A NavigatorState holding the new position and look at point. (See "NavigatorState" in the Showcase API Reference documentation.)

• NAVIGATION_SPEED_MULTIPLIER - Applies a new speed to all navigators, and updates the heads up display.

  Parameters:

  • multiplier (float) - Value for the new speed multiplier.

• NAVIGATION_SWITCH_COLLISION_MODE - Switches from one collision mode to another. A check is first performed to determine if collision detection is on. If it is, the appropriate mode is enabled.

  Parameters:

  • mode (unicode) - The collision mode: 'slide' or 'stop' ('none' does not apply). (See "Class CollisionMode" in the Showcase API Reference documentation.)

• NAVIGATION_TARGET - Moves the target around with the joystick.

  Parameters:

  • x (float) - The x value in the range [0,1], where 0 is left and 1 is right.

  • y (float) - The y value in the range [0,1], where 0 is up and 1 is down.

• NAVIGATION_TARGET_CHANGE_SPEED - Changes the speed at which the targeting cursor moves.

  Parameters:

  • Delta (int) - The change in speed in the range [-1,1], where -1 slows down one step, and 1 speeds up one step.

• NAVIGATION_TARGET_START - Starts targetting with the joystick.

  Parameters:

  • x (float) - The x value in the range [0,1], where 0 is left and 1 is right.

  • y (float) - The y value in the range [0,1], where 0 is up and 1 is down.

• NAVIGATION_TARGET_STOP - Finishes moving the target around.

  Parameters:

  • x (float) - The x value in the range [0,1], where 0 is left and 1 is right.

  • y (float) - The y value in the range [0,1], where 0 is up and 1 is down.

• NAVIGATION_TOGGLE_MODE - Switches between the navigation modes. This message is broadcastable.

Information Messages

• NAVIGATION_CAMERA_POSITION_CHANGED - New camera position has been set.

  Parameters:

  • cameraPosition (tuple) - Value for the new camera Position.

  • lookAtPosition (tuple) - Value for the new look at position

• NAVIGATION_CAMERA_ROLL_CHANGED - Indicates that the camera roll has been adjusted, so that UI elements can update.

  Parameters:

  • roll (float) - The new camera roll in radians.

• NAVIGATION_CAMERA_ROTATE_START - Indicates that the rotation of the camera is starting. (Sent by a joystick controller.)

• NAVIGATION_CAMERA_ROTATE_STOP - Indicates that the rotation of the camera is stopping. (Sent by a joystick controller.)

• NAVIGATION_POSITION - Updates the view in the current navigator with the given location and center of interest. This message is broadcastable.

  Parameters:

  • navState (orState.NavigatorSta) - A NavigatorState holding the new position and look at point. (See "NavigatorState" in the Showcase API Reference documentation.)

• NAVIGATION_USER_IS_NAVIGATING - Indicates that the user is attempting navigation.

Response Messages

• NAVIGATION_MODE_CHANGED - Indicates that the current navigation mode was changed.

  Parameters:

  • mode (unicode) - The name of the new mode.

• NAVIGATION_SPEED_CHANGED - Indicates a change in navigator speed.

  Parameters:

  • type (unicode) - The type of navigator whose speed was changed.

  • speed (float) - The current speed of the navigator.