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 // typically 1 1 1, can be lower (dim) or higher (overbright)
88 // size of the light (remove?)
92 // light style to monitor for brightness
94 // whether light should render shadows
96 // intensity of corona to render
98 // radius scale of corona to render (1.0 means same as light radius)
99 vec_t coronasizescale;
100 // ambient intensity to render
102 // diffuse intensity to render
104 // specular intensity to render
109 // generated properties
110 // used only for shadow volumes
117 // squared cullradius
120 // lightmap renderer stuff (remove someday!)
121 // the size of the light
122 vec_t lightmap_cullradius;
123 // the size of the light, squared
124 vec_t lightmap_cullradius2;
125 // the brightness of the light
126 vec3_t lightmap_light;
127 // to avoid sudden brightness change at cullradius, subtract this
128 vec_t lightmap_subtract;
131 // true if this light should be compiled as a static light
133 // true if this is a compiled world light, cleared if the light changes
135 // premade shadow volumes to render for world entity
136 shadowmesh_t *static_meshchain_shadow;
137 // used for visibility testing (more exact than bbox)
139 int static_numleafpvsbytes;
140 int *static_leaflist;
141 qbyte *static_leafpvs;
142 // surfaces seen by light
143 int static_numsurfaces;
144 int *static_surfacelist;
148 typedef struct dlight_s
150 // destroy light after this time
153 // the entity that owns this light (can be NULL)
155 struct entity_render_s *ent;
157 // (worldlight: saved to .rtlights file)
159 // worldlight orientation
161 // (worldlight: saved to .rtlights file)
163 // dlight orientation/scaling/location
167 // (worldlight: saved to .rtlights file)
169 // cubemap number to use on this light
172 // cubemap name to use on this light
174 // (worldlight: saved to .rtlights file)
175 char cubemapname[64];
176 // make light flash while selected
179 // brightness (not really radius anymore)
180 // (worldlight: saved to .rtlights file)
182 // drop radius this much each second
185 // light style which controls intensity of this light
186 // (worldlight: saved to .rtlights file)
189 // (worldlight: saved to .rtlights file)
192 // (worldlight: saved to .rtlights file)
194 // radius scale of corona to render (1.0 means same as light radius)
195 // (worldlight: saved to .rtlights file)
196 vec_t coronasizescale;
197 // ambient intensity to render
198 // (worldlight: saved to .rtlights file)
200 // diffuse intensity to render
201 // (worldlight: saved to .rtlights file)
203 // specular intensity to render
204 // (worldlight: saved to .rtlights file)
207 // (worldlight: saved to .rtlights file)
209 // linked list of world lights
211 struct dlight_s *next;
212 // embedded rtlight struct for renderer
218 typedef struct frameblend_s
225 // LordHavoc: this struct is intended for the renderer but some fields are
226 // used by the client.
227 typedef struct entity_render_s
233 // transform matrix for model to world
235 // transform matrix for world to model
236 matrix4x4_t inversematrix;
237 // opacity (alpha) of the model
239 // size the model is shown
244 // current uninterpolated animation frame (for things which do not use interpolation)
246 // entity shirt and pants colors (-1 if not colormapped)
248 // literal colors for renderer
249 vec3_t colormap_pantscolor;
250 vec3_t colormap_shirtcolor;
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;
362 char map[MAX_STYLESTRING];
367 char name[MAX_SCOREBOARDNAME];
369 int colors; // two 4 bit fields
375 int percent; // 0-256
378 #define CSHIFT_CONTENTS 0
379 #define CSHIFT_DAMAGE 1
380 #define CSHIFT_BONUS 2
381 #define CSHIFT_POWERUP 3
382 #define CSHIFT_VCSHIFT 4
383 #define NUM_CSHIFTS 5
385 #define NAME_LENGTH 64
389 // client_state_t should hold all pieces of the client state
392 #define SIGNONS 4 // signon messages to receive before connected
395 #define MAX_DEMONAME 16
399 ca_dedicated, // a dedicated server with no ability to start a client
400 ca_disconnected, // full screen console with no connection
401 ca_connected // valid netcon, talking to a server
406 // the client_static_t structure is persistent through an arbitrary number
407 // of server connections
414 // -1 = don't play demos
416 // list of demos in loop
417 char demos[MAX_DEMOS][MAX_DEMONAME];
418 // the actively playing demo (set by CL_PlayDemo_f)
421 // demo recording info must be here, because record is started before
422 // entering a map (and clearing client_state_t)
423 qboolean demorecording;
424 qboolean demoplayback;
426 // -1 = use normal cd track
429 // to meter out one message a frame
431 // host_framecount at start
433 // realtime at second frame of timedemo (LordHavoc: changed to double)
435 // LordHavoc: for measuring maxfps
436 double td_minframetime;
437 // LordHavoc: for measuring minfps
438 double td_maxframetime;
439 // LordHavoc: pausedemo
442 qboolean connect_trying;
443 int connect_remainingtries;
444 double connect_nextsendtime;
445 lhnetsocket_t *connect_mysocket;
446 lhnetaddress_t connect_address;
448 // connection information
451 // network connection
453 // writing buffer to send to server
455 qbyte message_buf[1024];
459 extern client_static_t cls;
461 typedef struct client_movementqueue_s
471 client_movementqueue_t;
474 // the client_state_t structure is wiped completely at every
479 // true if playing in a local game and no one else is connected
482 // when connecting to the server throw out the first couple move messages
483 // so the player doesn't accidentally do something the first frame
486 // send a clc_nop periodically until connected
489 // current input to send to the server
492 // information for local display
494 int stats[MAX_CL_STATS];
495 // last known inventory bit flags, for blinking
497 // cl.time of acquiring item, for blinking
498 float item_gettime[32];
499 // last known STAT_ACTIVEWEAPON
501 // cl.time of changing STAT_ACTIVEWEAPON
503 // use pain anim frame if cl.time < this
506 // color shifts for damage, powerups
507 cshift_t cshifts[NUM_CSHIFTS];
509 cshift_t prev_cshifts[NUM_CSHIFTS];
511 // the client maintains its own idea of view angles, which are
512 // sent to the server each frame. The server sets punchangle when
513 // the view is temporarily offset, and an angle reset commands at the start
514 // of each level and after teleporting.
516 // mviewangles is read from demo
517 // viewangles is either client controlled or lerped from mviewangles
518 vec3_t mviewangles[2], viewangles;
519 // update by server, used by qc to do weapon recoil
520 vec3_t mpunchangle[2], punchangle;
521 // update by server, can be used by mods to kick view around
522 vec3_t mpunchvector[2], punchvector;
523 // update by server, used for lean+bob (0 is newest)
524 vec3_t mvelocity[2], velocity;
525 // update by server, can be used by mods for zooming
526 vec_t mviewzoom[2], viewzoom;
528 // client movement simulation
529 // these fields are only updated by CL_ClientMovement (called by CL_SendMove after parsing each network packet)
531 // indicates the queue has been updated and should be replayed
532 qboolean movement_replay;
533 // simulated data (this is valid even if cl.movement is false)
534 vec3_t movement_origin;
535 vec3_t movement_oldorigin;
536 vec3_t movement_velocity;
537 // queue of proposed moves
538 int movement_numqueue;
539 client_movementqueue_t movement_queue[64];
541 int servermovesequence;
543 // pitch drifting vars
550 // local amount for smoothing stepups
559 qboolean oldonground;
560 double lastongroundtime;
561 double hitgroundtime;
563 // don't change view angle, full screen, etc
565 // latched at intermission start
568 // the timestamp of the last two messages
571 // clients view of time, time should be between mtime[0] and mtime[1] to
572 // generate a lerp point for other data, oldtime is the previous frame's
573 // value of time, frametime is the difference between time and oldtime
574 double time, oldtime, frametime;
576 // copy of realtime from last recieved message, for net trouble icon
577 float last_received_message;
579 // information that is static for the entire time connected to a server
580 struct model_s *model_precache[MAX_MODELS];
581 struct sfx_s *sound_precache[MAX_SOUNDS];
583 // for display on solo scoreboard
585 // cl_entitites[cl.viewentity] = player
587 // the real player entity (normally same as viewentity,
588 // different than viewentity if mod uses chasecam or other tricks)
590 // max players that can be in this game
592 // type of game (deathmatch, coop, singleplayer)
595 // models and sounds used by engine code (particularly cl_parse.c)
597 model_t *model_bolt2;
598 model_t *model_bolt3;
601 sfx_t *sfx_knighthit;
608 // refresh related state
610 // cl_entitites[0].model
611 struct model_s *worldmodel;
617 int cdtrack, looptrack;
622 scoreboard_t *scores;
624 // protocol version of the server we're connected to
625 protocolversion_t protocol;
627 // entity database stuff
628 // latest received entity frame numbers
629 #define LATESTFRAMENUMS 3
630 int latestframenums[LATESTFRAMENUMS];
631 entityframe_database_t *entitydatabase;
632 entityframe4_database_t *entitydatabase4;
639 extern cvar_t cl_name;
640 extern cvar_t cl_color;
641 extern cvar_t cl_rate;
642 extern cvar_t cl_pmodel;
643 extern cvar_t cl_playermodel;
644 extern cvar_t cl_playerskin;
646 extern cvar_t cl_upspeed;
647 extern cvar_t cl_forwardspeed;
648 extern cvar_t cl_backspeed;
649 extern cvar_t cl_sidespeed;
651 extern cvar_t cl_movespeedkey;
653 extern cvar_t cl_yawspeed;
654 extern cvar_t cl_pitchspeed;
656 extern cvar_t cl_anglespeedkey;
658 extern cvar_t cl_autofire;
660 extern cvar_t cl_shownet;
661 extern cvar_t cl_nolerp;
663 extern cvar_t cl_pitchdriftspeed;
664 extern cvar_t lookspring;
665 extern cvar_t lookstrafe;
666 extern cvar_t sensitivity;
668 extern cvar_t freelook;
670 extern cvar_t m_pitch;
672 extern cvar_t m_forward;
673 extern cvar_t m_side;
675 extern cvar_t r_draweffects;
677 extern cvar_t cl_explosions_alpha_start;
678 extern cvar_t cl_explosions_alpha_end;
679 extern cvar_t cl_explosions_size_start;
680 extern cvar_t cl_explosions_size_end;
681 extern cvar_t cl_explosions_lifetime;
682 extern cvar_t cl_stainmaps;
683 extern cvar_t cl_stainmaps_clearonload;
685 extern cvar_t cl_prydoncursor;
687 extern vec3_t cl_playerstandmins;
688 extern vec3_t cl_playerstandmaxs;
689 extern vec3_t cl_playercrouchmins;
690 extern vec3_t cl_playercrouchmaxs;
692 // these are updated by CL_ClearState
693 extern int cl_num_entities;
694 extern int cl_num_static_entities;
695 extern int cl_num_temp_entities;
696 extern int cl_num_brushmodel_entities;
698 extern mempool_t *cl_mempool;
699 extern entity_t *cl_entities;
700 extern qbyte *cl_entities_active;
701 extern entity_t *cl_static_entities;
702 extern entity_t *cl_temp_entities;
703 extern int *cl_brushmodel_entities;
704 extern cl_effect_t *cl_effects;
705 extern beam_t *cl_beams;
706 extern dlight_t *cl_dlights;
707 extern lightstyle_t *cl_lightstyle;
710 extern client_state_t cl;
712 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);
713 extern void CL_DecayLights (void);
715 //=============================================================================
721 void CL_Shutdown (void);
724 void CL_EstablishConnection(const char *host);
726 void CL_Disconnect (void);
727 void CL_Disconnect_f (void);
729 void CL_BoundingBoxForEntity(entity_render_t *ent);
731 extern cvar_t cl_beams_polygons;
732 extern cvar_t cl_beams_relative;
733 extern cvar_t cl_beams_lightatend;
740 int down[2]; // key nums holding it down
741 int state; // low bit is down state
745 extern kbutton_t in_mlook, in_klook;
746 extern kbutton_t in_strafe;
747 extern kbutton_t in_speed;
749 void CL_InitInput (void);
750 void CL_SendCmd (void);
751 void CL_SendMove (void);
753 void CL_ValidateState(entity_state_t *s);
754 void CL_MoveLerpEntityStates(entity_t *ent);
755 void CL_LerpUpdate(entity_t *e);
756 void CL_ParseTEnt (void);
757 void CL_RelinkBeams (void);
759 void CL_ClearTempEntities (void);
760 entity_t *CL_NewTempEntity (void);
762 void CL_Effect(vec3_t org, int modelindex, int startframe, int framecount, float framerate);
764 void CL_ClearState (void);
765 void CL_ExpandEntities(int num);
768 int CL_ReadFromServer (void);
769 void CL_WriteToServer (void);
771 extern qboolean cl_ignoremousemove;
774 float CL_KeyState (kbutton_t *key);
775 const char *Key_KeynumToString (int keynum);
776 int Key_StringToKeynum (const char *str);
781 void CL_StopPlayback(void);
782 void CL_ReadDemoMessage(void);
783 void CL_WriteDemoMessage(void);
785 void CL_NextDemo(void);
786 void CL_Stop_f(void);
787 void CL_Record_f(void);
788 void CL_PlayDemo_f(void);
789 void CL_TimeDemo_f(void);
794 void CL_Parse_Init(void);
795 void CL_Parse_Shutdown(void);
796 void CL_ParseServerMessage(void);
797 void CL_Parse_DumpPacket(void);
802 void V_StartPitchDrift (void);
803 void V_StopPitchDrift (void);
806 float V_CalcRoll (vec3_t angles, vec3_t velocity);
807 void V_UpdateBlends (void);
808 void V_ParseDamage (void);
814 extern cvar_t cl_particles;
815 extern cvar_t cl_particles_quality;
816 extern cvar_t cl_particles_size;
817 extern cvar_t cl_particles_bloodshowers;
818 extern cvar_t cl_particles_blood;
819 extern cvar_t cl_particles_blood_alpha;
820 extern cvar_t cl_particles_blood_bloodhack;
821 extern cvar_t cl_particles_bulletimpacts;
822 extern cvar_t cl_particles_explosions_bubbles;
823 extern cvar_t cl_particles_explosions_smoke;
824 extern cvar_t cl_particles_explosions_sparks;
825 extern cvar_t cl_particles_explosions_shell;
826 extern cvar_t cl_particles_smoke;
827 extern cvar_t cl_particles_smoke_alpha;
828 extern cvar_t cl_particles_smoke_alphafade;
829 extern cvar_t cl_particles_sparks;
830 extern cvar_t cl_particles_bubbles;
831 extern cvar_t cl_decals;
832 extern cvar_t cl_decals_time;
833 extern cvar_t cl_decals_fadetime;
835 void CL_Particles_Clear(void);
836 void CL_Particles_Init(void);
837 void CL_Particles_Shutdown(void);
839 void CL_ParseParticleEffect (void);
840 void CL_RunParticleEffect (vec3_t org, vec3_t dir, int color, int count);
841 void CL_RocketTrail (vec3_t start, vec3_t end, int type, int color, entity_t *ent);
842 void CL_SparkShower (vec3_t org, vec3_t dir, int count, vec_t gravityscale);
843 void CL_Smoke (vec3_t org, vec3_t dir, int count);
844 void CL_BulletMark (vec3_t org);
845 void CL_PlasmaBurn (vec3_t org);
846 void CL_BloodPuff (vec3_t org, vec3_t vel, int count);
847 void CL_Stardust (vec3_t mins, vec3_t maxs, int count);
848 void CL_FlameCube (vec3_t mins, vec3_t maxs, int count);
849 void CL_Flames (vec3_t org, vec3_t vel, int count);
850 void CL_BloodShower (vec3_t mins, vec3_t maxs, float velspeed, int count);
851 void CL_ParticleCube (vec3_t mins, vec3_t maxs, vec3_t dir, int count, int colorbase, int gravity, int randomvel);
852 void CL_ParticleRain (vec3_t mins, vec3_t maxs, vec3_t dir, int count, int colorbase, int type);
853 void CL_EntityParticles (entity_t *ent);
854 void CL_BlobExplosion (vec3_t org);
855 void CL_ParticleExplosion (vec3_t org);
856 void CL_ParticleExplosion2 (vec3_t org, int colorStart, int colorLength);
857 void CL_LavaSplash (vec3_t org);
858 void CL_TeleportSplash (vec3_t org);
859 void CL_BeamParticle (const vec3_t start, const vec3_t end, vec_t radius, float red, float green, float blue, float alpha, float lifetime);
860 void CL_Tei_Smoke(const vec3_t pos, const vec3_t dir, int count);
861 void CL_Tei_PlasmaHit(const vec3_t pos, const vec3_t dir, int count);
862 void CL_MoveParticles(void);
863 void R_MoveExplosions(void);
864 void R_NewExplosion(vec3_t org);
866 #include "cl_screen.h"
871 int x, y, width, height;
874 // these are set for water warping before
875 // fov_x/fov_y are calculated
876 float fovscale_x, fovscale_y;
879 matrix4x4_t viewentitymatrix;
881 // which color components to allow (for anaglyph glasses)
884 // fullscreen color blend
887 // whether to call S_ExtraUpdate during render to reduce sound chop
888 qboolean extraupdate;
890 // client gameworld time for rendering time based effects
894 entity_render_t *worldentity;
896 // same as worldentity->model
899 // renderable entities (excluding world)
900 entity_render_t **entities;
904 // 2D art drawing queue
905 // TODO: get rid of this
908 int maxdrawqueuesize;