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.
25 #include "matrixlib.h"
27 // LordHavoc: 256 dynamic lights
28 #define MAX_DLIGHTS 256
29 // LordHavoc: this affects the lighting scale of the whole game
30 #define LIGHTOFFSET 1024.0f
31 // max lights shining on one entity
32 #define MAXENTLIGHTS 128
34 // flags for rtlight rendering
35 #define LIGHTFLAG_NORMALMODE 1
36 #define LIGHTFLAG_REALTIMEMODE 2
38 extern int cl_max_entities;
39 extern int cl_max_static_entities;
40 extern int cl_max_temp_entities;
41 extern int cl_max_effects;
42 extern int cl_max_beams;
44 typedef struct effect_s
53 // these are for interpolation
63 // draw this as lightning polygons, or a model?
65 struct model_s *model;
68 // if this beam is owned by an entity, this is the beam start relative to
69 // that entity's matrix for per frame start updates
72 // indicates whether relativestart is valid
73 int relativestartvalid;
77 typedef struct rtlight_s
79 // shadow volumes are done entirely in model space, so there are no matrices for dealing with them... they just use the origin
81 // note that the world to light matrices are inversely scaled (divided) by lightradius
84 // matrix for transforming world coordinates to light filter coordinates
85 matrix4x4_t matrix_worldtolight;
86 // based on worldtolight this transforms -1 to +1 to 0 to 1 for purposes
87 // of attenuation texturing in full 3D (Z result often ignored)
88 matrix4x4_t matrix_worldtoattenuationxyz;
89 // this transforms only the Z to S, and T is always 0.5
90 matrix4x4_t matrix_worldtoattenuationz;
91 // typically 1 1 1, can be lower (dim) or higher (overbright)
93 // size of the light (remove?)
97 // light style to monitor for brightness
99 // whether light should render shadows
101 // intensity of corona to render
103 // radius scale of corona to render (1.0 means same as light radius)
104 vec_t coronasizescale;
105 // ambient intensity to render
107 // diffuse intensity to render
109 // specular intensity to render
114 // generated properties
115 // used only for shadow volumes
122 // squared cullradius
125 // lightmap renderer stuff (remove someday!)
126 // the size of the light
127 vec_t lightmap_cullradius;
128 // the size of the light, squared
129 vec_t lightmap_cullradius2;
130 // the brightness of the light
131 vec3_t lightmap_light;
132 // to avoid sudden brightness change at cullradius, subtract this
133 vec_t lightmap_subtract;
136 // true if this light should be compiled as a static light
138 // true if this is a compiled world light, cleared if the light changes
140 // premade shadow volumes and lit surfaces to render for world entity
141 shadowmesh_t *static_meshchain_shadow;
142 shadowmesh_t *static_meshchain_light;
143 // used for visibility testing (more exact than bbox)
144 int static_numclusters;
145 int static_numclusterpvsbytes;
146 int *static_clusterlist;
147 qbyte *static_clusterpvs;
151 typedef struct dlight_s
153 // destroy light after this time
156 // the entity that owns this light (can be NULL)
158 struct entity_render_s *ent;
160 // (worldlight: saved to .rtlights file)
162 // worldlight orientation
164 // (worldlight: saved to .rtlights file)
166 // dlight orientation/scaling/location
170 // (worldlight: saved to .rtlights file)
172 // cubemap number to use on this light
175 // cubemap name to use on this light
177 // (worldlight: saved to .rtlights file)
178 char cubemapname[64];
179 // make light flash while selected
182 // brightness (not really radius anymore)
183 // (worldlight: saved to .rtlights file)
185 // drop radius this much each second
188 // light style which controls intensity of this light
189 // (worldlight: saved to .rtlights file)
192 // (worldlight: saved to .rtlights file)
195 // (worldlight: saved to .rtlights file)
197 // radius scale of corona to render (1.0 means same as light radius)
198 // (worldlight: saved to .rtlights file)
199 vec_t coronasizescale;
200 // ambient intensity to render
201 // (worldlight: saved to .rtlights file)
203 // diffuse intensity to render
204 // (worldlight: saved to .rtlights file)
206 // specular intensity to render
207 // (worldlight: saved to .rtlights file)
210 // (worldlight: saved to .rtlights file)
212 // linked list of world lights
214 struct dlight_s *next;
215 // embedded rtlight struct for renderer
221 typedef struct frameblend_s
228 // LordHavoc: this struct is intended for the renderer but some fields are
229 // used by the client.
230 typedef struct entity_render_s
236 // transform matrix for model to world
238 // transform matrix for world to model
239 matrix4x4_t inversematrix;
240 // opacity (alpha) of the model
242 // size the model is shown
247 // current uninterpolated animation frame (for things which do not use interpolation)
249 // entity shirt and pants colors
251 // light, particles, etc
258 // colormod tinting of models
261 // interpolated animation
263 // frame that the model is interpolating from
265 // frame that the model is interpolating to
267 // interpolation factor, usually computed from frame2time
269 // time frame1 began playing (for framegroup animations)
271 // time frame2 began playing (for framegroup animations)
274 // calculated by the renderer (but not persistent)
276 // if visframe == r_framecount, it is visible
278 // calculated during R_AddModelEntities
280 // 4 frame numbers (-1 if not used) and their blending scalers (0-1), if interpolation is not desired, use frame instead
281 frameblend_t frameblend[4];
283 // caching results of static light traces (this is semi-persistent)
284 double entlightstime;
285 vec3_t entlightsorigin;
288 unsigned short entlights[MAXENTLIGHTS];
292 typedef struct entity_persistent_s
301 // muzzleflash fading
304 // interpolated movement
306 // start time of move
308 // time difference from start to end of move
310 // the move itself, start and end
318 typedef struct entity_s
320 // baseline state (default values)
321 entity_state_t state_baseline;
322 // previous state (interpolating from this)
323 entity_state_t state_previous;
324 // current state (interpolating to this)
325 entity_state_t state_current;
327 // used for regenerating parts of render
328 entity_persistent_t persistent;
330 // the only data the renderer should know about
331 entity_render_t render;
339 // intended velocities
344 vec3_t cursor_screen;
347 vec3_t cursor_impact;
348 vec3_t cursor_normal;
349 vec_t cursor_fraction;
350 int cursor_entitynumber;
356 char map[MAX_STYLESTRING];
361 char name[MAX_SCOREBOARDNAME];
363 int colors; // two 4 bit fields
369 int percent; // 0-256
372 #define CSHIFT_CONTENTS 0
373 #define CSHIFT_DAMAGE 1
374 #define CSHIFT_BONUS 2
375 #define CSHIFT_POWERUP 3
376 #define CSHIFT_VCSHIFT 4
377 #define NUM_CSHIFTS 5
379 #define NAME_LENGTH 64
383 // client_state_t should hold all pieces of the client state
386 #define SIGNONS 4 // signon messages to receive before connected
389 #define MAX_DEMONAME 16
393 ca_dedicated, // a dedicated server with no ability to start a client
394 ca_disconnected, // full screen console with no connection
395 ca_connected // valid netcon, talking to a server
400 // the client_static_t structure is persistent through an arbitrary number
401 // of server connections
408 // -1 = don't play demos
410 // list of demos in loop
411 char demos[MAX_DEMOS][MAX_DEMONAME];
412 // the actively playing demo (set by CL_PlayDemo_f)
415 // demo recording info must be here, because record is started before
416 // entering a map (and clearing client_state_t)
417 qboolean demorecording;
418 qboolean demoplayback;
420 // -1 = use normal cd track
423 // to meter out one message a frame
425 // host_framecount at start
427 // realtime at second frame of timedemo (LordHavoc: changed to double)
429 // LordHavoc: for measuring maxfps
430 double td_minframetime;
431 // LordHavoc: for measuring minfps
432 double td_maxframetime;
433 // LordHavoc: pausedemo
436 qboolean connect_trying;
437 int connect_remainingtries;
438 double connect_nextsendtime;
439 lhnetsocket_t *connect_mysocket;
440 lhnetaddress_t connect_address;
442 // connection information
445 // network connection
447 // writing buffer to send to server
452 extern client_static_t cls;
455 // the client_state_t structure is wiped completely at every
460 // true if playing in a local game and no one else is connected
463 // when connecting to the server throw out the first couple move messages
464 // so the player doesn't accidentally do something the first frame
467 // send a clc_nop periodically until connected
470 // current input to send to the server
473 // information for local display
475 int stats[MAX_CL_STATS];
476 // last known inventory bit flags, for blinking
478 // cl.time of acquiring item, for blinking
479 float item_gettime[32];
480 // last known STAT_ACTIVEWEAPON
482 // cl.time of changing STAT_ACTIVEWEAPON
484 // use pain anim frame if cl.time < this
487 // color shifts for damage, powerups
488 cshift_t cshifts[NUM_CSHIFTS];
490 cshift_t prev_cshifts[NUM_CSHIFTS];
492 // the client maintains its own idea of view angles, which are
493 // sent to the server each frame. The server sets punchangle when
494 // the view is temporarily offset, and an angle reset commands at the start
495 // of each level and after teleporting.
497 // mviewangles is read from demo
498 // viewangles is either client controlled or lerped from mviewangles
499 vec3_t mviewangles[2], viewangles;
500 // update by server, used by qc to do weapon recoil
501 vec3_t mpunchangle[2], punchangle;
502 // update by server, can be used by mods to kick view around
503 vec3_t mpunchvector[2], punchvector;
504 // update by server, used for lean+bob (0 is newest)
505 vec3_t mvelocity[2], velocity;
506 // update by server, can be used by mods for zooming
507 vec_t mviewzoom[2], viewzoom;
509 // pitch drifting vars
516 // local amount for smoothing stepups
524 // don't change view angle, full screen, etc
526 // latched at intermission start
529 // the timestamp of the last two messages
532 // clients view of time, time should be between mtime[0] and mtime[1] to
533 // generate a lerp point for other data, oldtime is the previous frame's
534 // value of time, frametime is the difference between time and oldtime
535 double time, oldtime, frametime;
537 // copy of realtime from last recieved message, for net trouble icon
538 float last_received_message;
540 // information that is static for the entire time connected to a server
541 struct model_s *model_precache[MAX_MODELS];
542 struct sfx_s *sound_precache[MAX_SOUNDS];
544 // for display on solo scoreboard
546 // cl_entitites[cl.viewentity] = player
548 // the real player entity (normally same as viewentity,
549 // different than viewentity if mod uses chasecam or other tricks)
551 // max players that can be in this game
553 // type of game (deathmatch, coop, singleplayer)
556 // refresh related state
558 // cl_entitites[0].model
559 struct model_s *worldmodel;
565 int cdtrack, looptrack;
570 scoreboard_t *scores;
572 // protocol version of the server we're connected to
575 // entity database stuff
576 // latest received entity frame numbers
577 #define LATESTFRAMENUMS 3
578 int latestframenums[LATESTFRAMENUMS];
579 entityframe_database_t *entitydatabase;
580 entityframe4_database_t *entitydatabase4;
584 extern mempool_t *cl_scores_mempool;
589 extern cvar_t cl_name;
590 extern cvar_t cl_color;
591 extern cvar_t cl_rate;
592 extern cvar_t cl_pmodel;
593 extern cvar_t cl_playermodel;
594 extern cvar_t cl_playerskin;
596 extern cvar_t cl_upspeed;
597 extern cvar_t cl_forwardspeed;
598 extern cvar_t cl_backspeed;
599 extern cvar_t cl_sidespeed;
601 extern cvar_t cl_movespeedkey;
603 extern cvar_t cl_yawspeed;
604 extern cvar_t cl_pitchspeed;
606 extern cvar_t cl_anglespeedkey;
608 extern cvar_t cl_autofire;
610 extern cvar_t cl_shownet;
611 extern cvar_t cl_nolerp;
613 extern cvar_t cl_pitchdriftspeed;
614 extern cvar_t lookspring;
615 extern cvar_t lookstrafe;
616 extern cvar_t sensitivity;
618 extern cvar_t freelook;
620 extern cvar_t m_pitch;
622 extern cvar_t m_forward;
623 extern cvar_t m_side;
625 extern cvar_t r_draweffects;
627 extern cvar_t cl_explosions_alpha_start;
628 extern cvar_t cl_explosions_alpha_end;
629 extern cvar_t cl_explosions_size_start;
630 extern cvar_t cl_explosions_size_end;
631 extern cvar_t cl_explosions_lifetime;
632 extern cvar_t cl_stainmaps;
633 extern cvar_t cl_stainmaps_clearonload;
635 extern cvar_t cl_prydoncursor;
637 // these are updated by CL_ClearState
638 extern int cl_num_entities;
639 extern int cl_num_static_entities;
640 extern int cl_num_temp_entities;
641 extern int cl_num_brushmodel_entities;
643 extern mempool_t *cl_entities_mempool;
644 extern entity_t *cl_entities;
645 extern qbyte *cl_entities_active;
646 extern entity_t *cl_static_entities;
647 extern entity_t *cl_temp_entities;
648 extern entity_render_t **cl_brushmodel_entities;
649 extern cl_effect_t *cl_effects;
650 extern beam_t *cl_beams;
651 extern dlight_t *cl_dlights;
652 extern lightstyle_t *cl_lightstyle;
655 extern client_state_t cl;
657 extern void CL_AllocDlight (entity_render_t *ent, matrix4x4_t *matrix, float radius, float red, float green, float blue, float decay, float lifetime, int cubemapnum, int style, int shadowenable, vec_t corona, vec_t coronasizescale, vec_t ambientscale, vec_t diffusescale, vec_t specularscale, int flags);
658 extern void CL_DecayLights (void);
660 //=============================================================================
666 void CL_Shutdown (void);
669 void CL_EstablishConnection(const char *host);
671 void CL_Disconnect (void);
672 void CL_Disconnect_f (void);
674 void CL_BoundingBoxForEntity(entity_render_t *ent);
676 extern cvar_t cl_beams_polygons;
677 extern cvar_t cl_beams_relative;
678 extern cvar_t cl_beams_lightatend;
685 int down[2]; // key nums holding it down
686 int state; // low bit is down state
690 extern kbutton_t in_mlook, in_klook;
691 extern kbutton_t in_strafe;
692 extern kbutton_t in_speed;
694 void CL_InitInput (void);
695 void CL_SendCmd (void);
696 void CL_SendMove (void);
698 void CL_ValidateState(entity_state_t *s);
699 void CL_MoveLerpEntityStates(entity_t *ent);
700 void CL_LerpUpdate(entity_t *e);
701 void CL_ParseTEnt (void);
702 void CL_RelinkBeams (void);
704 void CL_ClearTempEntities (void);
705 entity_t *CL_NewTempEntity (void);
707 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
709 void CL_ClearState (void);
712 int CL_ReadFromServer (void);
713 void CL_WriteToServer (void);
714 void CL_BaseMove (void);
717 float CL_KeyState (kbutton_t *key);
718 const char *Key_KeynumToString (int keynum);
719 int Key_StringToKeynum (const char *str);
724 void CL_StopPlayback(void);
725 void CL_ReadDemoMessage(void);
726 void CL_WriteDemoMessage(void);
728 void CL_NextDemo(void);
729 void CL_Stop_f(void);
730 void CL_Record_f(void);
731 void CL_PlayDemo_f(void);
732 void CL_TimeDemo_f(void);
737 void CL_Parse_Init(void);
738 void CL_Parse_Shutdown(void);
739 void CL_ParseServerMessage(void);
740 void CL_Parse_DumpPacket(void);
745 void V_StartPitchDrift (void);
746 void V_StopPitchDrift (void);
749 float V_CalcRoll (vec3_t angles, vec3_t velocity);
750 void V_UpdateBlends (void);
751 void V_ParseDamage (void);
757 void CL_InitTEnts (void);
763 extern cvar_t cl_particles;
764 extern cvar_t cl_particles_quality;
765 extern cvar_t cl_particles_size;
766 extern cvar_t cl_particles_bloodshowers;
767 extern cvar_t cl_particles_blood;
768 extern cvar_t cl_particles_blood_alpha;
769 extern cvar_t cl_particles_blood_bloodhack;
770 extern cvar_t cl_particles_bulletimpacts;
771 extern cvar_t cl_particles_explosions_bubbles;
772 extern cvar_t cl_particles_explosions_smoke;
773 extern cvar_t cl_particles_explosions_sparks;
774 extern cvar_t cl_particles_explosions_shell;
775 extern cvar_t cl_particles_smoke;
776 extern cvar_t cl_particles_smoke_alpha;
777 extern cvar_t cl_particles_smoke_alphafade;
778 extern cvar_t cl_particles_sparks;
779 extern cvar_t cl_particles_bubbles;
780 extern cvar_t cl_decals;
781 extern cvar_t cl_decals_time;
782 extern cvar_t cl_decals_fadetime;
784 void CL_Particles_Clear(void);
785 void CL_Particles_Init(void);
786 void CL_Particles_Shutdown(void);
788 void CL_ParseParticleEffect (void);
789 void CL_RunParticleEffect (vec3_t org, vec3_t dir, int color, int count);
790 void CL_RocketTrail (vec3_t start, vec3_t end, int type, int color, entity_t *ent);
791 void CL_SparkShower (vec3_t org, vec3_t dir, int count, vec_t gravityscale);
792 void CL_Smoke (vec3_t org, vec3_t dir, int count);
793 void CL_BulletMark (vec3_t org);
794 void CL_PlasmaBurn (vec3_t org);
795 void CL_BloodPuff (vec3_t org, vec3_t vel, int count);
796 void CL_Stardust (vec3_t mins, vec3_t maxs, int count);
797 void CL_FlameCube (vec3_t mins, vec3_t maxs, int count);
798 void CL_Flames (vec3_t org, vec3_t vel, int count);
799 void CL_BloodShower (vec3_t mins, vec3_t maxs, float velspeed, int count);
800 void CL_ParticleCube (vec3_t mins, vec3_t maxs, vec3_t dir, int count, int colorbase, int gravity, int randomvel);
801 void CL_ParticleRain (vec3_t mins, vec3_t maxs, vec3_t dir, int count, int colorbase, int type);
802 void CL_EntityParticles (entity_t *ent);
803 void CL_BlobExplosion (vec3_t org);
804 void CL_ParticleExplosion (vec3_t org);
805 void CL_ParticleExplosion2 (vec3_t org, int colorStart, int colorLength);
806 void CL_LavaSplash (vec3_t org);
807 void CL_TeleportSplash (vec3_t org);
808 void CL_BeamParticle (const vec3_t start, const vec3_t end, vec_t radius, float red, float green, float blue, float alpha, float lifetime);
809 void CL_Tei_Smoke(const vec3_t pos, const vec3_t dir, int count);
810 void CL_Tei_PlasmaHit(const vec3_t pos, const vec3_t dir, int count);
811 void CL_MoveParticles(void);
812 void R_MoveExplosions(void);
813 void R_NewExplosion(vec3_t org);
815 #include "cl_screen.h"
820 int x, y, width, height;
823 // these are set for water warping before
824 // fov_x/fov_y are calculated
825 float fovscale_x, fovscale_y;
828 matrix4x4_t viewentitymatrix;
830 // which color components to allow (for anaglyph glasses)
833 // fullscreen color blend
836 // whether to call S_ExtraUpdate during render to reduce sound chop
837 qboolean extraupdate;
839 // client gameworld time for rendering time based effects
843 entity_render_t *worldentity;
845 // same as worldentity->model
848 // renderable entities (excluding world)
849 entity_render_t **entities;
853 // 2D art drawing queue
854 // TODO: get rid of this
857 int maxdrawqueuesize;
863 extern mempool_t *cl_refdef_mempool;