NavigationInterpreter.NavigationInterpreter Class Reference

#include <class_navigation_interpreter_1_1_navigation_interpreter.h>

Inheritance diagram for NavigationInterpreter.NavigationInterpreter:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  __init__ ()
  __del__ ()
  activate ()
  Abstract - to be implemented by the subclasses.
  deactivate ()
  Abstract - to be implemented by the subclasses.
  requestViewUpdate ()
  configureEventMapping ()
  Abstract - to be implemented by the subclasses.
  NAVIGATION_AUTOCAM_UPDATE ()
  Frame ()
  SmartNavPrototype ()
  LastView ()
  MoveStart ()
  MoveStop ()
  MoveInNavigation ()
  TargetEnable ()
  Call this action to enable target mode.
  TargetDisable ()
  Call this action to disable target mode.
  TargetStart ()
  Target ()
  TargetStop ()
  TargetHeightStart ()
  Set the active key mappings to TargetHeight.
  TargetHeight ()
  Just ignore this event when in set camera height mode.
  TargetHeightStop ()
  Based on the current intersection point, set the height of the camera and then reset the active key mappings.
  MoveRightStart ()
  MoveRightStop ()
  MoveRightStart2 ()
  MoveRightStop2 ()
  MoveLeftStart ()
  MoveLeftStop ()
  MoveLeftStart2 ()
  MoveLeftStop2 ()
  MoveForwardStart ()
  MoveForwardStop ()
  MoveForwardStart2 ()
  MoveForwardStop2 ()
  MoveBackwardStart ()
  MoveBackwardStop ()
  MoveBackwardStart2 ()
  MoveBackwardStop2 ()
  MoveUpStart ()
  MoveUpStop ()
  MoveUpStart2 ()
  MoveUpStop2 ()
  MoveDownStart ()
  MoveDownStop ()
  MoveDownStart2 ()
  MoveDownStop2 ()
  DollyForward ()
  DollyBackward ()
  IncreaseSpeed ()
  DecreaseSpeed ()
  SetCOI ()
  addNavigator ()
  getNavigator ()
  getNavigationState ()
  getBookmark ()
  initializeView ()
  increaseSpeedMultiplier ()
  Increase the speed of the current navigator.
  decreaseSpeedMultiplier ()
  Decrease the speed of the current navigator.
  getSpeedMultiplier ()
  Return a multiplier affecting the speed of navigation for the current navigator.
  getSpeedMultipliers ()
  setInvertMouse ()
  getInvertMouse ()
  calculatePositionAndCoi ()
  calculateFitToView ()
  SetMoveStart ()
  SetMoveStop ()
  GetMoveStartTime ()
  GetMoveStopTime ()
  accelerationInterval ()
  speed ()
  Return the speed corresponding to the time argument.
  calculateSpeed ()
  Calculate the speed given the current time, the time when movement in a particular direction began and the time that movement in that same direction was stopped.
  doCameraRotation ()
  DOCUMENT_LOADED ()
  APPLICATION_CLOSE_SCENE ()
  MEASUREMENT_MODE_CHANGED ()
  SET_2D_UI_ROOT ()
  CLIENT_CONNECTION_STATUS ()
  NEW_CLIENT_ID ()
  BOOKMARK_ARRIVAL ()
  BOOKMARK_FIT_TEMP_TO_VIEW ()
  Receives a bookmark and generates a new bookmark with the orientation of the original, positioned to fit the contents of the screen to view.
  NAVIGATION_SWITCH_COLLISION_MODE ()
  If collision is enabled, switch the collison mode to the one provided.
  NAVIGATION_SET_COLLISION_MODE ()
  Set the collision mode to the provided one.
  DISPLAY_ONE_TO_ONE ()
  DISPLAY_ONE_TO_ONE_REQUEST_PARAMETERS ()
  DISPLAY_UPDATE_CALIBRATIONS ()
  NAVIGATION_COMPUTE_ORTHO_PLANE ()
  NAVIGATION_UPDATE_ORTHO_VIEW ()
  NAVIGATION_SET_SPEED_FACTOR ()
  calculateOneToOneDistance ()
  NAVIGATION_SET_LAST_VIEWCUBE_VIEW ()
  NAVIGATION_GOTO_VIEWCUBE_ORTHO_VIEW ()
  NAVIGATION_GOTO_ORTHO_VIEW ()
  NAVIGATION_GOTO_PERSPECTIVE_VIEW ()
  NAVIGATION_UPDATE_VIEW ()
  This is the method that actually modifies the camera matrix.
  NAVIGATION_RESET ()
  NAVIGATION_CAMERA_ROTATE_START ()
  NAVIGATION_CAMERA_ROTATE ()
  NAVIGATION_CAMERA_ROTATE_STOP ()
  NAVIGATION_TARGET_START ()
  NAVIGATION_TARGET ()
  NAVIGATION_TARGET_STOP ()
  NAVIGATION_RESET_COI ()
  Set the centre of interest to whatever is at the centre of the screen.
  NAVIGATION_TARGET_CHANGE_SPEED ()
  NAVIGATION_SET_MODE ()
  The message data contains the name of the navigator to switch to.
  NAVIGATION_TOGGLE_MODE ()
  NAVIGATION_SET_VIEW ()
  NAVIGATION_SET_POSITION ()
  NAVIGATION_POSITION_REAL ()
  NAVIGATION_SET_SPEED ()
  ADD_NAVIGATOR ()
  APPLICATION_MODE_CHANGED ()
  NAVIGATION_SET_COI ()
  NAVIGATION_SET_CAMERA_ROLL ()
  NAVIGATION_SPEED_MULTIPLIER ()
  The navigation speed has changed.
  NAVIGATION_SCROLL ()
  FIT_TO_VIEW ()
  Fit the view to the currently selected nodes, or to the whole scene if nothing is selected.
  FIT_TO_VIEW_WITH_TARGETS ()
  Fit the view to the passed nodes, or to the whole scene if nothing is passed.
  FIT_TO_VIEW_WITH_TARGETS_AND_MANIPULATORS ()
  NAVIGATION_GOTO_PREVIOUS_VIEW ()
  Moves the camere to the previous (last) view.
  DISPLAY_SET_VERTICAL_FOV ()
  Adjust the camera's vertical FOV to the specified value (in degrees).
  DISPLAY_PROJECTION_MODE_CHANGED ()
  NAVIGATION_SET_CAMERA_HEIGHT ()
  NAVIGATION_SET_CAMERA_POSITION ()
  VIEWER_LAYOUT ()
  Viewer layout has changed, eg.
  QUIT ()
  SET_DRAW_ROOT ()

Member Function Documentation

NavigationInterpreter.NavigationInterpreter.__init__ ( )
NavigationInterpreter.NavigationInterpreter.__del__ ( )
NavigationInterpreter.NavigationInterpreter.activate ( )

Abstract - to be implemented by the subclasses.

Performs the operations necessary to place this interpreter into a ready, active state. Ensure that this base class implementation is called by the subclass implementation.

Reimplemented from MessageInterpreter.MessageInterpreter.

NavigationInterpreter.NavigationInterpreter.deactivate ( )

Abstract - to be implemented by the subclasses.

Performs the operations necessary to place this interpreter into a passive state. Ensure that this base class implementation is called by the subclass implementation.

Reimplemented from NavigationBaseInterpreter.NavigationBaseInterpreter.

NavigationInterpreter.NavigationInterpreter.requestViewUpdate ( )
NavigationInterpreter.NavigationInterpreter.configureEventMapping ( )

Abstract - to be implemented by the subclasses.

Configures the event mapping table with the events handled by this interpreter, and their respective actions

Reimplemented from MessageInterpreter.MessageInterpreter.

NavigationInterpreter.NavigationInterpreter.NAVIGATION_AUTOCAM_UPDATE ( )
NavigationInterpreter.NavigationInterpreter.Frame ( )
NavigationInterpreter.NavigationInterpreter.SmartNavPrototype ( )
NavigationInterpreter.NavigationInterpreter.LastView ( )
NavigationInterpreter.NavigationInterpreter.MoveStart ( )
NavigationInterpreter.NavigationInterpreter.MoveStop ( )
NavigationInterpreter.NavigationInterpreter.MoveInNavigation ( )
NavigationInterpreter.NavigationInterpreter.TargetEnable ( )

Call this action to enable target mode.

Once you enable target mode you can call the TargetStart, Target, and TargetStop actions (in that order).

The matching TargetDisable action should be called to disable target mode.

NavigationInterpreter.NavigationInterpreter.TargetDisable ( )

Call this action to disable target mode.

Each call to TargetEnable should be matched with a call to TargetDisable.

NavigationInterpreter.NavigationInterpreter.TargetStart ( )
NavigationInterpreter.NavigationInterpreter.Target ( )
NavigationInterpreter.NavigationInterpreter.TargetStop ( )
NavigationInterpreter.NavigationInterpreter.TargetHeightStart ( )

Set the active key mappings to TargetHeight.

NavigationInterpreter.NavigationInterpreter.TargetHeight ( )

Just ignore this event when in set camera height mode.

NavigationInterpreter.NavigationInterpreter.TargetHeightStop ( )

Based on the current intersection point, set the height of the camera and then reset the active key mappings.

NavigationInterpreter.NavigationInterpreter.MoveRightStart ( )
NavigationInterpreter.NavigationInterpreter.MoveRightStop ( )
NavigationInterpreter.NavigationInterpreter.MoveRightStart2 ( )
NavigationInterpreter.NavigationInterpreter.MoveRightStop2 ( )
NavigationInterpreter.NavigationInterpreter.MoveLeftStart ( )
NavigationInterpreter.NavigationInterpreter.MoveLeftStop ( )
NavigationInterpreter.NavigationInterpreter.MoveLeftStart2 ( )
NavigationInterpreter.NavigationInterpreter.MoveLeftStop2 ( )
NavigationInterpreter.NavigationInterpreter.MoveForwardStart ( )
NavigationInterpreter.NavigationInterpreter.MoveForwardStop ( )
NavigationInterpreter.NavigationInterpreter.MoveForwardStart2 ( )
NavigationInterpreter.NavigationInterpreter.MoveForwardStop2 ( )
NavigationInterpreter.NavigationInterpreter.MoveBackwardStart ( )
NavigationInterpreter.NavigationInterpreter.MoveBackwardStop ( )
NavigationInterpreter.NavigationInterpreter.MoveBackwardStart2 ( )
NavigationInterpreter.NavigationInterpreter.MoveBackwardStop2 ( )
NavigationInterpreter.NavigationInterpreter.MoveUpStart ( )
NavigationInterpreter.NavigationInterpreter.MoveUpStop ( )
NavigationInterpreter.NavigationInterpreter.MoveUpStart2 ( )
NavigationInterpreter.NavigationInterpreter.MoveUpStop2 ( )
NavigationInterpreter.NavigationInterpreter.MoveDownStart ( )
NavigationInterpreter.NavigationInterpreter.MoveDownStop ( )
NavigationInterpreter.NavigationInterpreter.MoveDownStart2 ( )
NavigationInterpreter.NavigationInterpreter.MoveDownStop2 ( )
NavigationInterpreter.NavigationInterpreter.DollyForward ( )
NavigationInterpreter.NavigationInterpreter.DollyBackward ( )
NavigationInterpreter.NavigationInterpreter.IncreaseSpeed ( )
NavigationInterpreter.NavigationInterpreter.DecreaseSpeed ( )
NavigationInterpreter.NavigationInterpreter.SetCOI ( )
NavigationInterpreter.NavigationInterpreter.addNavigator ( )
NavigationInterpreter.NavigationInterpreter.getNavigator ( )
NavigationInterpreter.NavigationInterpreter.getNavigationState ( )
NavigationInterpreter.NavigationInterpreter.getBookmark ( )
NavigationInterpreter.NavigationInterpreter.initializeView ( )
NavigationInterpreter.NavigationInterpreter.increaseSpeedMultiplier ( )

Increase the speed of the current navigator.

NavigationInterpreter.NavigationInterpreter.decreaseSpeedMultiplier ( )

Decrease the speed of the current navigator.

NavigationInterpreter.NavigationInterpreter.getSpeedMultiplier ( )

Return a multiplier affecting the speed of navigation for the current navigator.

The speed is modified when the user presses the increase or decrease speed key.

NavigationInterpreter.NavigationInterpreter.getSpeedMultipliers ( )
NavigationInterpreter.NavigationInterpreter.setInvertMouse ( )
NavigationInterpreter.NavigationInterpreter.getInvertMouse ( )
NavigationInterpreter.NavigationInterpreter.calculatePositionAndCoi ( )
NavigationInterpreter.NavigationInterpreter.calculateFitToView ( )
NavigationInterpreter.NavigationInterpreter.SetMoveStart ( )
NavigationInterpreter.NavigationInterpreter.SetMoveStop ( )
NavigationInterpreter.NavigationInterpreter.GetMoveStartTime ( )
NavigationInterpreter.NavigationInterpreter.GetMoveStopTime ( )
NavigationInterpreter.NavigationInterpreter.accelerationInterval ( )
NavigationInterpreter.NavigationInterpreter.speed ( )

Return the speed corresponding to the time argument.

The speed calculated is a value ranging from 0 to 1.

The time argument must be a value ranging from 0 to the time it takes to reach maximum speed.

NavigationInterpreter.NavigationInterpreter.calculateSpeed ( )

Calculate the speed given the current time, the time when movement in a particular direction began and the time that movement in that same direction was stopped.

For example, when the user presses the move left key the moment is recorded as the start time. The stop time is the moment when the user releases that key.

NavigationInterpreter.NavigationInterpreter.doCameraRotation ( )
NavigationInterpreter.NavigationInterpreter.DOCUMENT_LOADED ( )
NavigationInterpreter.NavigationInterpreter.APPLICATION_CLOSE_SCENE ( )
NavigationInterpreter.NavigationInterpreter.MEASUREMENT_MODE_CHANGED ( )
NavigationInterpreter.NavigationInterpreter.SET_2D_UI_ROOT ( )
NavigationInterpreter.NavigationInterpreter.CLIENT_CONNECTION_STATUS ( )
NavigationInterpreter.NavigationInterpreter.NEW_CLIENT_ID ( )
NavigationInterpreter.NavigationInterpreter.BOOKMARK_ARRIVAL ( )
NavigationInterpreter.NavigationInterpreter.BOOKMARK_FIT_TEMP_TO_VIEW ( )

Receives a bookmark and generates a new bookmark with the orientation of the original, positioned to fit the contents of the screen to view.

The new bookmark is temporarily set.

NOTE: If the bookmark is ortho, this method assumes that its orientation is parallel with a primary axis.

NavigationInterpreter.NavigationInterpreter.NAVIGATION_SWITCH_COLLISION_MODE ( )

If collision is enabled, switch the collison mode to the one provided.

kNone is not a valid mode and will be ignored

NavigationInterpreter.NavigationInterpreter.NAVIGATION_SET_COLLISION_MODE ( )

Set the collision mode to the provided one.

NavigationInterpreter.NavigationInterpreter.DISPLAY_ONE_TO_ONE ( )
NavigationInterpreter.NavigationInterpreter.DISPLAY_ONE_TO_ONE_REQUEST_PARAMETERS ( )
NavigationInterpreter.NavigationInterpreter.DISPLAY_UPDATE_CALIBRATIONS ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_COMPUTE_ORTHO_PLANE ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_UPDATE_ORTHO_VIEW ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_SET_SPEED_FACTOR ( )
NavigationInterpreter.NavigationInterpreter.calculateOneToOneDistance ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_SET_LAST_VIEWCUBE_VIEW ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_GOTO_VIEWCUBE_ORTHO_VIEW ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_GOTO_ORTHO_VIEW ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_GOTO_PERSPECTIVE_VIEW ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_UPDATE_VIEW ( )

This is the method that actually modifies the camera matrix.

See also self.requestViewUpdate()

NavigationInterpreter.NavigationInterpreter.NAVIGATION_RESET ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_CAMERA_ROTATE_START ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_CAMERA_ROTATE ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_CAMERA_ROTATE_STOP ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_TARGET_START ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_TARGET ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_TARGET_STOP ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_RESET_COI ( )

Set the centre of interest to whatever is at the centre of the screen.

NavigationInterpreter.NavigationInterpreter.NAVIGATION_TARGET_CHANGE_SPEED ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_SET_MODE ( )

The message data contains the name of the navigator to switch to.

NavigationInterpreter.NavigationInterpreter.NAVIGATION_TOGGLE_MODE ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_SET_VIEW ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_SET_POSITION ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_POSITION_REAL ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_SET_SPEED ( )
NavigationInterpreter.NavigationInterpreter.ADD_NAVIGATOR ( )
NavigationInterpreter.NavigationInterpreter.APPLICATION_MODE_CHANGED ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_SET_COI ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_SET_CAMERA_ROLL ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_SPEED_MULTIPLIER ( )

The navigation speed has changed.

Apply the speed to the current navigator. Note that the STEERING_WHEEL_SET_PROPERTIES message will now send this message so that the two speeds are related.

NavigationInterpreter.NavigationInterpreter.NAVIGATION_SCROLL ( )
NavigationInterpreter.NavigationInterpreter.FIT_TO_VIEW ( )

Fit the view to the currently selected nodes, or to the whole scene if nothing is selected.

NavigationInterpreter.NavigationInterpreter.FIT_TO_VIEW_WITH_TARGETS ( )

Fit the view to the passed nodes, or to the whole scene if nothing is passed.

NavigationInterpreter.NavigationInterpreter.FIT_TO_VIEW_WITH_TARGETS_AND_MANIPULATORS ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_GOTO_PREVIOUS_VIEW ( )

Moves the camere to the previous (last) view.

NavigationInterpreter.NavigationInterpreter.DISPLAY_SET_VERTICAL_FOV ( )

Adjust the camera's vertical FOV to the specified value (in degrees).

Also, move the camera backward or forward along the view vector to keep objects in the scene at the COI distance the same apparent size.

NavigationInterpreter.NavigationInterpreter.DISPLAY_PROJECTION_MODE_CHANGED ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_SET_CAMERA_HEIGHT ( )
NavigationInterpreter.NavigationInterpreter.NAVIGATION_SET_CAMERA_POSITION ( )
NavigationInterpreter.NavigationInterpreter.VIEWER_LAYOUT ( )

Viewer layout has changed, eg.

from single view to left-right views

NavigationInterpreter.NavigationInterpreter.QUIT ( )
NavigationInterpreter.NavigationInterpreter.SET_DRAW_ROOT ( )

NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter
NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter NavigationInterpreter.NavigationInterpreter