Merge branch release-4-6 into release-5-0
[alexxy/gromacs.git] / src / gromacs / fileio / writeps.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, 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_FILEIO_WRITEPS_H
38 #define GMX_FILEIO_WRITEPS_H
39
40 #include <stdio.h>
41 #include "../legacyheaders/types/matrix.h"
42 #include "../legacyheaders/types/simple.h"
43
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47
48 /* TODO: These two enums are used also in xutil.h in src/programs/view/.
49  * The Y position enum doesn't seem to be actually used in this header...
50  */
51 typedef enum {
52     eXCenter, eXLeft, eXRight
53 } eXPos;
54
55 typedef enum {
56     eYCenter, eYTop,  eYBottom
57 } eYPos;
58
59 enum {
60     efontTIMES, efontTIMESITALIC, efontTIMESBOLD, efontTIMESBOLDITALIC,
61     efontHELV,  efontHELVITALIC,  efontHELVBOLD,  efontHELVBOLDITALIC,
62     efontCOUR,  efontCOURITALIC,  efontCOURBOLD,  efontCOURBOLDITALIC,
63     efontNR
64 };
65
66
67 typedef struct t_int_psdata *t_psdata;
68 /* Only use t_psdata - it is a pointer to an abstract datatype
69  * that maintains the state of the postscript currently written.
70  */
71
72 extern const char *fontnm[efontNR];
73
74 t_psdata ps_open(const char *fn, real x1, real y1, real x2, real y2);
75
76 void ps_linewidth(t_psdata ps, int lw);
77 void ps_color(t_psdata ps, real r, real g, real b);
78 void ps_rgb(t_psdata ps, t_rgb *rgb);
79
80 void ps_rgb_box(t_psdata ps, t_rgb *rgb);
81 void ps_rgb_nbox(t_psdata ps, t_rgb *rgb, real n);
82 void ps_init_rgb_box(t_psdata ps, real xbox, real ybox);
83 void ps_init_rgb_nbox(t_psdata ps, real xbox, real ybox);
84
85 void ps_lineto(t_psdata ps, real x, real y);
86 void ps_linerel(t_psdata ps, real dx, real dy);
87
88 void ps_moveto(t_psdata ps, real x, real y);
89 void ps_moverel(t_psdata ps, real dx, real dy);
90
91 void ps_line(t_psdata ps, real x1, real y1, real x2, real y2);
92
93 void ps_box(t_psdata ps, real x1, real y1, real x2, real y2);
94 void ps_fillbox(t_psdata ps, real x1, real y1, real x2, real y2);
95
96 void ps_arc(t_psdata ps, real x1, real y1, real rad, real a0, real a1);
97 void ps_fillarc(t_psdata ps, real x1, real y1, real rad, real a0, real a1);
98 void ps_arcslice(t_psdata ps, real xc, real yc,
99                  real rad1, real rad2, real a0, real a1);
100 void ps_fillarcslice(t_psdata ps, real xc, real yc,
101                      real rad1, real rad2, real a0, real a1);
102
103 void ps_circle(t_psdata ps, real x1, real y1, real rad);
104
105 void ps_font(t_psdata ps, int font, real size);
106 void ps_strfont(t_psdata ps, char *font, real size);
107
108 void ps_text(t_psdata ps, real x1, real y1, const char *str);
109 void ps_ctext(t_psdata ps, real x1, real y1, const char *str, int expos);
110
111 void ps_close(t_psdata ps);
112
113 void ps_flip(t_psdata ps, gmx_bool bPlus);
114 /* Rotate over 90 (bPlus) or -90 (!bPlus) degrees */
115
116 void ps_rotate(t_psdata ps, real angle);
117
118 void ps_translate(t_psdata ps, real x, real y);
119
120 void ps_setorigin(t_psdata ps);
121 void ps_unsetorigin(t_psdata ps);
122
123 void ps_comment(t_psdata ps, const char *s);
124
125 #ifdef __cplusplus
126 }
127 #endif
128
129 #endif