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
88 #define M_SHADOWED (M_OPAQUE | M_REFLECTIVE | M_ENVIRONMENT)
90 /* Billboard types. */
105 #define ITEM_SHRINK 3
107 /*---------------------------------------------------------------------------*/
111 float a[4]; /* ambient color */
112 float d[4]; /* diffuse color */
113 float s[4]; /* specular color */
114 float e[4]; /* emission color */
115 float h[1]; /* specular exponent */
117 int fl; /* material flags */
119 GLuint o; /* OpenGL texture object */
120 char f[PATHMAX]; /* texture file name */
125 float p[3]; /* vertex position */
136 float n[3]; /* plane normal vector */
137 float d; /* distance from origin */
142 float u[2]; /* texture coordinate */
155 int fl; /* lump flags */
173 float p[3]; /* starting position */
174 float t; /* travel time */
177 int f; /* enable flag */
182 float t; /* time on current path */
184 GLuint ol; /* opaque geometry list */
185 GLuint tl; /* transparent geometry list */
186 GLuint rl; /* reflective geometry list */
187 GLuint sl; /* shadowed geometry list */
199 float p[3]; /* position */
206 float p[3]; /* position */
207 float r; /* radius */
212 float p[3]; /* position */
213 float r; /* radius */
214 int pi; /* the linked path */
216 float t0; /* default timer */
217 float t; /* current timer */
218 int f0; /* default state */
219 int f; /* current state */
220 int i; /* is invisible? */
221 int e; /* is a ball inside it? */
228 float t; /* repeat time interval */
229 float d; /* distance */
231 float w[3]; /* width coefficients */
232 float h[3]; /* height coefficients */
234 float rx[3]; /* X rotation coefficients */
235 float ry[3]; /* Y rotation coefficients */
236 float rz[3]; /* Z rotation coefficients */
241 float p[3]; /* position */
242 float q[3]; /* target position */
243 float r; /* radius */
248 float e[3][3]; /* basis of orientation */
249 float p[3]; /* position vector */
250 float v[3]; /* velocity vector */
251 float w[3]; /* angular velocity vector */
252 float r; /* radius */
312 /*---------------------------------------------------------------------------*/
314 void sol_body_p(float p[3], const struct s_file *, const struct s_body *);
316 /*---------------------------------------------------------------------------*/
318 int sol_load_only_file(struct s_file *, const char *);
319 int sol_load_only_head(struct s_file *, const char *);
320 int sol_stor(struct s_file *, const char *);
321 void sol_free(struct s_file *);
323 float sol_step(struct s_file *, const float *, float, int, int *);
325 int sol_jump_test(struct s_file *, float *, int);
326 int sol_swch_test(struct s_file *, int);
328 struct s_goal *sol_goal_test(struct s_file *, float *, int);
329 struct s_item *sol_item_test(struct s_file *, float *, float);
331 /*---------------------------------------------------------------------------*/
333 void put_file_state(FILE *, struct s_file *);
334 void get_file_state(FILE *, struct s_file *);
336 /*---------------------------------------------------------------------------*/