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 * c Coin (struct s_coin)
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: h k o q y.
78 /*---------------------------------------------------------------------------*/
80 /* Material type flags */
83 #define M_TRANSPARENT 2
84 #define M_REFLECTIVE 4
85 #define M_ENVIRONMENT 8
88 #define M_SHADOWED (M_OPAQUE | M_REFLECTIVE | M_ENVIRONMENT)
90 /* Billboard types. */
100 /*---------------------------------------------------------------------------*/
104 float a[4]; /* ambient color */
105 float d[4]; /* diffuse color */
106 float s[4]; /* specular color */
107 float e[4]; /* emission color */
108 float h[1]; /* specular exponent */
110 int fl; /* material flags */
112 GLuint o; /* OpenGL texture object */
113 char f[PATHMAX]; /* texture file name */
118 float p[3]; /* vertex position */
129 float n[3]; /* plane normal vector */
130 float d; /* distance from origin */
135 float u[2]; /* texture coordinate */
148 int fl; /* lump flags */
166 float p[3]; /* starting position */
167 float t; /* travel time */
170 int f; /* enable flag */
175 float t; /* time on current path */
177 GLuint ol; /* opaque geometry list */
178 GLuint tl; /* transparent geometry list */
179 GLuint rl; /* reflective geometry list */
180 GLuint sl; /* shadowed geometry list */
192 float p[3]; /* position */
198 float p[3]; /* position */
199 float r; /* radius */
200 int s; /* levels skiped */
201 int c; /* special coloration? */
206 float p[3]; /* position */
207 float r; /* radius */
208 int pi; /* the linked path */
210 float t0; /* default timer */
211 float t; /* current timer */
212 int f0; /* default state */
213 int f; /* current state */
214 int i; /* is invisible? */
215 int e; /* is a ball inside it? */
222 float t; /* repeat time interval */
223 float d; /* distance */
225 float w[3]; /* width coefficients */
226 float h[3]; /* height coefficients */
228 float rx[3]; /* X rotation coefficients */
229 float ry[3]; /* Y rotation coefficients */
230 float rz[3]; /* Z rotation coefficients */
235 float p[3]; /* position */
236 float q[3]; /* target position */
237 float r; /* radius */
242 float e[3][3]; /* basis of orientation */
243 float p[3]; /* position vector */
244 float v[3]; /* velocity vector */
245 float w[3]; /* angular velocity vector */
246 float r; /* radius */
247 float a; /* initial orientation (deg) */
306 /*---------------------------------------------------------------------------*/
308 void sol_body_p(float p[3], const struct s_file *, const struct s_body *);
310 /*---------------------------------------------------------------------------*/
312 int sol_load_only_file(struct s_file *, const char *);
313 int sol_stor(struct s_file *, const char *);
314 void sol_free(struct s_file *);
316 float sol_step(struct s_file *, const float *, float, int, int *);
318 int sol_coin_test(struct s_file *, float *, float);
319 struct s_goal *sol_goal_test(struct s_file *, float *, int);
320 int sol_jump_test(struct s_file *, float *, int);
321 int sol_swch_test(struct s_file *, int);
323 /*---------------------------------------------------------------------------*/
325 void put_file_state(FILE *, struct s_file *);
326 void get_file_state(FILE *, struct s_file *);
328 /*---------------------------------------------------------------------------*/