H3DNavigation.h

Go to the documentation of this file.

//    Copyright 2004-2019, SenseGraphics AB
//
//    This file is part of H3D API.
//
//    H3D API is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation; either version 2 of the License, or
//    (at your option) any later version.
//
//    H3D API is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with H3D API; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//    A commercial license is also available. Please contact us at 
//    www.sensegraphics.com for more information.
//
//
//
#ifndef __H3DNAVIGATION_H__
#define __H3DNAVIGATION_H__
 
#include <H3D/H3DNavigationDevices.h>
#include <H3D/X3DViewpointNode.h>
 
 
namespace H3D {
  
  class H3DAPI_API H3DNavigation {
  public:
 
    typedef enum {
      ALL = 1,
      MOUSE = 2,
      KEYBOARD = 3,
      HAPTICSDEVICE = 4,
      SWS = 5
    } NavigationDevices;
 
    H3DNavigation();
 
    ~H3DNavigation() {
      old_vp.reset( NULL );
      h3d_navigations.remove( this );
    }
 
    void doNavigation( string navigation_type, X3DViewpointNode * vp,
                              X3DChildNode *topNode, bool detect_collision,
                              const vector< H3DFloat > &avatar_size, 
                              H3DFloat speed,
                              const vector< string > &transition_type,
                              H3DTime transition_time );
 
    static void disableDevice( int device );
 
    static void enableDevice( int device );
 
    static bool isEnabled( int device );
 
    inline X3DViewpointNode * viewpointToUse(
      X3DViewpointNode *potential_vp ) {
      if( old_vp.get() && old_vp.get() != potential_vp ) {
         return old_vp.get();
      }
      return potential_vp;
    }
 
    static X3DViewpointNode * viewpointToUse( X3DViewpointNode *potential_vp,
                                              int nav_index );
 
    static string getTransitionType(
      const vector< string > &transition_types );
 
    inline void leftButtonUpdate( bool _left_button ) {
      if( mouse_nav.get() )
        mouse_nav->leftButtonUpdate( _left_button );
    }
 
    inline void motionUpdate( int x, int y ) {
      if( mouse_nav.get() )
        mouse_nav->motionUpdate( x, y );
    }
 
    inline void scrollWheelUpdate( bool up ) {
      if( mouse_nav.get() )
        mouse_nav->scrollWheelUpdate( up );
    }
 
    inline void handleKeyAction( int key, bool pressed ) {
      if( keyboard_nav.get() )
        keyboard_nav->handleKeyAction( key, pressed );
    }
 
    // Used to force jump of a viewpoint, for example when an anchor is
    // selected.
    static bool force_jump;
 
  protected:
    H3DUniquePtr< MouseNavigation > mouse_nav;
    H3DUniquePtr< KeyboardNavigation > keyboard_nav;
    H3DUniquePtr< HapticDeviceNavigation > haptic_device_nav;
    H3DUniquePtr< SWSNavigation > sws_navigation;
 
    // Time of last update.
    H3DTime last_time;
 
    // Variables needed to correctly do linear interpolation between
    // two viewpoints.
    // Flag used to know if we are in linear interpolation mode.
    bool linear_interpolate;
    Vec3f goal_position;
    Rotation goal_orientation;
    Rotation old_vp_orientation;
    Vec3f start_position, move_direction;
    Rotation start_orientation;
    Vec3f old_vp_pos;
    H3DTime start_time;
    AutoRef< X3DViewpointNode > old_vp;
    // List of H3DNavigation instances, needed by the static functions.
    static list< H3DNavigation * > h3d_navigations;
 
    // Returns true if the scaling factors are uniform, i.e. the same.
    bool isUniformScaling( const Vec3f &scale );
 
  };
 
}
 
#endif