VirtualRenderingSystem: trackball.h Source File

00001  /**********************************************************************
00002  VRS - The Virtual Rendering System
00003  Copyright (C) 2001 Computer Graphics Systems Group at the 
00004  Hasso-Plattner-Institute, Potsdam, Germany.
00005  This library is free software; you can redistribute it and/or 
00006  modify it under the terms of the GNU Lesser General Public 
00007  License as published by the Free Software Foundation; either 
00008  version 2.1 of the License, or (at your option) any later version.
00009  This library is distributed in the hope that it will be useful, but 
00010  WITHOUT ANY WARRANTY; without even the implied warranty of 
00011  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
00012  See the GNU Lesser General Public License for more details.
00013  You should have received a copy of the GNU Lesser+ General Public
00014  License along with this library; if not, write to the FreeSoftware 
00015  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA, 02111-1307, USA.
00016  **********************************************************************/
00017 // $Id: trackball.h 6014 2007-08-09 07:51:16Z Konstantin_Baumann $
00018 // $Date: 2007-08-09 09:51:16 +0200 (Thu, 09 Aug 2007) $
00019 // $Revision: 6014 $
00020 // $State$
00021 // $Author: Konstantin_Baumann $
00022 //
00023 // $Log$
00024 // Revision 1.19  2005/01/03 01:43:10  klimetschek
00025 // - modified win32 project layout, splitted vrs.vcproj into vrs_container, vrs_core, vrs_sg, vrs_image, vrs_opengl and vrs_io
00026 // - removed vrs.vcproj
00027 // minor things:
00028 // - added all glutexamples to vrs4glut.sln
00029 // - fixed some problems in glutexamples
00030 // - removed all project references from all VS projects (using solution wide project dependencies instead)
00031 //
00032 // Revision 1.18  2004/10/28 14:16:01  basch
00033 // Class comment changed (Doxygen style)
00034 //
00035 // Revision 1.17  2004/08/20 15:08:13  kirsch
00036 // added method to reset trackball transformation
00037 //
00038 // Revision 1.16  2004/06/22 12:23:10  kirsch
00039 // cleanup
00040 //
00041 // Revision 1.15  2004/03/12 16:28:41  baumann
00042 // macros VRS_NAMESPACE_BEGIN/_END expanded and removed
00043 //
00044 // Revision 1.14  2004/01/19 11:44:00  baumann
00045 // serialization mechanism improved
00046 //
00047 // Revision 1.13  2003/11/07 14:19:26  kirsch
00048 // removed leading underscore from include guards
00049 //
00050 // Revision 1.12  2003/02/24 10:05:57  baumann
00051 // changed return type of BehaviorNode::handle() and Manipulator::drag*()
00052 // from "int" to "BehaviorNode::InvalidationHint"
00053 //
00054 // Revision 1.11  2002/10/29 10:32:53  baumann
00055 // macros VRS_CLASSNAME_* and VRS_IMPL_TYPEINFO_* removed
00056 //
00057 // Revision 1.10  2002/03/03 21:44:26  kosta
00058 // VRS_TYPEINFO-macro rewritten
00059 //
00060 // Revision 1.9  2002/02/19 10:34:21  kosta
00061 // undone all changes since 2002-02-15
00062 //
00063 // Revision 1.6  2002/02/05 07:48:26  kosta
00064 // new persistency macros:
00065 //     VRS_SERIALIZABLE(CLASS_NAME);
00066 //     VRS_SERIALIZABLE_ABSTRACT_CLASS(CLASS_NAME);
00067 //     VRS_SERIALIZABLE_NO_SO_CLASS(CLASS_NAME)
00068 //
00069 // Revision 1.5  2002/02/04 13:07:20  kosta
00070 // VRS_SERIALIZABLE macros completely rewritten
00071 //
00072 // Revision 1.4  2002/01/15 16:25:55  kosta
00073 // macros rewritten for a better namespace support
00074 //
00075 // Revision 1.3  2001/11/13 16:36:32  kirsch
00076 // changed line feed to unix style (removed control-M)
00077 //
00078 // Revision 1.2  2001/07/04 13:44:00  kersting
00079 // changes due to InputEvent enumeration changes
00080 //
00081 // Revision 1.1.1.1  2001/06/08 08:09:21  kirsch
00082 // imported alpha-version by olli 
00083 //
00084 
00085 
00086 #ifndef VRS_TRACKBALL_H
00087 #define VRS_TRACKBALL_H
00088 
00089 #include <vrs/matrix.h>
00090 #include <vrs/vector.h>
00091 #include <vrs/sg/scenething.h>
00092 #include <vrs/sg/manipulator.h>
00093 
00094 namespace VRS {
00095 
00096 class Canvas;
00097 class Engine;
00098 class Rotation;
00099 
00101 class VRS_CORE_API TrackBall : public Manipulator {
00102     
00103 public:
00104     TrackBall(
00105         SceneThing* thing,
00106         InputEvent::Button button = InputEvent::MouseButton1,
00107         InputEvent::Modifier modifier = InputEvent::NoModifier,
00108         InputEvent::Modifier must_not_modifier = InputEvent::NoModifier,
00109         double speed = 1.0,
00110         double ballsize = 1.0,
00111         BehaviorNode::InvalidationHint redrawPolicy = BehaviorNode::RedrawWorld
00112         );
00114     
00115     void setSpeed(double s);
00116     double getSpeed() const;
00121     void setSize(double size);
00122     double getSize() const;
00126     void setThing(SceneThing* node);
00127     SceneThing* getThing() const;
00131     void reset();
00134     void setRedrawPolicy(BehaviorNode::InvalidationHint);
00135     BehaviorNode::InvalidationHint getRedrawPolicy() const;
00140     virtual BehaviorNode::InvalidationHint dragStart(int x, int y, ButtonEvent* e);
00141     virtual BehaviorNode::InvalidationHint dragMotion(int x, int y, MotionEvent* e);
00142     virtual BehaviorNode::InvalidationHint dragEnd(int x, int y, ButtonEvent* e);
00144 
00145     void setAutoRotation(bool enabled, int minRadiusInPixel = 20);
00146     bool getAutoRotation() const;
00147     int getAutoRadius() const;
00148     bool isAutoRotating() const;
00156     virtual BehaviorNode::InvalidationHint handle(Event*);
00161     VRS_TYPEINFO(TrackBall, Manipulator);
00162     VRS_SERIALIZABLE(TrackBall);
00163         
00164 private:
00165     void updateTransform (int, int);
00166     void rotate (Engine*);
00167     Vector pointOnSphere (double, double) const;
00168     void updateCenter(Engine* engine);
00169     
00170     SO<SceneThing> thing_;
00171     
00172     double speed_;
00173     double size_;
00174     
00175     bool autoMode_;         // automatic rotation enabled
00176     bool autoRun_;          // automatic rotation active
00177     int autoRadius_;        // minimum distance for activating rotation 
00178     double autoTime_;       // time of last rotation
00179     double autoDelay_;      // delay between to concurrent rotations
00180     Canvas* autoCanvas_;    // canvas for which dragging is done 
00181     
00182     BehaviorNode::InvalidationHint redrawPolicy_;
00183     
00184     int cleanUp_;
00185     int x_, y_;
00186     int dx_, dy_;
00187     int width_, height_;
00188     
00189     SO<Rotation> rotation_;
00190     Vector center_;
00191     Matrix matrix_;
00192     
00193     bool recalculateCenter_;
00194     bool initialized_;
00195     
00196 protected:
00197     TrackBall(); // only for serialization!!!
00198 };
00199 
00200 inline SceneThing* TrackBall::getThing() const { return thing_; }
00201 inline BehaviorNode::InvalidationHint TrackBall::getRedrawPolicy() const { return redrawPolicy_; }
00202 inline double TrackBall::getSize() const { return size_; }
00203 inline double TrackBall::getSpeed() const { return speed_; }
00204 
00205 } // namespace VRS
00206 
00207 #endif // VRS_TRACKBALL_H