Merge branch 'divVerent/simpler-clipped-rectangle' into 'master'
[xonotic/xonotic-data.pk3dir.git] / qcsrc / client / miscfunctions.qc
1 #include "miscfunctions.qh"
2
3 #include "autocvars.qh"
4 #include "defs.qh"
5 #include "hud/_mod.qh"
6
7 #include <common/command/_mod.qh>
8
9 #include <common/teams.qh>
10
11 #include <lib/csqcmodel/cl_model.qh>
12
13
14 void AuditLists()
15 {
16         entity e;
17         entity prev;
18
19         prev = players;
20         for(e = prev.sort_next; e; prev = e, e = e.sort_next)
21         {
22                 if(prev != e.sort_prev)
23                         error(strcat("sort list chain error\nplease submit the output of 'prvm_edicts client' to the developers"));
24         }
25
26         prev = teams;
27         for(e = prev.sort_next; e; prev = e, e = e.sort_next)
28         {
29                 if(prev != e.sort_prev)
30                         error(strcat("sort list chain error\nplease submit the output of 'prvm_edicts client' to the developers"));
31         }
32 }
33
34
35 float RegisterPlayer(entity player)
36 {
37         entity pl;
38         AuditLists();
39         for(pl = players.sort_next; pl; pl = pl.sort_next)
40                 if(pl == player)
41                         error("Player already registered!");
42         player.sort_next = players.sort_next;
43         player.sort_prev = players;
44         if(players.sort_next)
45                 players.sort_next.sort_prev = player;
46         players.sort_next = player;
47         AuditLists();
48         return true;
49 }
50
51 void RemovePlayer(entity player)
52 {
53         entity pl, parent;
54         AuditLists();
55         parent = players;
56         for(pl = players.sort_next; pl && pl != player; pl = pl.sort_next)
57                 parent = pl;
58
59         if(!pl)
60         {
61                 error("Trying to remove a player which is not in the playerlist!");
62                 return;
63         }
64         parent.sort_next = player.sort_next;
65         if(player.sort_next)
66                 player.sort_next.sort_prev = parent;
67         AuditLists();
68 }
69
70 void MoveToLast(entity e)
71 {
72         AuditLists();
73         entity ent = e.sort_next;
74         while(ent)
75         {
76                 SORT_SWAP(ent, e);
77                 ent = e.sort_next;
78         }
79         AuditLists();
80 }
81
82 float RegisterTeam(entity Team)
83 {
84         assert_once(Team.team, eprint(Team));
85         entity tm;
86         AuditLists();
87         for(tm = teams.sort_next; tm; tm = tm.sort_next)
88                 if(tm == Team)
89                         error("Team already registered!");
90         Team.sort_next = teams.sort_next;
91         Team.sort_prev = teams;
92         if(teams.sort_next)
93                 teams.sort_next.sort_prev = Team;
94         teams.sort_next = Team;
95         if(Team.team && Team.team != NUM_SPECTATOR)
96                 ++team_count;
97         AuditLists();
98         return true;
99 }
100
101 void RemoveTeam(entity Team)
102 {
103         entity tm, parent;
104         AuditLists();
105         parent = teams;
106         for(tm = teams.sort_next; tm && tm != Team; tm = tm.sort_next)
107                 parent = tm;
108
109         if(!tm)
110         {
111                 LOG_INFO(_("Trying to remove a team which is not in the teamlist!"));
112                 return;
113         }
114         parent.sort_next = Team.sort_next;
115         if(Team.sort_next)
116                 Team.sort_next.sort_prev = parent;
117         if(Team.team && Team.team != NUM_SPECTATOR)
118                 --team_count;
119         AuditLists();
120 }
121
122 entity GetTeam(int Team, bool add)
123 {
124         TC(int, Team); TC(bool, add);
125         int num = (Team == NUM_SPECTATOR) ? 16 : Team;
126         if(teamslots[num])
127                 return teamslots[num];
128         if (!add)
129                 return NULL;
130         entity tm = new_pure(team);
131         tm.team = Team;
132         teamslots[num] = tm;
133         RegisterTeam(tm);
134         return tm;
135 }
136
137 vector HUD_GetFontsize(string cvarname)
138 {
139         vector v;
140         v = stov(cvar_string(cvarname));
141         if(v.x == 0)
142                 v = '8 8 0';
143         if(v.y == 0)
144                 v.y = v.x;
145         v.z = 0;
146         return v;
147 }
148
149 float PreviewExists(string name)
150 {
151         if(autocvar_cl_readpicture_force)
152                 return false;
153
154         if (fexists(strcat(name, ".tga"))) return true;
155         if (fexists(strcat(name, ".png"))) return true;
156         if (fexists(strcat(name, ".jpg"))) return true;
157         if (fexists(strcat(name, ".pcx"))) return true;
158
159         return false;
160 }
161
162 // decolorizes and team colors the player name when needed
163 string playername(string thename, float teamid)
164 {
165     TC(int, teamid);
166     string t;
167     if (teamplay)
168     {
169         t = Team_ColorCode(teamid);
170         return strcat(t, strdecolorize(thename));
171     }
172     else
173         return strdecolorize(thename);
174 }
175
176 float cvar_or(string cv, float v)
177 {
178         string s;
179         s = cvar_string(cv);
180         if(s == "")
181                 return v;
182         else
183                 return stof(s);
184 }
185
186 vector project_3d_to_2d(vector vec)
187 {
188         vec = cs_project(vec);
189         if(cs_project_is_b0rked > 0)
190         {
191                 vec.x *= vid_conwidth / vid_width;
192                 vec.y *= vid_conheight / vid_height;
193         }
194         return vec;
195 }
196
197 bool projected_on_screen(vector screen_pos)
198 {
199         return screen_pos.z >= 0
200                 && screen_pos.x >= 0
201                 && screen_pos.y >= 0
202                 && screen_pos.x < vid_conwidth
203                 && screen_pos.y < vid_conheight;
204 }
205
206 float expandingbox_sizefactor_from_fadelerp(float fadelerp)
207 {
208         return 1.2 / (1.2 - fadelerp);
209 }
210
211 vector expandingbox_resize_centered_box_offset(float sz, vector boxsize, float boxxsizefactor)
212 {
213         boxsize.x *= boxxsizefactor; // easier interface for text
214         return boxsize * (0.5 * (1 - sz));
215 }
216
217 // NOTE base is the central value
218 // freq: circle frequency, = 2*pi*frequency in hertz
219 // start_pos:
220 //  -1 start from the lower value
221 //   0 start from the base value
222 //   1 start from the higher value
223 float blink_synced(float base, float range, float freq, float start_time, int start_pos)
224 {
225         // note:
226         //   RMS = sqrt(base^2 + 0.5 * range^2)
227         // thus
228         //   base = sqrt(RMS^2 - 0.5 * range^2)
229         // ensure RMS == 1
230
231         return base + range * sin((time - start_time - (M_PI / 2) * start_pos) * freq);
232 }
233
234 float blink(float base, float range, float freq)
235 {
236         return blink_synced(base, range, freq, 0, 0);
237 }
238
239 void drawborderlines(float thickness, vector pos, vector dim, vector color, float theAlpha, float drawflag)
240 {
241         vector line_dim = '0 0 0';
242
243         // left and right lines
244         pos.x -= thickness;
245         line_dim.x = thickness;
246         line_dim.y = dim.y;
247         drawfill(pos, line_dim, color, theAlpha, drawflag);
248         drawfill(pos + (dim.x + thickness) * '1 0 0', line_dim, color, theAlpha, drawflag);
249
250         // upper and lower lines
251         pos.y -= thickness;
252         line_dim.x = dim.x + thickness * 2; // make upper and lower lines longer
253         line_dim.y = thickness;
254         drawfill(pos, line_dim, color, theAlpha, drawflag);
255         drawfill(pos + (dim.y + thickness) * '0 1 0', line_dim, color, theAlpha, drawflag);
256 }
257
258 void drawpic_tiled(vector pos, string pic, vector sz, vector area, vector color, float theAlpha, float drawflag)
259 {
260         pos = HUD_Shift(pos);
261         sz = HUD_Scale(sz);
262         area = HUD_Scale(area);
263
264         vector current_pos = '0 0 0', end_pos, new_size = '0 0 0', ratio = '0 0 0';
265         end_pos = pos + area;
266
267         current_pos.y = pos.y;
268         while (current_pos.y < end_pos.y)
269         {
270                 current_pos.x = pos.x;
271                 while (current_pos.x < end_pos.x)
272                 {
273                         new_size.x = min(sz.x, end_pos.x - current_pos.x);
274                         new_size.y = min(sz.y, end_pos.y - current_pos.y);
275                         ratio.x = new_size.x / sz.x;
276                         ratio.y = new_size.y / sz.y;
277                         drawsubpic(current_pos, new_size, pic, '0 0 0', ratio, color, theAlpha, drawflag);
278                         current_pos.x += sz.x;
279                 }
280                 current_pos.y += sz.y;
281         }
282 }
283
284 void drawpic_aspect_skin_expanding(vector position, string pic, vector theScale, vector rgb, float theAlpha, float flag, float fadelerp)
285 {
286         float sz;
287         sz = expandingbox_sizefactor_from_fadelerp(fadelerp);
288
289         drawpic_aspect_skin(position + expandingbox_resize_centered_box_offset(sz, theScale, 1), pic, theScale * sz, rgb, theAlpha * (1 - fadelerp), flag);
290 }
291
292 void drawpic_aspect_skin_expanding_two(vector position, string pic, vector theScale, vector rgb, float theAlpha, float flag, float fadelerp)
293 {
294         drawpic_aspect_skin_expanding(position, pic, theScale, rgb, theAlpha, flag, fadelerp);
295         drawpic_skin(position, pic, theScale, rgb, theAlpha * fadelerp, flag);
296 }
297
298 void HUD_Scale_Disable()
299 {
300         hud_scale = '1 1 0';
301         hud_shift = '0 0 0';
302         drawfontscale = hud_scale;
303 }
304
305 void HUD_Scale_Enable()
306 {
307         hud_scale = hud_scale_current;
308         hud_shift = hud_shift_current;
309         drawfontscale = hud_scale;
310 }
311
312 vector HUD_Scale(vector v)
313 {
314         v.x = HUD_ScaleX(v.x);
315         v.y = HUD_ScaleY(v.y);
316         return v;
317 }
318
319 vector HUD_Shift(vector v)
320 {
321         v.x = HUD_ShiftX(v.x);
322         v.y = HUD_ShiftY(v.y);
323         return v;
324 }
325
326 float stringwidth(string text, float handleColors, vector sz)
327 {
328         vector dfs = drawfontscale;
329         drawfontscale = '1 1 0';
330         float r = stringwidth_builtin(text, handleColors, sz);
331         drawfontscale = dfs;
332         return r;
333 }
334
335 // drawstring wrapper to draw a string as large as possible with preserved aspect ratio into a box
336 void drawstring_aspect(vector pos, string text, vector sz, vector color, float theAlpha, float drawflag) {
337         SET_POS_AND_SZ_Y_ASPECT(false);
338         drawstring(pos, text, '1 1 0' * sz.y, color, theAlpha, drawflag);
339 }
340
341 // drawstring wrapper to draw a colorcodedstring as large as possible with preserved aspect ratio into a box
342 void drawcolorcodedstring_aspect(vector pos, string text, vector sz, float theAlpha, float drawflag) {
343         SET_POS_AND_SZ_Y_ASPECT(true);
344         drawcolorcodedstring(pos, text, '1 1 0' * sz.y, theAlpha, drawflag);
345 }
346
347 void drawstring_expanding(vector position, string text, vector theScale, vector rgb, float theAlpha, float flag, float fadelerp)
348 {
349         float sz;
350         sz = expandingbox_sizefactor_from_fadelerp(fadelerp);
351
352         drawfontscale = hud_scale * sz;
353         vector dfs = drawfontscale;
354         drawfontscale = sz * '1 1 0';
355         float textaspect = stringwidth_builtin(text, false, theScale * (sz / drawfontscale.x)) / (theScale.x * sz);
356         drawfontscale = dfs;
357         drawstring(position + expandingbox_resize_centered_box_offset(sz, theScale, textaspect), text, HUD_Scale(theScale * (sz / drawfontscale.x)), rgb, theAlpha * (1 - fadelerp), flag);
358         // width parameter:
359         //    (scale_x * sz / drawfontscale.x) * drawfontscale.x * SIZE1 / (scale_x * sz)
360         //    SIZE1
361         drawfontscale = hud_scale;
362 }
363
364 // drawstring wrapper to draw a string as large as possible with preserved aspect ratio into a box
365 void drawstring_aspect_expanding(vector pos, string text, vector sz, vector color, float theAlpha, float drawflag, float fadelerp) {
366         SET_POS_AND_SZ_Y_ASPECT(false);
367         drawstring_expanding(pos, text, '1 1 0' * sz.y, color, theAlpha, drawflag, fadelerp);
368 }
369
370 void drawcolorcodedstring_expanding(vector position, string text, vector theScale, float theAlpha, float flag, float fadelerp)
371 {
372         float sz;
373         sz = expandingbox_sizefactor_from_fadelerp(fadelerp);
374
375         drawfontscale = hud_scale * sz;
376         // eventually replace with drawcolorcodedstring
377         drawcolorcodedstring(position + expandingbox_resize_centered_box_offset(sz, theScale, stringwidth_builtin(text, true, theScale * (sz / drawfontscale.x)) / (theScale.x * sz)), text, theScale * (sz / drawfontscale.x), theAlpha * (1 - fadelerp), flag);
378         drawfontscale = hud_scale;
379 }
380
381 void drawcolorcodedstring_aspect_expanding(vector pos, string text, vector sz, float theAlpha, float drawflag, float fadelerp) {
382         SET_POS_AND_SZ_Y_ASPECT(true);
383         drawcolorcodedstring_expanding(pos, text, '1 1 0' * sz.y, theAlpha, drawflag, fadelerp);
384 }
385
386 void update_mousepos()
387 {
388         mousepos += getmousepos() * autocvar_menu_mouse_speed;
389         mousepos.x = bound(0, mousepos.x, vid_conwidth);
390         mousepos.y = bound(0, mousepos.y, vid_conheight);
391 }
392
393 // this draws the triangles of a model DIRECTLY. Don't expect high performance, really...
394 float PolyDrawModelSurface(entity e, float i_s)
395 {
396         float i_t;
397         float n_t;
398         vector tri;
399         string tex;
400         tex = getsurfacetexture(e, i_s);
401         if (!tex)
402                 return 0; // this is beyond the last one
403         n_t = getsurfacenumtriangles(e, i_s);
404         for(i_t = 0; i_t < n_t; ++i_t)
405         {
406                 tri = getsurfacetriangle(e, i_s, i_t);
407                 R_BeginPolygon(tex, 0, false);
408                 R_PolygonVertex(getsurfacepoint(e, i_s, tri.x), getsurfacepointattribute(e, i_s, tri.x, SPA_TEXCOORDS0), '1 1 1', 1);
409                 R_PolygonVertex(getsurfacepoint(e, i_s, tri.y), getsurfacepointattribute(e, i_s, tri.y, SPA_TEXCOORDS0), '1 1 1', 1);
410                 R_PolygonVertex(getsurfacepoint(e, i_s, tri.z), getsurfacepointattribute(e, i_s, tri.z, SPA_TEXCOORDS0), '1 1 1', 1);
411                 R_EndPolygon();
412         }
413         return 1;
414 }
415 void PolyDrawModel(entity e)
416 {
417         float i_s;
418         for(i_s = 0; ; ++i_s)
419                 if(!PolyDrawModelSurface(e, i_s))
420                         break;
421 }
422
423 void DrawCircleClippedPic(vector centre, float radi, string pic, float f, vector rgb, float a, float drawflag)
424 {
425         vector ringsize, v, t;
426         ringsize = radi * '1 1 0';
427         centre = HUD_Shift(centre);
428         ringsize = HUD_Scale(ringsize);
429
430         float co = cos(f * 2 * M_PI);
431         float si = sin(f * 2 * M_PI);
432         float q = fabs(co) + fabs(si);
433         co /= q;
434         si /= q;
435
436         if(f >= 1)
437         {
438                 // draw full rectangle
439                 R_BeginPolygon(pic, drawflag, true);
440                         v = centre;                     t = '0.5 0.5 0';
441                         v.x += 0.5 * ringsize.x;        t += '0.5 0.5 0';
442                         R_PolygonVertex(v, t, rgb, a);
443
444                         v = centre;                     t = '0.5 0.5 0';
445                         v.y += 0.5 * ringsize.y;        t += '0.5 -0.5 0';
446                         R_PolygonVertex(v, t, rgb, a);
447
448                         v = centre;                     t = '0.5 0.5 0';
449                         v.x -= 0.5 * ringsize.x;        t -= '0.5 0.5 0';
450                         R_PolygonVertex(v, t, rgb, a);
451
452                         v = centre;                     t = '0.5 0.5 0';
453                         v.y -= 0.5 * ringsize.y;        t -= '0.5 -0.5 0';
454                         R_PolygonVertex(v, t, rgb, a);
455                 R_EndPolygon();
456                 return;  // Complete rectangle, nothing more needed.
457         }
458         else if(f > 0.75)
459         {
460                 // draw upper half in full
461                 R_BeginPolygon(pic, drawflag, true);
462                         v = centre;                     t = '0.5 0.5 0';
463                         v.x += 0.5 * ringsize.x;        t += '0.5 0.5 0';
464                         R_PolygonVertex(v, t, rgb, a);
465
466                         v = centre;                     t = '0.5 0.5 0';
467                         v.y += 0.5 * ringsize.y;        t += '0.5 -0.5 0';
468                         R_PolygonVertex(v, t, rgb, a);
469
470                         v = centre;                     t = '0.5 0.5 0';
471                         v.x -= 0.5 * ringsize.x;        t -= '0.5 0.5 0';
472                         R_PolygonVertex(v, t, rgb, a);
473                 R_EndPolygon();
474                 // draw clipped lower half as a quad
475                 R_BeginPolygon(pic, drawflag, true);
476                         v = centre;                     t = '0.5 0.5 0';
477                         R_PolygonVertex(v, t, rgb, a);
478
479                         v = centre;                     t = '0.5 0.5 0';
480                         v.x -= 0.5 * ringsize.x;        t -= '0.5 0.5 0';
481                         R_PolygonVertex(v, t, rgb, a);
482
483                         v = centre;                     t = '0.5 0.5 0';
484                         v.y -= 0.5 * ringsize.y;        t -= '0.5 -0.5 0';
485                         R_PolygonVertex(v, t, rgb, a);
486         }
487         else if(f > 0.5)
488         {
489                 // draw upper half in full
490                 R_BeginPolygon(pic, drawflag, true);
491                         v = centre;                     t = '0.5 0.5 0';
492                         v.x += 0.5 * ringsize.x;        t += '0.5 0.5 0';
493                         R_PolygonVertex(v, t, rgb, a);
494
495                         v = centre;                     t = '0.5 0.5 0';
496                         v.y += 0.5 * ringsize.y;        t += '0.5 -0.5 0';
497                         R_PolygonVertex(v, t, rgb, a);
498
499                         v = centre;                     t = '0.5 0.5 0';
500                         v.x -= 0.5 * ringsize.x;        t -= '0.5 0.5 0';
501                         R_PolygonVertex(v, t, rgb, a);
502                 R_EndPolygon();
503                 // draw clipped lower half as a triangle
504                 R_BeginPolygon(pic, drawflag, true);
505                         v = centre;                     t = '0.5 0.5 0';
506                         R_PolygonVertex(v, t, rgb, a);
507
508                         v = centre;                     t = '0.5 0.5 0';
509                         v.x -= 0.5 * ringsize.x;        t -= '0.5 0.5 0';
510                         R_PolygonVertex(v, t, rgb, a);
511         }
512         else if(f > 0.25)
513         {
514                 // draw clipped lower half as a quad
515                 R_BeginPolygon(pic, drawflag, true);
516                         v = centre;                     t = '0.5 0.5 0';
517                         R_PolygonVertex(v, t, rgb, a);
518
519                         v = centre;                     t = '0.5 0.5 0';
520                         v.x += 0.5 * ringsize.x;        t += '0.5 0.5 0';
521                         R_PolygonVertex(v, t, rgb, a);
522
523                         v = centre;                     t = '0.5 0.5 0';
524                         v.y += 0.5 * ringsize.y;        t += '0.5 -0.5 0';
525                         R_PolygonVertex(v, t, rgb, a);
526         }
527         else if (f > 0)
528         {
529                 // draw clipped lower half as a triangle
530                 R_BeginPolygon(pic, drawflag, true);
531                         v = centre;                     t = '0.5 0.5 0';
532                         R_PolygonVertex(v, t, rgb, a);
533
534                         v = centre;                     t = '0.5 0.5 0';
535                         v.x += 0.5 * ringsize.x;        t += '0.5 0.5 0';
536                         R_PolygonVertex(v, t, rgb, a);
537         }
538         else
539         {
540                 // Nothing to draw.
541                 return;
542         }
543
544         // The last, moving vertex.
545                 v = centre;                     t = '0.5 0.5 0';
546                 v.x += co * 0.5 * ringsize.x;   t += co * '0.5 0.5 0';
547                 v.y += si * 0.5 * ringsize.y;   t += si * '0.5 -0.5 0';
548                 R_PolygonVertex(v, t, rgb, a);
549         R_EndPolygon();
550 }
551
552 /** engine callback */
553 void URI_Get_Callback(int id, int status, string data)
554 {
555         TC(int, id); TC(int, status);
556         if(url_URI_Get_Callback(id, status, data))
557         {
558                 // handled
559         }
560         else if (id == URI_GET_DISCARD)
561         {
562                 // discard
563         }
564         else if (id >= URI_GET_CURL && id <= URI_GET_CURL_END)
565         {
566                 // sv_cmd curl
567                 Curl_URI_Get_Callback(id, status, data);
568         }
569         else
570         {
571                 LOG_INFOF("Received HTTP request data for an invalid id %d.", id);
572         }
573 }
574
575 void Accuracy_LoadLevels()
576 {
577         if(autocvar_accuracy_color_levels != acc_color_levels)
578         {
579                 strcpy(acc_color_levels, autocvar_accuracy_color_levels);
580                 acc_levels = tokenize_console(acc_color_levels);
581                 if(acc_levels > MAX_ACCURACY_LEVELS)
582                         acc_levels = MAX_ACCURACY_LEVELS;
583                 if(acc_levels < 2)
584                         LOG_INFO("Warning: accuracy_color_levels must contain at least 2 values");
585
586                 int i;
587                 for(i = 0; i < acc_levels; ++i)
588                         acc_lev[i] = stof(argv(i)) / 100.0;
589         }
590 }
591
592 void Accuracy_LoadColors()
593 {
594         if(time > acc_col_loadtime)
595         if(acc_levels >= 2)
596         {
597                 int i;
598                 for(i = 0; i < acc_levels; ++i)
599                         acc_col[i] = stov(cvar_string(strcat("accuracy_color", ftos(i))));
600                 acc_col_loadtime = time + 2;
601         }
602 }
603
604 vector Accuracy_GetColor(float accuracy)
605 {
606         float factor;
607         vector color;
608         if(acc_levels < 2)
609                 return '0 0 0'; // return black, can't determine the right color
610
611         // find the max level lower than acc
612         int j = acc_levels-1;
613         while(j && accuracy < acc_lev[j])
614                 --j;
615
616         // inject color j+1 in color j, how much depending on how much accuracy is higher than level j
617         factor = (accuracy - acc_lev[j]) / (acc_lev[j+1] - acc_lev[j]);
618         color = acc_col[j];
619         color = color + factor * (acc_col[j+1] - color);
620         return color;
621 }