VRS - The Virtual Rendering System

version 3.3

navigation.h

Go to the documentation of this file.

/******************************************************************************
 * VRS - The Virtual Rendering System
 * Copyright (C) 2003 Computer Graphics Systems Group at the 
 * Hasso-Plattner-Institute (HPI), Potsdam, Germany.
 *
 * This  library  is  free  software; you can redistribute it and/or  modify it
 * under the terms of the GNU Lesser General Public  License  as  published  by
 * the  Free  Software  Foundation;  either  version 2.1 of the License, or (at
 * your option) any later version. This library  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 Lesser General Public License for more details. You should have received
 * a copy of the GNU Lesser+ General Public License along with this library; if
 * not, write to the FreeSoftware Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA, 02111-1307, USA.
 ******************************************************************************/

// $Id: navigation.h 6014 2007-08-09 07:51:16Z Konstantin_Baumann $
// $Date: 2007-08-09 09:51:16 +0200 (Thu, 09 Aug 2007) $
// $Revision: 6014 $
// $State$
// $Author: Konstantin_Baumann $
//
// $Log$
// Revision 1.25  2005/06/23 13:03:46  buchholz
// activeNavigation can now be set from outside
//
// Revision 1.24  2005/01/03 01:43:10  klimetschek
// - modified win32 project layout, splitted vrs.vcproj into vrs_container, vrs_core, vrs_sg, vrs_image, vrs_opengl and vrs_io
// - removed vrs.vcproj
// minor things:
// - added all glutexamples to vrs4glut.sln
// - fixed some problems in glutexamples
// - removed all project references from all VS projects (using solution wide project dependencies instead)
//
// Revision 1.23  2004/12/02 11:25:54  baumann
// serialization ctor fixed
//
// Revision 1.22  2004/10/28 14:16:01  basch
// Class comment changed (Doxygen style)
//
// Revision 1.21  2004/05/27 12:53:07  bohnet
// minor changes
//
// Revision 1.20  2004/03/31 14:45:59  bohnet
// Smoothflyer added
//
// Revision 1.19  2004/03/25 13:48:08  baumann
// static method activeNavigation() added
//
// Revision 1.18  2004/03/16 15:00:29  grabs
// navigational rayrequests now ignore shapes with a Navigation::getIgnoreFilterTag()
//
// Revision 1.17  2004/03/12 16:28:41  baumann
// macros VRS_NAMESPACE_BEGIN/_END expanded and removed
//
// Revision 1.16  2004/03/10 16:53:37  baumann
// ignore filter added
//
// Revision 1.15  2004/03/10 09:49:49  bohnet
// enum NavMode expanded by the navigation metaphor Ufo
//
// Revision 1.14  2004/03/06 16:22:48  kirsch
// cleaned up CameraMemento
//
// Revision 1.13  2004/03/06 14:02:46  kirsch
// cleaned up includes
//
// Revision 1.12  2004/01/22 13:53:29  buchholz
// minor changes
//
// Revision 1.11  2004/01/19 11:43:59  baumann
// serialization mechanism improved
//
// Revision 1.10  2004/01/19 07:28:03  baumann
// serialization mechanism improved
//
// Revision 1.9  2003/12/15 12:58:56  baumgarten
// removed static so's  of navigation to cpp-file
//
// Revision 1.8  2003/11/26 15:05:11  buchholz
// constraintchecker added
//
// Revision 1.7  2003/10/22 15:21:46  kirsch
// iVRS fix
//
// Revision 1.6  2003/07/08 13:45:25  baumgarten
// added clearActiveNavigation
// neccessary to delete some objects outside of vrs correctly
//
// Revision 1.5  2003/07/04 13:01:03  baumann
// made some methods virtual
//
// Revision 1.4  2003/07/04 09:50:32  baumgarten
// it's now base class for all navigation incl. mapnavigation
//
// Revision 1.3  2003/04/09 15:11:09  buchholz
// some comments added
//
// Revision 1.2  2003/02/24 19:34:02  buchholz
// bugfix: made class info public
//
// Revision 1.1  2003/02/24 12:46:27  buchholz
// common base class for conflict management
//

#ifndef VRS_SG_NAVIGATION_H
#define VRS_SG_NAVIGATION_H

#include <vrs/vector.h>
#include <vrs/sg/inputevent.h>
#include <vrs/sg/manipulator.h>

namespace VRS {

class FilterTag;
class LookAt;
class Filter;

class VRS_CORE_API CameraMemento : public SharedObj {
public:
    CameraMemento();
    CameraMemento(const LookAt* l);

    void reactivate(LookAt* l);

    Vector getFrom() const;
    Vector getTo()   const;
    Vector getUp()   const;

    VRS_TYPEINFO(CameraMemento, SharedObj);
    VRS_SERIALIZABLE(CameraMemento);

private:
    Vector from_,to_,up_;
};

class ConstraintChecker;

class VRS_CORE_API Navigation : public Manipulator {

public:
    enum NavMode { Sphere, Cone, Zoom, Flyer, SmoothFlyer, ZoomTurn, ZoomShift,
                   Pan, ElevateLookFixed, LookAround, MoveFocus, WheelZoom, Approach, Game, Jump, Plane, SmoothGlider, Ufo};
    VRS_SERIALIZABLE_CLASS_ENUM(NavMode);

    virtual void setNavMode(NavMode mode);
    NavMode getNavMode() const;

    void clearActiveNavigation();

    void setLookAt(LookAt*);
    LookAt* getLookAt() const;

    VRS::Vector getFocus() const;

    virtual BehaviorNode::InvalidationHint handle(Event*);

    virtual BehaviorNode::InvalidationHint dragStart(int x, int y, ButtonEvent*);
    virtual BehaviorNode::InvalidationHint dragMotion(int x, int y, MotionEvent*);
    virtual BehaviorNode::InvalidationHint dragEnd(int x, int y, ButtonEvent*);
    /*<!< Pure virtual event handling methods of the base class Manipulator.
          Since some navigation classes do not need them, Navigation contains empty implementations. 
          So they can, but need not be overloaded. */        

    virtual void storeCamera(const std::string& name);
    virtual void activateCamera(const std::string& name);
    virtual void removeCamera(const std::string& name);
    virtual void clearCameras();
    virtual VRS::Iterator<std::string>* cameraNames() const;

    virtual void setConstraintChecker(ConstraintChecker* checker);
    virtual ConstraintChecker* getConstraintChecker() const;

    static SO<FilterTag> getIgnoreFilterTag();

    static SO<Navigation> activeNavigation();
    static void setActiveNavigation(SO<Navigation> navigation);

    VRS_TYPEINFO(Navigation, Manipulator);
    VRS_SERIALIZABLE(Navigation);

protected:

    //Filter should be const, but const correctness is not supported by vrs :(
    //so please dont change or change at your own risk
    static SO<Filter> getIgnoreFilter();

    CameraMemento* findCamera(const std::string& name);
    void addCamera(const std::string& name, CameraMemento* cm);
    void addCamera(const std::string& name, LookAt* lookAt);

    Navigation(
        LookAt* lookAt = NULL,
        InputEvent::Button button = InputEvent::MouseButton1,
        InputEvent::Modifier must_modifier = InputEvent::NoModifier,
        InputEvent::Modifier must_not_modifier = InputEvent::NoModifier,
        Callback* startCallback = NULL,
        Callback* motionCallback = NULL,
        Callback* endCallback = NULL
    );

    static SO<Navigation> activeNavigation_;

private:
    SO<LookAt> lookAt_;
    int navMode_;

    SO<ConstraintChecker> constraintChecker_;
};

inline Navigation::NavMode Navigation::getNavMode() const { return (NavMode)navMode_; }

} // namespace VRS

#endif // VRS_SG_NAVIGATION_H

---

Generated on Wed May 23 06:00:13 2012 by Doxygen 1.5.6

© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact