src/programs/view/3dview.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2010,2014,2019, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #ifndef GMX_VIEW_3DVIEW_H
  38 #define GMX_VIEW_3DVIEW_H
  39
  40 #include "gromacs/math/3dtransforms.h"
  41 #include "gromacs/math/vectypes.h"
  42 #include "gromacs/utility/basedefinitions.h"
  43 #include "gromacs/utility/real.h"
  44
  45 typedef int iv2[2];
  46
  47 typedef struct
  48 {
  49     matrix box;
  50     int    ecenter;     /* enum for centering, see pbc.h */
  51     vec4   eye, origin; /* The eye and origin position   */
  52     mat4   proj;        /* Projection matrix             */
  53     mat4   Rot;         /* Total rotation matrix         */
  54     real   sc_x, sc_y;  /* Scaling for aspect ratio      */
  55     mat4   RotP[DIM];   /* state for 3d rotations        */
  56     mat4   RotM[DIM];
  57 } t_3dview;
  58
  59 t_3dview* init_view(matrix box);
  60 /* Generate the view matrix from the eye pos and the origin,
  61  * applying also the scaling for the aspect ration.
  62  * There is no accompanying done_view routine: the struct can simply
  63  * be sfree'd.
  64  */
  65
  66 /* The following options are present on the 3d struct:
  67  * zoom (scaling)
  68  * rotate around the center of the box
  69  * reset the view
  70  */
  71
  72 gmx_bool zoom_3d(t_3dview* view, real fac);
  73 /* Zoom in or out with factor fac, returns TRUE when zoom successful,
  74  * FALSE otherwise.
  75  */
  76
  77 void rotate_3d(t_3dview* view, int axis, gmx_bool bPositive);
  78 /* Rotate the eye around the center of the box, around axis */
  79
  80 void translate_view(t_3dview* view, int axis, gmx_bool bPositive);
  81 /* Translate the origin at which one is looking */
  82
  83 void reset_view(t_3dview* view);
  84 /* Reset the viewing to the initial view */
  85
  86 #endif