src/gromacs/legacyheaders/3dview.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gromacs Runs On Most of All Computer Systems
  34  */
  35
  36 #ifndef _3dview_h
  37 #define _3dview_h
  38
  39 #include "typedefs.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 #define WW 3
  46
  47 typedef real vec4[4];
  48
  49 typedef real mat4[4][4];
  50
  51 typedef int  iv2[2];
  52
  53 typedef struct {
  54     matrix box;
  55     int    ecenter;     /* enum for centering, see pbc.h        */
  56     vec4   eye, origin; /* The eye and origin position          */
  57     mat4   proj;        /* Projection matrix            */
  58     mat4   Rot;         /* Total rotation matrix                */
  59     real   sc_x, sc_y;  /* Scaling for aspect ratio             */
  60     mat4   RotP[DIM];   /* state for 3d rotations  */
  61     mat4   RotM[DIM];
  62 } t_3dview;
  63
  64 extern void print_m4(FILE *fp, const char *s, mat4 A);
  65
  66 extern void print_v4(FILE *fp, char *s, int dim, real *a);
  67
  68 extern void m4_op(mat4 m, rvec x, vec4 v);
  69
  70 extern void unity_m4(mat4 m);
  71
  72 extern void mult_matrix(mat4 A, mat4 B, mat4 C);
  73
  74 extern void rotate(int axis, real angle, mat4 A);
  75
  76 extern void translate(real tx, real ty, real tz, mat4 A);
  77
  78 extern void m4_op(mat4 m, rvec x, vec4 v);
  79
  80 extern void calculate_view(t_3dview *view);
  81
  82 extern t_3dview *init_view(matrix box);
  83 /* Generate the view matrix from the eye pos and the origin,
  84  * applying also the scaling for the aspect ration.
  85  * There is no accompanying done_view routine: the struct can simply
  86  * be sfree'd.
  87  */
  88
  89 /* The following options are present on the 3d struct:
  90  * zoom (scaling)
  91  * rotate around the center of the box
  92  * reset the view
  93  */
  94
  95 extern gmx_bool zoom_3d(t_3dview *view, real fac);
  96 /* Zoom in or out with factor fac, returns TRUE when zoom successful,
  97  * FALSE otherwise.
  98  */
  99
 100 extern void init_rotate_3d(t_3dview *view);
 101 /* Initiates the state of 3d rotation matrices in the structure */
 102
 103 extern void rotate_3d(t_3dview *view, int axis, gmx_bool bPositive);
 104 /* Rotate the eye around the center of the box, around axis */
 105
 106 extern void translate_view(t_3dview *view, int axis, gmx_bool bPositive);
 107 /* Translate the origin at which one is looking */
 108
 109 extern void reset_view(t_3dview *view);
 110 /* Reset the viewing to the initial view */
 111
 112 #ifdef __cplusplus
 113 }
 114 #endif
 115
 116 #endif