SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
gl2ps.h
Go to the documentation of this file.
1 /*
2  * GL2PS, an OpenGL to PostScript Printing Library
3  * Copyright (C) 1999-2011 C. Geuzaine
4  *
5  * This file is part of SUMO.
6 // SUMO is free software: you can redistribute it and/or
7  * modify it under the terms of either:
8  *
9  * a) the GNU Library General Public License as published by the Free
10  * Software Foundation, either version 2 of the License, or (at your
11  * option) any later version; or
12  *
13  * b) the GL2PS License as published by Christophe Geuzaine, either
14  * version 2 of the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful, but
17  * WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See either
19  * the GNU Library General Public License or the GL2PS License for
20  * more details.
21  *
22  * You should have received a copy of the GNU Library General Public
23  * License along with this library in the file named "COPYING.LGPL";
24  * if not, write to the Free Software Foundation, Inc., 675 Mass Ave,
25  * Cambridge, MA 02139, USA.
26  *
27  * You should have received a copy of the GL2PS License with this
28  * library in the file named "COPYING.GL2PS"; if not, I will be glad
29  * to provide one.
30  *
31  * For the latest info about gl2ps and a full list of contributors,
32  * see http://www.geuz.org/gl2ps/.
33  *
34  * Please report all bugs and problems to <gl2ps@geuz.org>.
35  */
36 
37 #ifndef __GL2PS_H__
38 #define __GL2PS_H__
39 
40 #include <stdio.h>
41 #include <stdlib.h>
42 
43 /* Define GL2PSDLL at compile time to build a Windows DLL */
44 
45 #if defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__NT__)
46 # if defined(_MSC_VER)
47 # pragma warning(disable:4115)
48 # pragma warning(disable:4996)
49 # endif
50 # define NOMINMAX
51 # include <windows.h>
52 # undef NOMINMAX
53 # if defined(GL2PSDLL)
54 # if defined(GL2PSDLL_EXPORTS)
55 # define GL2PSDLL_API __declspec(dllexport)
56 # else
57 # define GL2PSDLL_API __declspec(dllimport)
58 # endif
59 # else
60 # define GL2PSDLL_API
61 # endif
62 #else
63 # define GL2PSDLL_API
64 #endif
65 
66 #if defined(__APPLE__) || defined(HAVE_OPENGL_GL_H)
67 # include <OpenGL/gl.h>
68 #else
69 # include <GL/gl.h>
70 #endif
71 
72 /* Support for compressed PostScript/PDF/SVG and for embedded PNG
73  images in SVG */
74 
75 #if defined(HAVE_ZLIB) || defined(HAVE_LIBZ)
76 # define GL2PS_HAVE_ZLIB
77 # if defined(HAVE_LIBPNG) || defined(HAVE_PNG)
78 # define GL2PS_HAVE_LIBPNG
79 # endif
80 #endif
81 
82 /* Version number */
83 
84 #define GL2PS_MAJOR_VERSION 1
85 #define GL2PS_MINOR_VERSION 3
86 #define GL2PS_PATCH_VERSION 6
87 #define GL2PS_EXTRA_VERSION ""
88 
89 #define GL2PS_VERSION (GL2PS_MAJOR_VERSION + \
90  0.01 * GL2PS_MINOR_VERSION + \
91  0.0001 * GL2PS_PATCH_VERSION)
92 
93 #define GL2PS_COPYRIGHT "(C) 1999-2011 C. Geuzaine"
94 
95 /* Output file formats (the values and the ordering are important!) */
96 
97 #define GL2PS_PS 0
98 #define GL2PS_EPS 1
99 #define GL2PS_TEX 2
100 #define GL2PS_PDF 3
101 #define GL2PS_SVG 4
102 #define GL2PS_PGF 5
103 
104 /* Sorting algorithms */
105 
106 #define GL2PS_NO_SORT 1
107 #define GL2PS_SIMPLE_SORT 2
108 #define GL2PS_BSP_SORT 3
109 
110 /* Message levels and error codes */
111 
112 #define GL2PS_SUCCESS 0
113 #define GL2PS_INFO 1
114 #define GL2PS_WARNING 2
115 #define GL2PS_ERROR 3
116 #define GL2PS_NO_FEEDBACK 4
117 #define GL2PS_OVERFLOW 5
118 #define GL2PS_UNINITIALIZED 6
119 
120 /* Options for gl2psBeginPage */
121 
122 #define GL2PS_NONE 0
123 #define GL2PS_DRAW_BACKGROUND (1<<0)
124 #define GL2PS_SIMPLE_LINE_OFFSET (1<<1)
125 #define GL2PS_SILENT (1<<2)
126 #define GL2PS_BEST_ROOT (1<<3)
127 #define GL2PS_OCCLUSION_CULL (1<<4)
128 #define GL2PS_NO_TEXT (1<<5)
129 #define GL2PS_LANDSCAPE (1<<6)
130 #define GL2PS_NO_PS3_SHADING (1<<7)
131 #define GL2PS_NO_PIXMAP (1<<8)
132 #define GL2PS_USE_CURRENT_VIEWPORT (1<<9)
133 #define GL2PS_COMPRESS (1<<10)
134 #define GL2PS_NO_BLENDING (1<<11)
135 #define GL2PS_TIGHT_BOUNDING_BOX (1<<12)
136 
137 /* Arguments for gl2psEnable/gl2psDisable */
138 
139 #define GL2PS_POLYGON_OFFSET_FILL 1
140 #define GL2PS_POLYGON_BOUNDARY 2
141 #define GL2PS_LINE_STIPPLE 3
142 #define GL2PS_BLEND 4
143 
144 /* Text alignment (o=raster position; default mode is BL):
145  +---+ +---+ +---+ +---+ +---+ +---+ +-o-+ o---+ +---o
146  | o | o | | o | | | | | | | | | | | |
147  +---+ +---+ +---+ +-o-+ o---+ +---o +---+ +---+ +---+
148  C CL CR B BL BR T TL TR */
149 
150 #define GL2PS_TEXT_C 1
151 #define GL2PS_TEXT_CL 2
152 #define GL2PS_TEXT_CR 3
153 #define GL2PS_TEXT_B 4
154 #define GL2PS_TEXT_BL 5
155 #define GL2PS_TEXT_BR 6
156 #define GL2PS_TEXT_T 7
157 #define GL2PS_TEXT_TL 8
158 #define GL2PS_TEXT_TR 9
159 
160 typedef GLfloat GL2PSrgba[4];
161 
162 #if defined(__cplusplus)
163 extern "C" {
164 #endif
165 
166 GL2PSDLL_API GLint gl2psBeginPage(const char *title, const char *producer,
167  GLint viewport[4], GLint format, GLint sort,
168  GLint options, GLint colormode,
169  GLint colorsize, GL2PSrgba *colormap,
170  GLint nr, GLint ng, GLint nb, GLint buffersize,
171  FILE *stream, const char *filename);
172 GL2PSDLL_API GLint gl2psEndPage(void);
173 GL2PSDLL_API GLint gl2psSetOptions(GLint options);
174 GL2PSDLL_API GLint gl2psGetOptions(GLint *options);
175 GL2PSDLL_API GLint gl2psBeginViewport(GLint viewport[4]);
176 GL2PSDLL_API GLint gl2psEndViewport(void);
177 GL2PSDLL_API GLint gl2psText(const char *str, const char *fontname,
178  GLshort fontsize);
179 GL2PSDLL_API GLint gl2psTextOpt(const char *str, const char *fontname,
180  GLshort fontsize, GLint align, GLfloat angle);
181 GL2PSDLL_API GLint gl2psSpecial(GLint format, const char *str);
182 GL2PSDLL_API GLint gl2psDrawPixels(GLsizei width, GLsizei height,
183  GLint xorig, GLint yorig,
184  GLenum format, GLenum type, const void *pixels);
185 GL2PSDLL_API GLint gl2psEnable(GLint mode);
186 GL2PSDLL_API GLint gl2psDisable(GLint mode);
187 GL2PSDLL_API GLint gl2psPointSize(GLfloat value);
188 GL2PSDLL_API GLint gl2psLineWidth(GLfloat value);
189 GL2PSDLL_API GLint gl2psBlendFunc(GLenum sfactor, GLenum dfactor);
190 
191 /* undocumented */
192 GL2PSDLL_API GLint gl2psDrawImageMap(GLsizei width, GLsizei height,
193  const GLfloat position[3],
194  const unsigned char *imagemap);
195 GL2PSDLL_API const char *gl2psGetFileExtension(GLint format);
196 GL2PSDLL_API const char *gl2psGetFormatDescription(GLint format);
197 
198 #if defined(__cplusplus)
199 }
200 #endif
201 
202 #endif /* __GL2PS_H__ */