Navigation Messages

• ADD_NAVIGATOR - Adds a new Navigator to the application.

  Parameters:

  • name - The name of the new navigator.

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

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

• BOOKMARK_ARRIVE - Arrives at the current bookmark.

• BOOKMARK_CREATE - Creates a bookmark at the current location.

  Parameters:

  • name - The name of the new bookmark.

• BOOKMARK_CREATED - Indicates that a new bookmark has just been created.

  Parameters:

  • name - The name of the new bookmark.

• BOOKMARK_FIT_TEMP_TO_VIEW - Temporarily sets a bookmark that has been adjusted to fit the contents of the scene to view, and interpolates towards it. The bookmark is not saved.

  Parameters:

  • bState - Tuple consisting of the navigator name, bookmark name, center of interest, position and stepper. Possible steppers are: NavigatorStateTransitions.ShotKeyframeStep, NavigatorStateTransitions.VectorStep, NavigatorStateTransitions.LinearStep.

  • useTransition - True to use a transition to the new bookmark.

• BOOKMARK_GOTO - Jumps to the given bookmark name. The bookmark must exist in the current scene.

  Parameters:

  • name - The name of the bookmark to go to.

  • useTransition - True to use a transition to the new bookmark.

• BOOKMARK_GOTO_TEMP - Temporarily sets a bookmark and interpolates towards it. The bookmark is not saved.

  Parameters:

  • bState - Tuple consisting of the navigator name, bookmark name, center of interest, position and stepper. Possible steppers are: NavigatorStateTransitions.ShotKeyframeStep, NavigatorStateTransitions.VectorStep, NavigatorStateTransitions.LinearStep.

  • useTransition - True to use a transition to the new bookmark.

• BOOKMARK_HOME - Jumps to the Home Bookmark.

  Parameters:

  • useTransition - True to use a transition to the new bookmark.

  • fitToView - True to fit to view.

• BOOKMARK_INITIAL - Jumps to the initial bookmark.

  Parameters:

  • useTransition - True to use a transition.

• BOOKMARK_LIST - Lists all bookmarks available for the current scene.

  Parameters:

  • bookList - List of bookmark names.

• BOOKMARK_REMOVE - Requests the removal the named bookmark.

  Parameters:

  • name - The name of the bookmark to remove.

• BOOKMARK_REMOVED - Indicates that a named bookmark was removed.

  Parameters:

  • name - The name of the bookmark that was removed.

• BOOKMARK_REQUEST_LIST - Requests that a new BOOKMARK_LIST message be issued.

• BOOKMARK_SET - Sets the bookmark with the arguments. The arguments must be a tuple consisting of the navigator name, bookmark name, center of interest, position and stepper; otherwise it has no effect.

  Parameters:

  • bState - Tuple consisting of the navigator name, bookmark name, center of interest, position and stepper. Possible steppers are: NavigatorStateTransitions.ShotKeyframeStep, NavigatorStateTransitions.VectorStep, NavigatorStateTransitions.LinearStep.

• BOOKMARK_SET_HOME - Sets the Home Bookmark to the specified bookmark.

  Parameters:

  • bookmarkName - The name of the new home bookmark.

• BOOKMARK_SET_INITIAL - Sets the initial bookmark at the current location.

• BOOKMARK_STOP - Stops the current bookmark.

  Parameters:

  • stopTransition - True to set the view transition to 'None'.

• KYNAPSE_CREATE_NAVIGATION_MESH - Creates navigation mesh from the current (or selected?) scene geometry.

• KYNAPSE_ENABLE - Enables or disables Kynapse navigation.

  Parameters:

  • enable - True to enable Kynapse navigation, False to disable.

• KYNAPSE_ENABLED - Indicates that Kynapse navigation has been enabled or disabled.

  Parameters:

  • enabled - True if Kynapse navigation is enabled, False if disabled.

• KYNAPSE_NAVIGATION_MESH_CHANGED - Indicates that a navigation mesh has changed.

• NAVIGATION_BAR_SET_PROPERTIES - Change the properties of the navigation bar.

  Parameters:

  • properties - An instance of the NavBarProperties class

• NAVIGATION_CAMERA_POSITION_CHANGED - New camera position has been set.

  Parameters:

  • cameraPosition - Value for the new camera Position.

  • lookAtPosition - 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 - The new camera roll in radians.

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

  Parameters:

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

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

• 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_COLLISION_MODE_CHANGED - Indicates that the collision mode has changed.

  Parameters:

  • mode - The new collision mode.)

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

  Parameters:

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

• NAVIGATION_GOTO_ORTHO_VIEW - Sets the current navigator's center of interest.

  Parameters:

  • view - 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.

  Parameters:

  • view - 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_GOTO_PREVIOUS_VIEW - Moves the camera to the previous position.

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

  Parameters:

  • mode - The name of the new mode.

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

  Parameters:

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

• 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.

• NAVIGATION_SCROLL - Simulates a mouse scroll forward event.

  Parameters:

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

• NAVIGATION_SET_CAMERA_HEIGHT - Set a new camera height.

  Parameters:

  • height - Value for the new camera height.

• NAVIGATION_SET_CAMERA_POSITION - Set a new camera position and look at point.

  Parameters:

  • cameraPosition - Value for the new camera Position.

  • lookAtPosition - Value for the new look at position

• NAVIGATION_SET_CAMERA_ROLL - Adjusts the camera roll to the specified value (in radians).

  Parameters:

  • roll - The new camera roll in radians.

• NAVIGATION_SET_COI - Sets the current navigator's center of interest.

  Parameters:

  • coiList - 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 - 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.

  Parameters:

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

• NAVIGATION_SET_POSITION - Updates the camera position of the current navigator with the specified location.

  Parameters:

  • pos_x - x coordinate of the camera position.)

  • pos_y - y coordinate of the camera position.)

  • pos_z - z coordinate of the camera position.)

• 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.

  Parameters:

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

  • speed - 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 - The type of navigator whose speed factor is being set: 'Orbit' or 'Walk'. (See "Class NavigationMode" in the Showcase API Reference documentation.)

  • x factor - Speed factor in the x direction.

  • y factor - Speed factor in the y direction.

  • z factor - Speed factor in the z direction.

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

  Parameters:

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

• NAVIGATION_SPEED_CHANGED - Indicates a change in navigator speed.

  Parameters:

  • type - The type of navigator whose speed was changed.

  • speed - The current speed of the navigator.

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

  Parameters:

  • multiplier - 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 - 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 - The x value in the range [0,1], where 0 is left and 1 is right.

  • y - 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 - 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 - The x value in the range [0,1], where 0 is left and 1 is right.

  • y - 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 - The x value in the range [0,1], where 0 is left and 1 is right.

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

• NAVIGATION_TOGGLE_MODE - Switches between the navigation modes.

• NAVIGATION_USER_IS_NAVIGATING - Indicates that the user is attempting navigation.