]> de.git.xonotic.org Git - xonotic/darkplaces.git/blob - model_sprite.c
Changed the collision code used by sv_gameplayfix_nudgeoutofsolid to not consider...
[xonotic/darkplaces.git] / model_sprite.c
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12
13 See the GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18
19 */
20 // models.c -- model loading and caching
21
22 // models are the only shared resource between a client and server running
23 // on the same machine.
24
25 #include "quakedef.h"
26 #include "image.h"
27
28 cvar_t r_mipsprites = {CVAR_SAVE, "r_mipsprites", "1", "mipmaps sprites so they render faster in the distance and do not display noise artifacts"};
29 cvar_t r_labelsprites_scale = {CVAR_SAVE, "r_labelsprites_scale", "1", "global scale to apply to label sprites before conversion to HUD coordinates"};
30 cvar_t r_labelsprites_roundtopixels = {CVAR_SAVE, "r_labelsprites_roundtopixels", "1", "try to make label sprites sharper by rounding their size to 0.5x or 1x and by rounding their position to whole pixels if possible"};
31 cvar_t r_overheadsprites_perspective = {CVAR_SAVE, "r_overheadsprites_perspective", "5", "fake perspective effect for SPR_OVERHEAD sprites"};
32 cvar_t r_overheadsprites_pushback = {CVAR_SAVE, "r_overheadsprites_pushback", "15", "how far to pull the SPR_OVERHEAD sprites toward the eye (used to avoid intersections with 3D models)"};
33 cvar_t r_overheadsprites_scalex = {CVAR_SAVE, "r_overheadsprites_scalex", "1", "additional scale for overhead sprites for x axis"};
34 cvar_t r_overheadsprites_scaley = {CVAR_SAVE, "r_overheadsprites_scaley", "1", "additional scale for overhead sprites for y axis"};
35 cvar_t r_track_sprites = {CVAR_SAVE, "r_track_sprites", "1", "track SPR_LABEL* sprites by putting them as indicator at the screen border to rotate to"};
36 cvar_t r_track_sprites_flags = {CVAR_SAVE, "r_track_sprites_flags", "1", "1: Rotate sprites accordingly, 2: Make it a continuous rotation"};
37 cvar_t r_track_sprites_scalew = {CVAR_SAVE, "r_track_sprites_scalew", "1", "width scaling of tracked sprites"};
38 cvar_t r_track_sprites_scaleh = {CVAR_SAVE, "r_track_sprites_scaleh", "1", "height scaling of tracked sprites"};
39
40 /*
41 ===============
42 Mod_SpriteInit
43 ===============
44 */
45 void Mod_SpriteInit (void)
46 {
47         Cvar_RegisterVariable(&r_mipsprites);
48         Cvar_RegisterVariable(&r_labelsprites_scale);
49         Cvar_RegisterVariable(&r_labelsprites_roundtopixels);
50         Cvar_RegisterVariable(&r_overheadsprites_perspective);
51         Cvar_RegisterVariable(&r_overheadsprites_pushback);
52         Cvar_RegisterVariable(&r_overheadsprites_scalex);
53         Cvar_RegisterVariable(&r_overheadsprites_scaley);
54         Cvar_RegisterVariable(&r_track_sprites);
55         Cvar_RegisterVariable(&r_track_sprites_flags);
56         Cvar_RegisterVariable(&r_track_sprites_scalew);
57         Cvar_RegisterVariable(&r_track_sprites_scaleh);
58 }
59
60 static void Mod_SpriteSetupTexture(texture_t *texture, skinframe_t *skinframe, qboolean fullbright, qboolean additive)
61 {
62         if (!skinframe)
63                 skinframe = R_SkinFrame_LoadMissing();
64         texture->offsetmapping = OFFSETMAPPING_OFF;
65         texture->offsetscale = 1;
66         texture->offsetbias = 0;
67         texture->specularscalemod = 1;
68         texture->specularpowermod = 1;
69         texture->basematerialflags = MATERIALFLAG_WALL;
70         if (fullbright)
71                 texture->basematerialflags |= MATERIALFLAG_FULLBRIGHT;
72         if (additive)
73                 texture->basematerialflags |= MATERIALFLAG_ADD | MATERIALFLAG_BLENDED | MATERIALFLAG_NOSHADOW;
74         else if (skinframe->hasalpha)
75                 texture->basematerialflags |= MATERIALFLAG_ALPHA | MATERIALFLAG_BLENDED | MATERIALFLAG_NOSHADOW;
76         texture->currentmaterialflags = texture->basematerialflags;
77         texture->numskinframes = 1;
78         texture->currentskinframe = texture->skinframes[0] = skinframe;
79         texture->surfaceflags = 0;
80         texture->supercontents = SUPERCONTENTS_SOLID;
81         if (!(texture->basematerialflags & MATERIALFLAG_BLENDED))
82                 texture->supercontents |= SUPERCONTENTS_OPAQUE;
83         texture->transparentsort = TRANSPARENTSORT_DISTANCE;
84         // WHEN ADDING DEFAULTS HERE, REMEMBER TO PUT DEFAULTS IN ALL LOADERS
85         // JUST GREP FOR "specularscalemod = 1".
86 }
87
88 extern cvar_t gl_texturecompression_sprites;
89
90 static void Mod_Sprite_SharedSetup(const unsigned char *datapointer, int version, const unsigned int *palette, qboolean additive)
91 {
92         int                                     i, j, groupframes, realframes, x, y, origin[2], width, height;
93         qboolean                        fullbright;
94         dspriteframetype_t      *pinframetype;
95         dspriteframe_t          *pinframe;
96         dspritegroup_t          *pingroup;
97         dspriteinterval_t       *pinintervals;
98         skinframe_t                     *skinframe;
99         float                           modelradius, interval;
100         char                            name[MAX_QPATH], fogname[MAX_QPATH];
101         const void                      *startframes;
102         int                 texflags = (r_mipsprites.integer ? TEXF_MIPMAP : 0) | ((gl_texturecompression.integer && gl_texturecompression_sprites.integer) ? TEXF_COMPRESS : 0) | TEXF_ISSPRITE | TEXF_PICMIP | TEXF_ALPHA | TEXF_CLAMP;
103         modelradius = 0;
104
105         if (loadmodel->numframes < 1)
106                 Host_Error ("Mod_Sprite_SharedSetup: Invalid # of frames: %d", loadmodel->numframes);
107
108         // LordHavoc: hack to allow sprites to be non-fullbright
109         fullbright = true;
110         for (i = 0;i < MAX_QPATH && loadmodel->name[i];i++)
111                 if (loadmodel->name[i] == '!')
112                         fullbright = false;
113
114 //
115 // load the frames
116 //
117         startframes = datapointer;
118         realframes = 0;
119         for (i = 0;i < loadmodel->numframes;i++)
120         {
121                 pinframetype = (dspriteframetype_t *)datapointer;
122                 datapointer += sizeof(dspriteframetype_t);
123
124                 if (LittleLong (pinframetype->type) == SPR_SINGLE)
125                         groupframes = 1;
126                 else
127                 {
128                         pingroup = (dspritegroup_t *)datapointer;
129                         datapointer += sizeof(dspritegroup_t);
130
131                         groupframes = LittleLong(pingroup->numframes);
132
133                         datapointer += sizeof(dspriteinterval_t) * groupframes;
134                 }
135
136                 for (j = 0;j < groupframes;j++)
137                 {
138                         pinframe = (dspriteframe_t *)datapointer;
139                         if (version == SPRITE32_VERSION)
140                                 datapointer += sizeof(dspriteframe_t) + LittleLong(pinframe->width) * LittleLong(pinframe->height) * 4;
141                         else //if (version == SPRITE_VERSION || version == SPRITEHL_VERSION)
142                                 datapointer += sizeof(dspriteframe_t) + LittleLong(pinframe->width) * LittleLong(pinframe->height);
143                 }
144                 realframes += groupframes;
145         }
146
147         loadmodel->animscenes = (animscene_t *)Mem_Alloc(loadmodel->mempool, sizeof(animscene_t) * loadmodel->numframes);
148         loadmodel->sprite.sprdata_frames = (mspriteframe_t *)Mem_Alloc(loadmodel->mempool, sizeof(mspriteframe_t) * realframes);
149         loadmodel->num_textures = realframes;
150         loadmodel->num_texturesperskin = 1;
151         loadmodel->data_textures = (texture_t *)Mem_Alloc(loadmodel->mempool, sizeof(texture_t) * loadmodel->num_textures);
152
153         datapointer = (unsigned char *)startframes;
154         realframes = 0;
155         for (i = 0;i < loadmodel->numframes;i++)
156         {
157                 pinframetype = (dspriteframetype_t *)datapointer;
158                 datapointer += sizeof(dspriteframetype_t);
159
160                 if (LittleLong (pinframetype->type) == SPR_SINGLE)
161                 {
162                         groupframes = 1;
163                         interval = 0.1f;
164                 }
165                 else
166                 {
167                         pingroup = (dspritegroup_t *)datapointer;
168                         datapointer += sizeof(dspritegroup_t);
169
170                         groupframes = LittleLong(pingroup->numframes);
171
172                         pinintervals = (dspriteinterval_t *)datapointer;
173                         datapointer += sizeof(dspriteinterval_t) * groupframes;
174
175                         interval = LittleFloat(pinintervals[0].interval);
176                         if (interval < 0.01f)
177                                 Host_Error("Mod_Sprite_SharedSetup: invalid interval");
178                 }
179
180                 dpsnprintf(loadmodel->animscenes[i].name, sizeof(loadmodel->animscenes[i].name), "frame %i", i);
181                 loadmodel->animscenes[i].firstframe = realframes;
182                 loadmodel->animscenes[i].framecount = groupframes;
183                 loadmodel->animscenes[i].framerate = 1.0f / interval;
184                 loadmodel->animscenes[i].loop = true;
185
186                 for (j = 0;j < groupframes;j++)
187                 {
188                         pinframe = (dspriteframe_t *)datapointer;
189                         datapointer += sizeof(dspriteframe_t);
190
191                         origin[0] = LittleLong (pinframe->origin[0]);
192                         origin[1] = LittleLong (pinframe->origin[1]);
193                         width = LittleLong (pinframe->width);
194                         height = LittleLong (pinframe->height);
195
196                         loadmodel->sprite.sprdata_frames[realframes].left = origin[0];
197                         loadmodel->sprite.sprdata_frames[realframes].right = origin[0] + width;
198                         loadmodel->sprite.sprdata_frames[realframes].up = origin[1];
199                         loadmodel->sprite.sprdata_frames[realframes].down = origin[1] - height;
200
201                         x = (int)max(loadmodel->sprite.sprdata_frames[realframes].left * loadmodel->sprite.sprdata_frames[realframes].left, loadmodel->sprite.sprdata_frames[realframes].right * loadmodel->sprite.sprdata_frames[realframes].right);
202                         y = (int)max(loadmodel->sprite.sprdata_frames[realframes].up * loadmodel->sprite.sprdata_frames[realframes].up, loadmodel->sprite.sprdata_frames[realframes].down * loadmodel->sprite.sprdata_frames[realframes].down);
203                         if (modelradius < x + y)
204                                 modelradius = x + y;
205
206                         if (cls.state != ca_dedicated)
207                         {
208                                 skinframe = NULL;
209                                 // note: Nehahra's null.spr has width == 0 and height == 0
210                                 if (width > 0 && height > 0)
211                                 {
212                                         if (groupframes > 1)
213                                         {
214                                                 dpsnprintf (name, sizeof(name), "%s_%i_%i", loadmodel->name, i, j);
215                                                 dpsnprintf (fogname, sizeof(fogname), "%s_%i_%ifog", loadmodel->name, i, j);
216                                         }
217                                         else
218                                         {
219                                                 dpsnprintf (name, sizeof(name), "%s_%i", loadmodel->name, i);
220                                                 dpsnprintf (fogname, sizeof(fogname), "%s_%ifog", loadmodel->name, i);
221                                         }
222                                         if (!(skinframe = R_SkinFrame_LoadExternal(name, texflags | TEXF_COMPRESS, false)))
223                                         {
224                                                 unsigned char *pixels = (unsigned char *) Mem_Alloc(loadmodel->mempool, width*height*4);
225                                                 if (version == SPRITE32_VERSION)
226                                                 {
227                                                         for (x = 0;x < width*height;x++)
228                                                         {
229                                                                 pixels[x*4+2] = datapointer[x*4+0];
230                                                                 pixels[x*4+1] = datapointer[x*4+1];
231                                                                 pixels[x*4+0] = datapointer[x*4+2];
232                                                                 pixels[x*4+3] = datapointer[x*4+3];
233                                                         }
234                                                 }
235                                                 else //if (version == SPRITEHL_VERSION || version == SPRITE_VERSION)
236                                                         Image_Copy8bitBGRA(datapointer, pixels, width*height, palette ? palette : palette_bgra_transparent);
237                                                 skinframe = R_SkinFrame_LoadInternalBGRA(name, texflags, pixels, width, height, false);
238                                                 // texflags |= TEXF_COMPRESS;
239                                                 Mem_Free(pixels);
240                                         }
241                                 }
242                                 if (skinframe == NULL)
243                                         skinframe = R_SkinFrame_LoadMissing();
244                                 Mod_SpriteSetupTexture(&loadmodel->data_textures[realframes], skinframe, fullbright, additive);
245                         }
246
247                         if (version == SPRITE32_VERSION)
248                                 datapointer += width * height * 4;
249                         else //if (version == SPRITE_VERSION || version == SPRITEHL_VERSION)
250                                 datapointer += width * height;
251                         realframes++;
252                 }
253         }
254
255         modelradius = sqrt(modelradius);
256         for (i = 0;i < 3;i++)
257         {
258                 loadmodel->normalmins[i] = loadmodel->yawmins[i] = loadmodel->rotatedmins[i] = -modelradius;
259                 loadmodel->normalmaxs[i] = loadmodel->yawmaxs[i] = loadmodel->rotatedmaxs[i] = modelradius;
260         }
261         loadmodel->radius = modelradius;
262         loadmodel->radius2 = modelradius * modelradius;
263 }
264
265 void Mod_IDSP_Load(dp_model_t *mod, void *buffer, void *bufferend)
266 {
267         int version;
268         const unsigned char *datapointer;
269
270         datapointer = (unsigned char *)buffer;
271
272         loadmodel->modeldatatypestring = "SPR1";
273
274         loadmodel->type = mod_sprite;
275
276         loadmodel->DrawSky = NULL;
277         loadmodel->Draw = R_Model_Sprite_Draw;
278         loadmodel->DrawDepth = NULL;
279         loadmodel->CompileShadowVolume = NULL;
280         loadmodel->DrawShadowVolume = NULL;
281         loadmodel->DrawLight = NULL;
282         loadmodel->DrawAddWaterPlanes = NULL;
283
284         version = LittleLong(((dsprite_t *)buffer)->version);
285         if (version == SPRITE_VERSION || version == SPRITE32_VERSION)
286         {
287                 dsprite_t *pinqsprite;
288
289                 pinqsprite = (dsprite_t *)datapointer;
290                 datapointer += sizeof(dsprite_t);
291
292                 loadmodel->numframes = LittleLong (pinqsprite->numframes);
293                 loadmodel->sprite.sprnum_type = LittleLong (pinqsprite->type);
294                 loadmodel->synctype = (synctype_t)LittleLong (pinqsprite->synctype);
295
296                 Mod_Sprite_SharedSetup(datapointer, LittleLong (pinqsprite->version), NULL, false);
297         }
298         else if (version == SPRITEHL_VERSION)
299         {
300                 int i, rendermode;
301                 unsigned char palette[256][4];
302                 const unsigned char *in;
303                 dspritehl_t *pinhlsprite;
304
305                 pinhlsprite = (dspritehl_t *)datapointer;
306                 datapointer += sizeof(dspritehl_t);
307
308                 loadmodel->numframes = LittleLong (pinhlsprite->numframes);
309                 loadmodel->sprite.sprnum_type = LittleLong (pinhlsprite->type);
310                 loadmodel->synctype = (synctype_t)LittleLong (pinhlsprite->synctype);
311                 rendermode = pinhlsprite->rendermode;
312
313                 in = datapointer;
314                 datapointer += 2;
315                 i = in[0] + in[1] * 256;
316                 if (i != 256)
317                         Host_Error ("Mod_IDSP_Load: unexpected number of palette colors %i (should be 256)", i);
318                 in = datapointer;
319                 datapointer += 768;
320                 switch(rendermode)
321                 {
322                 case SPRHL_OPAQUE:
323                         for (i = 0;i < 256;i++)
324                         {
325                                 palette[i][2] = in[i*3+0];
326                                 palette[i][1] = in[i*3+1];
327                                 palette[i][0] = in[i*3+2];
328                                 palette[i][3] = 255;
329                         }
330                         break;
331                 case SPRHL_ADDITIVE:
332                         for (i = 0;i < 256;i++)
333                         {
334                                 palette[i][2] = in[i*3+0];
335                                 palette[i][1] = in[i*3+1];
336                                 palette[i][0] = in[i*3+2];
337                                 palette[i][3] = 255;
338                         }
339                         // also passes additive == true to Mod_Sprite_SharedSetup
340                         break;
341                 case SPRHL_INDEXALPHA:
342                         for (i = 0;i < 256;i++)
343                         {
344                                 palette[i][2] = in[765];
345                                 palette[i][1] = in[766];
346                                 palette[i][0] = in[767];
347                                 palette[i][3] = i;
348                                 in += 3;
349                         }
350                         break;
351                 case SPRHL_ALPHATEST:
352                         for (i = 0;i < 256;i++)
353                         {
354                                 palette[i][2] = in[i*3+0];
355                                 palette[i][1] = in[i*3+1];
356                                 palette[i][0] = in[i*3+2];
357                                 palette[i][3] = 255;
358                         }
359                         palette[255][0] = palette[255][1] = palette[255][2] = palette[255][3] = 0;
360                         // should this use alpha test or alpha blend?  (currently blend)
361                         break;
362                 default:
363                         Host_Error("Mod_IDSP_Load: unknown texFormat (%i, should be 0, 1, 2, or 3)", i);
364                         return;
365                 }
366
367                 Mod_Sprite_SharedSetup(datapointer, LittleLong (pinhlsprite->version), (unsigned int *)(&palette[0][0]), rendermode == SPRHL_ADDITIVE);
368         }
369         else
370                 Host_Error("Mod_IDSP_Load: %s has wrong version number (%i). Only %i (quake), %i (HalfLife), and %i (sprite32) supported",
371                                         loadmodel->name, version, SPRITE_VERSION, SPRITEHL_VERSION, SPRITE32_VERSION);
372
373         loadmodel->surfmesh.isanimated = loadmodel->numframes > 1 || (loadmodel->animscenes && loadmodel->animscenes[0].framecount > 1);
374 }
375
376
377 void Mod_IDS2_Load(dp_model_t *mod, void *buffer, void *bufferend)
378 {
379         int i, version;
380         qboolean fullbright;
381         const dsprite2_t *pinqsprite;
382         skinframe_t *skinframe;
383         float modelradius;
384         int texflags = (r_mipsprites.integer ? TEXF_MIPMAP : 0) | TEXF_ISSPRITE | TEXF_PICMIP | TEXF_COMPRESS | TEXF_ALPHA | TEXF_CLAMP;
385
386         loadmodel->modeldatatypestring = "SPR2";
387
388         loadmodel->type = mod_sprite;
389
390         loadmodel->DrawSky = NULL;
391         loadmodel->Draw = R_Model_Sprite_Draw;
392         loadmodel->DrawDepth = NULL;
393         loadmodel->CompileShadowVolume = NULL;
394         loadmodel->DrawShadowVolume = NULL;
395         loadmodel->DrawLight = NULL;
396         loadmodel->DrawAddWaterPlanes = NULL;
397
398         pinqsprite = (dsprite2_t *)buffer;
399
400         version = LittleLong(pinqsprite->version);
401         if (version != SPRITE2_VERSION)
402                 Host_Error("Mod_IDS2_Load: %s has wrong version number (%i should be 2 (quake 2)", loadmodel->name, version);
403
404         loadmodel->numframes = LittleLong (pinqsprite->numframes);
405         if (loadmodel->numframes < 1)
406                 Host_Error ("Mod_IDS2_Load: Invalid # of frames: %d", loadmodel->numframes);
407         loadmodel->sprite.sprnum_type = SPR_VP_PARALLEL;
408         loadmodel->synctype = ST_SYNC;
409
410         // LordHavoc: hack to allow sprites to be non-fullbright
411         fullbright = true;
412         for (i = 0;i < MAX_QPATH && loadmodel->name[i];i++)
413                 if (loadmodel->name[i] == '!')
414                         fullbright = false;
415
416         loadmodel->animscenes = (animscene_t *)Mem_Alloc(loadmodel->mempool, sizeof(animscene_t) * loadmodel->numframes);
417         loadmodel->sprite.sprdata_frames = (mspriteframe_t *)Mem_Alloc(loadmodel->mempool, sizeof(mspriteframe_t) * loadmodel->numframes);
418         loadmodel->num_textures = loadmodel->numframes;
419         loadmodel->num_texturesperskin = 1;
420         loadmodel->data_textures = (texture_t *)Mem_Alloc(loadmodel->mempool, sizeof(texture_t) * loadmodel->num_textures);
421
422         modelradius = 0;
423         for (i = 0;i < loadmodel->numframes;i++)
424         {
425                 int origin[2], x, y, width, height;
426                 const dsprite2frame_t *pinframe;
427                 mspriteframe_t *sprframe;
428
429                 dpsnprintf(loadmodel->animscenes[i].name, sizeof(loadmodel->animscenes[i].name), "frame %i", i);
430                 loadmodel->animscenes[i].firstframe = i;
431                 loadmodel->animscenes[i].framecount = 1;
432                 loadmodel->animscenes[i].framerate = 10;
433                 loadmodel->animscenes[i].loop = true;
434
435                 pinframe = &pinqsprite->frames[i];
436
437                 origin[0] = LittleLong (pinframe->origin_x);
438                 origin[1] = LittleLong (pinframe->origin_y);
439                 width = LittleLong (pinframe->width);
440                 height = LittleLong (pinframe->height);
441
442                 sprframe = &loadmodel->sprite.sprdata_frames[i];
443
444                 // note that sp2 origin[0] is positive, where as it is negative in
445                 // spr/spr32/hlspr
446                 sprframe->left = -origin[0];
447                 sprframe->right = -origin[0] + width;
448                 sprframe->up = origin[1];
449                 sprframe->down = origin[1] - height;
450
451                 x = (int)max(sprframe->left * sprframe->left, sprframe->right * sprframe->right);
452                 y = (int)max(sprframe->up * sprframe->up, sprframe->down * sprframe->down);
453                 if (modelradius < x + y)
454                         modelradius = x + y;
455         }
456
457         if (cls.state != ca_dedicated)
458         {
459                 for (i = 0;i < loadmodel->numframes;i++)
460                 {
461                         const dsprite2frame_t *pinframe;
462                         pinframe = &pinqsprite->frames[i];
463                         if (!(skinframe = R_SkinFrame_LoadExternal(pinframe->name, texflags, false)))
464                         {
465                                 Con_Printf("Mod_IDS2_Load: failed to load %s", pinframe->name);
466                                 skinframe = R_SkinFrame_LoadMissing();
467                         }
468                         Mod_SpriteSetupTexture(&loadmodel->data_textures[i], skinframe, fullbright, false);
469                 }
470         }
471
472         modelradius = sqrt(modelradius);
473         for (i = 0;i < 3;i++)
474         {
475                 loadmodel->normalmins[i] = loadmodel->yawmins[i] = loadmodel->rotatedmins[i] = -modelradius;
476                 loadmodel->normalmaxs[i] = loadmodel->yawmaxs[i] = loadmodel->rotatedmaxs[i] = modelradius;
477         }
478         loadmodel->radius = modelradius;
479         loadmodel->radius2 = modelradius * modelradius;
480
481         loadmodel->surfmesh.isanimated = loadmodel->numframes > 1 || (loadmodel->animscenes && loadmodel->animscenes[0].framecount > 1);
482 }