2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
20 // models.c -- model loading and caching
22 // models are the only shared resource between a client and server running
23 // on the same machine.
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"};
45 void Mod_SpriteInit (void)
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);
60 static void Mod_SpriteSetupTexture(texture_t *texture, skinframe_t *skinframe, qboolean fullbright, qboolean additive)
63 skinframe = R_SkinFrame_LoadMissing();
64 texture->offsetmapping = OFFSETMAPPING_OFF;
65 texture->offsetscale = 1;
66 texture->specularscalemod = 1;
67 texture->specularpowermod = 1;
68 texture->basematerialflags = MATERIALFLAG_WALL;
70 texture->basematerialflags |= MATERIALFLAG_FULLBRIGHT;
72 texture->basematerialflags |= MATERIALFLAG_ADD | MATERIALFLAG_BLENDED | MATERIALFLAG_NOSHADOW;
73 else if (skinframe->hasalpha)
74 texture->basematerialflags |= MATERIALFLAG_ALPHA | MATERIALFLAG_BLENDED | MATERIALFLAG_NOSHADOW;
75 texture->currentmaterialflags = texture->basematerialflags;
76 texture->numskinframes = 1;
77 texture->currentskinframe = texture->skinframes[0] = skinframe;
78 texture->surfaceflags = 0;
79 texture->supercontents = SUPERCONTENTS_SOLID;
80 if (!(texture->basematerialflags & MATERIALFLAG_BLENDED))
81 texture->supercontents |= SUPERCONTENTS_OPAQUE;
84 extern cvar_t gl_texturecompression_sprites;
86 static void Mod_Sprite_SharedSetup(const unsigned char *datapointer, int version, const unsigned int *palette, qboolean additive)
88 int i, j, groupframes, realframes, x, y, origin[2], width, height;
90 dspriteframetype_t *pinframetype;
91 dspriteframe_t *pinframe;
92 dspritegroup_t *pingroup;
93 dspriteinterval_t *pinintervals;
94 skinframe_t *skinframe;
95 float modelradius, interval;
96 char name[MAX_QPATH], fogname[MAX_QPATH];
97 const void *startframes;
98 int texflags = (r_mipsprites.integer ? TEXF_MIPMAP : 0) | (gl_texturecompression_sprites.integer ? TEXF_COMPRESS : 0) | TEXF_ISSPRITE | TEXF_PICMIP | TEXF_ALPHA | TEXF_CLAMP;
101 if (loadmodel->numframes < 1)
102 Host_Error ("Mod_Sprite_SharedSetup: Invalid # of frames: %d", loadmodel->numframes);
104 // LordHavoc: hack to allow sprites to be non-fullbright
106 for (i = 0;i < MAX_QPATH && loadmodel->name[i];i++)
107 if (loadmodel->name[i] == '!')
113 startframes = datapointer;
115 for (i = 0;i < loadmodel->numframes;i++)
117 pinframetype = (dspriteframetype_t *)datapointer;
118 datapointer += sizeof(dspriteframetype_t);
120 if (LittleLong (pinframetype->type) == SPR_SINGLE)
124 pingroup = (dspritegroup_t *)datapointer;
125 datapointer += sizeof(dspritegroup_t);
127 groupframes = LittleLong(pingroup->numframes);
129 datapointer += sizeof(dspriteinterval_t) * groupframes;
132 for (j = 0;j < groupframes;j++)
134 pinframe = (dspriteframe_t *)datapointer;
135 if (version == SPRITE32_VERSION)
136 datapointer += sizeof(dspriteframe_t) + LittleLong(pinframe->width) * LittleLong(pinframe->height) * 4;
137 else //if (version == SPRITE_VERSION || version == SPRITEHL_VERSION)
138 datapointer += sizeof(dspriteframe_t) + LittleLong(pinframe->width) * LittleLong(pinframe->height);
140 realframes += groupframes;
143 loadmodel->animscenes = (animscene_t *)Mem_Alloc(loadmodel->mempool, sizeof(animscene_t) * loadmodel->numframes);
144 loadmodel->sprite.sprdata_frames = (mspriteframe_t *)Mem_Alloc(loadmodel->mempool, sizeof(mspriteframe_t) * realframes);
145 loadmodel->num_textures = realframes;
146 loadmodel->num_texturesperskin = 1;
147 loadmodel->data_textures = (texture_t *)Mem_Alloc(loadmodel->mempool, sizeof(texture_t) * loadmodel->num_textures);
149 datapointer = (unsigned char *)startframes;
151 for (i = 0;i < loadmodel->numframes;i++)
153 pinframetype = (dspriteframetype_t *)datapointer;
154 datapointer += sizeof(dspriteframetype_t);
156 if (LittleLong (pinframetype->type) == SPR_SINGLE)
163 pingroup = (dspritegroup_t *)datapointer;
164 datapointer += sizeof(dspritegroup_t);
166 groupframes = LittleLong(pingroup->numframes);
168 pinintervals = (dspriteinterval_t *)datapointer;
169 datapointer += sizeof(dspriteinterval_t) * groupframes;
171 interval = LittleFloat(pinintervals[0].interval);
172 if (interval < 0.01f)
173 Host_Error("Mod_Sprite_SharedSetup: invalid interval");
176 dpsnprintf(loadmodel->animscenes[i].name, sizeof(loadmodel->animscenes[i].name), "frame %i", i);
177 loadmodel->animscenes[i].firstframe = realframes;
178 loadmodel->animscenes[i].framecount = groupframes;
179 loadmodel->animscenes[i].framerate = 1.0f / interval;
180 loadmodel->animscenes[i].loop = true;
182 for (j = 0;j < groupframes;j++)
184 pinframe = (dspriteframe_t *)datapointer;
185 datapointer += sizeof(dspriteframe_t);
187 origin[0] = LittleLong (pinframe->origin[0]);
188 origin[1] = LittleLong (pinframe->origin[1]);
189 width = LittleLong (pinframe->width);
190 height = LittleLong (pinframe->height);
192 loadmodel->sprite.sprdata_frames[realframes].left = origin[0];
193 loadmodel->sprite.sprdata_frames[realframes].right = origin[0] + width;
194 loadmodel->sprite.sprdata_frames[realframes].up = origin[1];
195 loadmodel->sprite.sprdata_frames[realframes].down = origin[1] - height;
197 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);
198 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);
199 if (modelradius < x + y)
202 if (cls.state != ca_dedicated)
205 // note: Nehahra's null.spr has width == 0 and height == 0
206 if (width > 0 && height > 0)
210 dpsnprintf (name, sizeof(name), "%s_%i_%i", loadmodel->name, i, j);
211 dpsnprintf (fogname, sizeof(fogname), "%s_%i_%ifog", loadmodel->name, i, j);
215 dpsnprintf (name, sizeof(name), "%s_%i", loadmodel->name, i);
216 dpsnprintf (fogname, sizeof(fogname), "%s_%ifog", loadmodel->name, i);
218 if (!(skinframe = R_SkinFrame_LoadExternal(name, texflags | TEXF_COMPRESS, false)))
220 unsigned char *pixels = (unsigned char *) Mem_Alloc(loadmodel->mempool, width*height*4);
221 if (version == SPRITE32_VERSION)
223 for (x = 0;x < width*height;x++)
225 pixels[x*4+2] = datapointer[x*4+0];
226 pixels[x*4+1] = datapointer[x*4+1];
227 pixels[x*4+0] = datapointer[x*4+2];
228 pixels[x*4+3] = datapointer[x*4+3];
231 else //if (version == SPRITEHL_VERSION || version == SPRITE_VERSION)
232 Image_Copy8bitBGRA(datapointer, pixels, width*height, palette ? palette : palette_bgra_transparent);
233 skinframe = R_SkinFrame_LoadInternalBGRA(name, texflags, pixels, width, height, false);
234 // texflags |= TEXF_COMPRESS;
238 if (skinframe == NULL)
239 skinframe = R_SkinFrame_LoadMissing();
240 Mod_SpriteSetupTexture(&loadmodel->data_textures[realframes], skinframe, fullbright, additive);
243 if (version == SPRITE32_VERSION)
244 datapointer += width * height * 4;
245 else //if (version == SPRITE_VERSION || version == SPRITEHL_VERSION)
246 datapointer += width * height;
251 modelradius = sqrt(modelradius);
252 for (i = 0;i < 3;i++)
254 loadmodel->normalmins[i] = loadmodel->yawmins[i] = loadmodel->rotatedmins[i] = -modelradius;
255 loadmodel->normalmaxs[i] = loadmodel->yawmaxs[i] = loadmodel->rotatedmaxs[i] = modelradius;
257 loadmodel->radius = modelradius;
258 loadmodel->radius2 = modelradius * modelradius;
261 extern void R_Model_Sprite_Draw(entity_render_t *ent);
262 void Mod_IDSP_Load(dp_model_t *mod, void *buffer, void *bufferend)
265 const unsigned char *datapointer;
267 datapointer = (unsigned char *)buffer;
269 loadmodel->modeldatatypestring = "SPR1";
271 loadmodel->type = mod_sprite;
273 loadmodel->DrawSky = NULL;
274 loadmodel->Draw = R_Model_Sprite_Draw;
275 loadmodel->DrawDepth = NULL;
276 loadmodel->CompileShadowVolume = NULL;
277 loadmodel->DrawShadowVolume = NULL;
278 loadmodel->DrawLight = NULL;
279 loadmodel->DrawAddWaterPlanes = NULL;
281 version = LittleLong(((dsprite_t *)buffer)->version);
282 if (version == SPRITE_VERSION || version == SPRITE32_VERSION)
284 dsprite_t *pinqsprite;
286 pinqsprite = (dsprite_t *)datapointer;
287 datapointer += sizeof(dsprite_t);
289 loadmodel->numframes = LittleLong (pinqsprite->numframes);
290 loadmodel->sprite.sprnum_type = LittleLong (pinqsprite->type);
291 loadmodel->synctype = (synctype_t)LittleLong (pinqsprite->synctype);
293 Mod_Sprite_SharedSetup(datapointer, LittleLong (pinqsprite->version), NULL, false);
295 else if (version == SPRITEHL_VERSION)
298 unsigned char palette[256][4];
299 const unsigned char *in;
300 dspritehl_t *pinhlsprite;
302 pinhlsprite = (dspritehl_t *)datapointer;
303 datapointer += sizeof(dspritehl_t);
305 loadmodel->numframes = LittleLong (pinhlsprite->numframes);
306 loadmodel->sprite.sprnum_type = LittleLong (pinhlsprite->type);
307 loadmodel->synctype = (synctype_t)LittleLong (pinhlsprite->synctype);
308 rendermode = pinhlsprite->rendermode;
312 i = in[0] + in[1] * 256;
314 Host_Error ("Mod_IDSP_Load: unexpected number of palette colors %i (should be 256)", i);
320 for (i = 0;i < 256;i++)
322 palette[i][2] = in[i*3+0];
323 palette[i][1] = in[i*3+1];
324 palette[i][0] = in[i*3+2];
329 for (i = 0;i < 256;i++)
331 palette[i][2] = in[i*3+0];
332 palette[i][1] = in[i*3+1];
333 palette[i][0] = in[i*3+2];
336 // also passes additive == true to Mod_Sprite_SharedSetup
338 case SPRHL_INDEXALPHA:
339 for (i = 0;i < 256;i++)
341 palette[i][2] = in[765];
342 palette[i][1] = in[766];
343 palette[i][0] = in[767];
348 case SPRHL_ALPHATEST:
349 for (i = 0;i < 256;i++)
351 palette[i][2] = in[i*3+0];
352 palette[i][1] = in[i*3+1];
353 palette[i][0] = in[i*3+2];
356 palette[255][0] = palette[255][1] = palette[255][2] = palette[255][3] = 0;
357 // should this use alpha test or alpha blend? (currently blend)
360 Host_Error("Mod_IDSP_Load: unknown texFormat (%i, should be 0, 1, 2, or 3)", i);
364 Mod_Sprite_SharedSetup(datapointer, LittleLong (pinhlsprite->version), (unsigned int *)(&palette[0][0]), rendermode == SPRHL_ADDITIVE);
367 Host_Error("Mod_IDSP_Load: %s has wrong version number (%i). Only %i (quake), %i (HalfLife), and %i (sprite32) supported",
368 loadmodel->name, version, SPRITE_VERSION, SPRITEHL_VERSION, SPRITE32_VERSION);
370 loadmodel->surfmesh.isanimated = loadmodel->numframes > 1 || loadmodel->animscenes[0].framecount > 1;
374 void Mod_IDS2_Load(dp_model_t *mod, void *buffer, void *bufferend)
378 const dsprite2_t *pinqsprite;
379 skinframe_t *skinframe;
381 int texflags = (r_mipsprites.integer ? TEXF_MIPMAP : 0) | TEXF_ISSPRITE | TEXF_PICMIP | TEXF_COMPRESS | TEXF_ALPHA | TEXF_CLAMP;
383 loadmodel->modeldatatypestring = "SPR2";
385 loadmodel->type = mod_sprite;
387 loadmodel->DrawSky = NULL;
388 loadmodel->Draw = R_Model_Sprite_Draw;
389 loadmodel->DrawDepth = NULL;
390 loadmodel->CompileShadowVolume = NULL;
391 loadmodel->DrawShadowVolume = NULL;
392 loadmodel->DrawLight = NULL;
393 loadmodel->DrawAddWaterPlanes = NULL;
395 pinqsprite = (dsprite2_t *)buffer;
397 version = LittleLong(pinqsprite->version);
398 if (version != SPRITE2_VERSION)
399 Host_Error("Mod_IDS2_Load: %s has wrong version number (%i should be 2 (quake 2)", loadmodel->name, version);
401 loadmodel->numframes = LittleLong (pinqsprite->numframes);
402 if (loadmodel->numframes < 1)
403 Host_Error ("Mod_IDS2_Load: Invalid # of frames: %d", loadmodel->numframes);
404 loadmodel->sprite.sprnum_type = SPR_VP_PARALLEL;
405 loadmodel->synctype = ST_SYNC;
407 // LordHavoc: hack to allow sprites to be non-fullbright
409 for (i = 0;i < MAX_QPATH && loadmodel->name[i];i++)
410 if (loadmodel->name[i] == '!')
413 loadmodel->animscenes = (animscene_t *)Mem_Alloc(loadmodel->mempool, sizeof(animscene_t) * loadmodel->numframes);
414 loadmodel->sprite.sprdata_frames = (mspriteframe_t *)Mem_Alloc(loadmodel->mempool, sizeof(mspriteframe_t) * loadmodel->numframes);
415 loadmodel->num_textures = loadmodel->numframes;
416 loadmodel->num_texturesperskin = 1;
417 loadmodel->data_textures = (texture_t *)Mem_Alloc(loadmodel->mempool, sizeof(texture_t) * loadmodel->num_textures);
420 for (i = 0;i < loadmodel->numframes;i++)
422 int origin[2], x, y, width, height;
423 const dsprite2frame_t *pinframe;
424 mspriteframe_t *sprframe;
426 dpsnprintf(loadmodel->animscenes[i].name, sizeof(loadmodel->animscenes[i].name), "frame %i", i);
427 loadmodel->animscenes[i].firstframe = i;
428 loadmodel->animscenes[i].framecount = 1;
429 loadmodel->animscenes[i].framerate = 10;
430 loadmodel->animscenes[i].loop = true;
432 pinframe = &pinqsprite->frames[i];
434 origin[0] = LittleLong (pinframe->origin_x);
435 origin[1] = LittleLong (pinframe->origin_y);
436 width = LittleLong (pinframe->width);
437 height = LittleLong (pinframe->height);
439 sprframe = &loadmodel->sprite.sprdata_frames[i];
441 // note that sp2 origin[0] is positive, where as it is negative in
443 sprframe->left = -origin[0];
444 sprframe->right = -origin[0] + width;
445 sprframe->up = origin[1];
446 sprframe->down = origin[1] - height;
448 x = (int)max(sprframe->left * sprframe->left, sprframe->right * sprframe->right);
449 y = (int)max(sprframe->up * sprframe->up, sprframe->down * sprframe->down);
450 if (modelradius < x + y)
454 if (cls.state != ca_dedicated)
456 for (i = 0;i < loadmodel->numframes;i++)
458 const dsprite2frame_t *pinframe;
459 pinframe = &pinqsprite->frames[i];
460 if (!(skinframe = R_SkinFrame_LoadExternal(pinframe->name, texflags, false)))
462 Con_Printf("Mod_IDS2_Load: failed to load %s", pinframe->name);
463 skinframe = R_SkinFrame_LoadMissing();
465 Mod_SpriteSetupTexture(&loadmodel->data_textures[i], skinframe, fullbright, false);
469 modelradius = sqrt(modelradius);
470 for (i = 0;i < 3;i++)
472 loadmodel->normalmins[i] = loadmodel->yawmins[i] = loadmodel->rotatedmins[i] = -modelradius;
473 loadmodel->normalmaxs[i] = loadmodel->yawmaxs[i] = loadmodel->rotatedmaxs[i] = modelradius;
475 loadmodel->radius = modelradius;
476 loadmodel->radius2 = modelradius * modelradius;
478 loadmodel->surfmesh.isanimated = loadmodel->numframes > 1 || loadmodel->animscenes[0].framecount > 1;