2 * Copyright (C) 2003 Robert Kooima
4 * NEVERBALL is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published
6 * by the Free Software Foundation; either version 2 of the License,
7 * or (at your option) any later version.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
19 #include "base_config.h"
22 * Some might be taken aback at the terseness of the names of the
23 * structure members and the variables used by the functions that
24 * access them. Yes, yes, I know: readability. I contend that once
25 * the naming convention is embraced, the names become more readable
26 * than any verbose alternative, and their brevity and uniformity do
27 * more to augment readability than longVariableNames ever could.
29 * Members and variables are named XY. X determines the type of
30 * structure to which the variable refers. Y determines the usage of
33 * The Xs are as documented by struct s_file:
35 * f File (struct s_file)
36 * m Material (struct s_mtrl)
37 * v Vertex (struct s_vert)
38 * e Edge (struct s_edge)
39 * s Side (struct s_side)
40 * t Texture coord (struct s_texc)
41 * g Geometry (struct s_geom)
42 * l Lump (struct s_lump)
43 * n Node (struct s_node)
44 * p Path (struct s_path)
45 * b Body (struct s_body)
46 * h Item (struct s_item)
47 * z Goal (struct s_goal)
48 * j Jump (struct s_jump)
49 * x Switch (struct s_swch)
50 * r Billboard (struct s_bill)
51 * u User (struct s_ball)
52 * w Viewpoint (struct s_view)
53 * d Dictionary (struct s_dict)
57 * The Ys are as follows:
62 * 0 Index of the first
67 * Thus "up" is a pointer to a user structure. "lc" is the number of
68 * lumps. "ei" and "ej" are edge indices into some "ev" edge vector.
69 * An edge is defined by two vertices, so an edge structure consists
70 * of "vi" and "vj". And so on.
72 * Those members that do not conform to this convention are explicitly
73 * documented with a comment.
75 * These prefixes are still available: c k o q y.
78 /*---------------------------------------------------------------------------*/
80 /* Material type flags */
83 #define M_TRANSPARENT 2
84 #define M_REFLECTIVE 4
85 #define M_ENVIRONMENT 8
89 #define M_TWO_SIDED 128
91 /* Billboard types. */
107 #define ITEM_SHRINK 3
109 /*---------------------------------------------------------------------------*/
113 float d[4]; /* diffuse color */
114 float a[4]; /* ambient color */
115 float s[4]; /* specular color */
116 float e[4]; /* emission color */
117 float h[1]; /* specular exponent */
120 int fl; /* material flags */
122 GLuint o; /* OpenGL texture object */
123 char f[PATHMAX]; /* texture file name */
128 float p[3]; /* vertex position */
139 float n[3]; /* plane normal vector */
140 float d; /* distance from origin */
145 float u[2]; /* texture coordinate */
158 int fl; /* lump flags */
176 float p[3]; /* starting position */
177 float t; /* travel time */
180 int f; /* enable flag */
181 int s; /* smooth flag */
186 float t; /* time on current path */
188 GLuint ol; /* opaque geometry list */
189 GLuint tl; /* transparent geometry list */
190 GLuint rl; /* reflective geometry list */
191 GLuint sl; /* shadowed geometry list */
203 float p[3]; /* position */
210 float p[3]; /* position */
211 float r; /* radius */
216 float p[3]; /* position */
217 float r; /* radius */
218 int pi; /* the linked path */
220 float t0; /* default timer */
221 float t; /* current timer */
222 int f0; /* default state */
223 int f; /* current state */
224 int i; /* is invisible? */
225 int e; /* is a ball inside it? */
232 float t; /* repeat time interval */
233 float d; /* distance */
235 float w[3]; /* width coefficients */
236 float h[3]; /* height coefficients */
238 float rx[3]; /* X rotation coefficients */
239 float ry[3]; /* Y rotation coefficients */
240 float rz[3]; /* Z rotation coefficients */
247 float p[3]; /* position */
248 float q[3]; /* target position */
249 float r; /* radius */
254 float e[3][3]; /* basis of orientation */
255 float p[3]; /* position vector */
256 float v[3]; /* velocity vector */
257 float w[3]; /* angular velocity vector */
258 float E[3][3]; /* basis of pendulum */
259 float W[3]; /* angular pendulum velocity */
260 float r; /* radius */
320 /*---------------------------------------------------------------------------*/
322 int sol_load_only_file(struct s_file *, const char *);
323 int sol_load_only_head(struct s_file *, const char *);
324 int sol_stor(struct s_file *, const char *);
325 void sol_free(struct s_file *);
327 /*---------------------------------------------------------------------------*/