vcglib: trackball.h Source File

00001 /****************************************************************************
00002 * VCGLib                                                            o o     *
00003 * Visual and Computer Graphics Library                            o     o   *
00004 *                                                                _   O  _   *
00005 * Copyright(C) 2004                                               \/)\/     *
00006 * Visual Computing Lab                                            /\/|      *
00007 * ISTI - Italian National Research Council                           |      *
00008 *                                                                    \      *
00009 * All rights reserved.                                                      *
00010 *                                                                           *
00011 * This program is free software; you can redistribute it and/or modify      *
00012 * it under the terms of the GNU General Public License as published by      *
00013 * the Free Software Foundation; either version 2 of the License, or         *
00014 * (at your option) any later version.                                       *
00015 *                                                                           *
00016 * This program is distributed in the hope that it will be useful,           *
00017 * but WITHOUT ANY WARRANTY; without even the implied warranty of            *
00018 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             *
00019 * GNU General Public License (http://www.gnu.org/licenses/gpl.txt)          *
00020 * for more details.                                                         *
00021 *                                                                           *
00022 ****************************************************************************/
00023 /****************************************************************************
00024   History
00025 
00026 $Log: not supported by cvs2svn $
00027 Revision 1.16  2007/07/14 12:43:44  benedetti
00028 Added Doxygen documentation.
00029 
00030 Revision 1.15  2007/06/13 17:15:08  benedetti
00031 Added one-level undo system and sticky trackmodes.
00032 
00033 Revision 1.14  2007/05/15 15:00:47  benedetti
00034 Moved the drawing code to trackmodes, some other minor changes
00035 
00036 Revision 1.13  2007/02/26 01:30:02  cignoni
00037 Added reflection Name
00038 
00039 Revision 1.12  2007/01/15 15:04:15  tarini
00040 added "ToAscii" and "SetFromAscii" methods to load/store current trackball status from/to ascii strings
00041 (intended uses: clipboard operations and comments inside png snapshots!)
00042 
00043 Revision 1.11  2006/08/23 15:40:57  marfr960
00044 *** empty log message ***
00045 
00046 Revision 1.10  2006/02/13 13:15:52  cignoni
00047 Added Scale and Translate methods.
00048 Added many drawing hints and raised the default num. of steps when drawing circles.
00049 Added MouseDown without coords (for remembering changes of keys modifiers)
00050 Added ZMode to the default modes under Alt+left
00051 Added DrawPostApply (to be completed)
00052 
00053 Revision 1.9  2005/10/17 01:29:46  cignoni
00054 Main restructuring. Removed the Draw function and slightly changed the meaning of the trackball itself.
00055 See the notes at the beginning of trackball.h
00056 
00057 Revision 1.8  2004/07/11 22:06:56  cignoni
00058 Added scaling by wheel
00059 
00060 Revision 1.7  2004/06/09 14:01:13  cignoni
00061 Heavily restructured. To be completed only rotation works...
00062 
00063 Revision 1.6  2004/05/14 03:15:09  ponchio
00064 Redesigned partial version.
00065 
00066 Revision 1.5  2004/05/12 20:55:18  ponchio
00067 *** empty log message ***
00068 
00069 Revision 1.4  2004/05/07 12:46:08  cignoni
00070 Restructured and adapted in a better way to opengl
00071 
00072 Revision 1.3  2004/04/07 10:54:10  cignoni
00073 Commented out unused parameter names and other minor warning related issues
00074 
00075 Revision 1.2  2004/03/25 14:55:25  ponchio
00076 Adding copyright.
00077 
00078 
00079 ****************************************************************************/
00080 #ifndef TRACKBALL_H
00081 #define TRACKBALL_H
00082 
00083 #include <time.h>
00084 #include <vcg/math/similarity.h>
00085 #include <vcg/space/color4.h>
00086 #include <wrap/gui/view.h>
00087 #include <wrap/gui/trackmode.h>
00088 #include <list>
00089 #include <vector>
00090 #include <map>
00091 
00092 namespace vcg {
00099 class Transform {
00100 public:
00109   Transform();
00111   Similarityf track;
00113   Point3f center; 
00115   float radius; 
00116 };
00117 
00126 Transform interpolate(const Transform &a, const Transform &b, float t);
00127 
00128 class TrackMode;
00129 
00167 class Trackball: public Transform {
00168 public:
00169 
00171   enum Button { BUTTON_NONE   = 0x0000, 
00172                 BUTTON_LEFT   = 0x0001, 
00173                 BUTTON_MIDDLE = 0x0002, 
00174                 BUTTON_RIGHT  = 0x0004, 
00175                 WHEEL         = 0x0008, 
00176                 KEY_SHIFT     = 0x0010, 
00177                 KEY_CTRL      = 0x0020, 
00178                 KEY_ALT       = 0x0040, 
00179                 HANDLE        = 0x0080, 
00180                                                                 MODIFIER_MASK = 0x00FF, 
00181                                                                 KEY_UP        = 0x0100, 
00182                                                                 KEY_DOWN      = 0x0200, 
00183                                                                 KEY_LEFT      = 0x0400, 
00184                                                                 KEY_RIGHT     = 0x0800, 
00185                                                                 KEY_PGUP      = 0x1000, 
00186                                                                 KEY_PGDOWN    = 0x2000, 
00187               };
00188 
00195   Trackball();
00201   ~Trackball();
00202         
00203         private:
00204         // Trackball must not be copied. Use Append (see vcg/complex/trimesh/append.h)
00205         Trackball operator =(const Trackball &  /*m*/){ assert(0); return *this; }
00206         public:
00212   void SetIdentity();
00219   void SetPosition(const Point3f &c, int millisec = 0);
00225   void SetScale(const float s) {radius=s;};
00232   void SetTransform(const Transform &transform, int millisec = 0);
00238   void Translate(Point3f tr);
00244   void Scale(const float f);
00245 
00246   //operating
00250   void GetView();
00256   void Apply(bool Draw);
00262   void Apply ();
00271   void DrawPostApply();
00275   void ApplyInverse();
00276   // DrawIcon() has been moved to trackutils.h
00277   //void DrawIcon();
00278   
00279   // T(c) S R T(t) T(-c) => S R T(S^(-1) R^(-1)(c) + t - c)
00280   Matrix44f Matrix() const;
00281   Matrix44f InverseMatrix() const;
00282 
00286   void Reset();
00287 
00291   void ClearModes();
00292 
00293   // DrawCircle (), DrawPlane(), DrawPlaneHandle() has been moved to trackutils.h
00294   // the drawing code has been moved to the trackmodes
00295   // void DrawCircle ();
00296   // void DrawPlane();
00297   // void DrawPlaneHandle();
00298 
00299   //interface
00305   void MouseDown(/*Button*/ int button);
00313   void MouseDown(int x, int y, /*Button*/ int button);
00320   void MouseMove(int x, int y); 
00328   void MouseUp(int x, int y, /*Button */ int button); 
00334   void MouseWheel(float notch);
00341   void MouseWheel (float notch, /*Button */ int button);
00347   void ButtonUp(Button button);
00353   void ButtonDown(Button button, unsigned int msec=0);
00360   void Undo();
00361 
00362   //default sensitivity 1
00368   void SetSensitivity(float s);
00369 
00370   void SetSpinnable(bool on);
00371 
00372         
00373         // returns if it is animating or not
00374         // 
00375         bool IsAnimating(unsigned int msec=0);
00376 
00377         // Animate: either takes an absolute time (if default not specified, then it is automeasured)
00378         // or a fixed delta
00379         void Animate(unsigned int msec=0);
00380 
00386         bool IsSpinnable();
00392   void SetSpinning(Quaternionf &spin);
00396   void StopSpinning();
00402   bool IsSpinning();
00403 
00404   //interfaccia navigation:
00408   void Back();
00412   void Forward();
00416   void Home();
00420   void Store();
00424   void HistorySize(int lenght);
00425 
00426 /*    //internals  // commented out no more used this stuff!
00427     enum Action { NONE = 0,
00428                   VIEW_ROTATE = 1,
00429                   // Axis Constrained Rotation 
00430                   TRACK_ROTATE_X = 3, TRACK_ROTATE_Y = 4, TRACK_ROTATE_Z = 5,
00431                   // Drag constrained to an axis (trackball axis)
00432                   DRAG_X = 6,   DRAG_Y = 7,   DRAG_Z = 8,
00433                   // Drag constrained to a plane
00434                   DRAG_XY = 9,  DRAG_YZ = 10,  DRAG_XZ = 11,
00435                   //scale model respect to center of trackball
00436                   VIEW_SCALE = 12,
00437                   //scale trackball and model
00438                   TRACK_SCALE = 13
00439     };
00440 */
00441   // loads stores current status from/to ascii stings
00448   void ToAscii(char * st);
00456   bool SetFromAscii(const char * st);
00457 
00458   //protected:
00460   View<float> camera;
00466   void SetCurrentAction();
00468   int current_button;
00470   TrackMode *current_mode;
00471 
00473   TrackMode *inactive_mode;
00474   
00475   // The manipulator to deal with timer events and key events
00476   TrackMode *idle_and_keys_mode; 
00489   void setDefaultMapping ();
00490 
00492   std::map<int, TrackMode *> modes;
00493 
00494   // undo_track and last_track have different meanings..
00496   Similarityf last_track;
00498   Similarityf undo_track; 
00500   Similarityf last_view;
00502   Point3f last_point;
00504   std::vector<Point3f> Hits;
00506   bool dragging;
00508   int button_mask;
00509 
00510         unsigned int last_time;
00511 
00513   Quaternionf spin;
00515   bool spinnable;
00517   bool spinning;
00518 
00520   std::list<Transform> history;
00522   int history_size;
00523 
00524 
00525         void SetFixedTimesteps(bool mode){
00526                 fixedTimestepMode=mode;
00527         }
00528 
00530   friend class TrackMode;
00531 private:
00532         void Sync(unsigned int msec);
00533         bool fixedTimestepMode; // if true, animations occurs at fixed time steps
00534 
00535 };
00536 
00537 
00538 }//namespace
00539 
00540 #endif