Fix compilation with gmqcc.
[xonotic/xonotic-data.pk3dir.git] / qcsrc / csqcmodellib / cl_model.qc
1 /*
2  * Copyright (c) 2011 Rudolf Polzer
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to
6  * deal in the Software without restriction, including without limitation the
7  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
8  * sell copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
20  * IN THE SOFTWARE.
21  */
22
23 var float autocvar_cl_lerpanim_maxdelta_framegroups = 0.1;
24 var float autocvar_cl_nolerp = 0;
25
26 .float csqcmodel_lerpfrac;
27 .float csqcmodel_lerpfrac2;
28 .float csqcmodel_lerpfractime;
29 .float csqcmodel_lerpfrac2time;
30
31 void CSQCModel_InterpolateAnimation_2To4_PreNote(float sf)
32 {
33         if(sf & CSQCMODEL_PROPERTY_FRAME)
34         {
35                 self.frame3 = self.frame;
36                 self.frame3time = self.frame1time;
37         }
38         if(sf & CSQCMODEL_PROPERTY_FRAME2)
39         {
40                 self.frame4 = self.frame2;
41                 self.frame4time = self.frame2time;
42         }
43         if(sf & CSQCMODEL_PROPERTY_LERPFRAC)
44         {
45                 self.csqcmodel_lerpfrac2 = self.csqcmodel_lerpfrac;
46                 self.csqcmodel_lerpfrac2time = self.csqcmodel_lerpfractime;
47                 self.lerpfrac = self.csqcmodel_lerpfrac;
48         }
49 }
50 void CSQCModel_InterpolateAnimation_1To2_PreNote(float sf)
51 {
52         if(sf & CSQCMODEL_PROPERTY_FRAME)
53         {
54                 self.frame2 = self.frame;
55                 self.frame2time = self.frame1time;
56         }
57 }
58 void CSQCModel_InterpolateAnimation_PreNote(float sf)
59 {
60 #ifdef CSQCMODEL_HAVE_TWO_FRAMES
61         CSQCModel_InterpolateAnimation_2To4_PreNote(sf);
62 #else
63         CSQCModel_InterpolateAnimation_1To2_PreNote(sf);
64 #endif
65 }
66
67 void CSQCModel_InterpolateAnimation_2To4_Note(float sf, float set_times)
68 {
69         if(sf & CSQCMODEL_PROPERTY_FRAME)
70         {
71                 if(set_times)
72                         self.frame1time = time;
73         }
74         if(sf & CSQCMODEL_PROPERTY_FRAME2)
75         {
76                 if(set_times)
77                         self.frame2time = time;
78         }
79         if(sf & CSQCMODEL_PROPERTY_LERPFRAC)
80         {
81                 self.csqcmodel_lerpfrac = self.lerpfrac;
82                 if(set_times)
83                         self.csqcmodel_lerpfractime = time;
84         }
85 }
86 void CSQCModel_InterpolateAnimation_1To2_Note(float sf, float set_times)
87 {
88         if(sf & CSQCMODEL_PROPERTY_FRAME)
89         {
90                 if(set_times)
91                         self.frame1time = time;
92         }
93 }
94 void CSQCModel_InterpolateAnimation_Note(float sf)
95 {
96 #ifdef CSQCMODEL_HAVE_TWO_FRAMES
97         CSQCModel_InterpolateAnimation_2To4_Note(sf, TRUE);
98 #else
99         CSQCModel_InterpolateAnimation_1To2_Note(sf, TRUE);
100 #endif
101 }
102
103 void CSQCModel_InterpolateAnimation_2To4_Do()
104 {
105         if(autocvar_cl_nolerp || (autocvar_cl_lerpanim_maxdelta_framegroups == 0))
106         {
107                 self.lerpfrac = self.csqcmodel_lerpfrac;
108                 self.lerpfrac3 = 0;
109                 self.lerpfrac4 = 0;
110         }
111         else
112         {
113                 float l13, l24, llf;
114                 float l24_13;
115
116                 if(self.frame3time == 0) // if frame1/3 were not previously displayed, only frame1 can make sense
117                         l13 = 1;
118                 else
119                         l13 = bound(0, (time - self.frame1time) / autocvar_cl_lerpanim_maxdelta_framegroups, 1);
120
121                 if(self.frame4time == 0) // if frame2/4 were not previously displayed, only frame2 can make sense
122                         l24 = 1;
123                 else
124                         l24 = bound(0, (time - self.frame2time) / autocvar_cl_lerpanim_maxdelta_framegroups, 1);
125
126                 if(self.csqcmodel_lerpfrac2time == 0) // if there is no old lerpfrac (newly displayed model), only lerpfrac makes sense
127                         llf = 1;
128                 else
129                         llf = bound(0, (time - self.csqcmodel_lerpfractime) / autocvar_cl_lerpanim_maxdelta_framegroups, 1);
130
131                 l24_13 = self.csqcmodel_lerpfrac * llf + self.csqcmodel_lerpfrac2 * (1 - llf);
132
133                 self.lerpfrac  = l24 * l24_13;
134                 self.lerpfrac4 = (1 - l24) * l24_13;
135                 self.lerpfrac3 = (1 - l13) * (1 - l24_13);
136
137                 if(l24_13 == 0) // if frames 2/4 are not displayed, clear their frametime
138                 {
139                         self.frame2time = 0;
140                         self.frame4time = 0;
141                 }
142
143                 if(l24_13 == 1) // if frames 1/3 are not displayed, clear their frametime
144                 {
145                         self.frame1time = 0;
146                         self.frame3time = 0;
147                 }
148         }
149 }
150 void CSQCModel_InterpolateAnimation_1To2_Do()
151 {
152         if(autocvar_cl_nolerp || (autocvar_cl_lerpanim_maxdelta_framegroups == 0))
153         {
154                 self.lerpfrac = 0;
155         }
156         else
157         {
158                 if(self.frame2time == 0) // if frame2 was not previously displayed, only frame1 can make sense
159                         self.lerpfrac = 0;
160                 else
161                         self.lerpfrac = 1 - bound(0, (time - self.frame1time) / autocvar_cl_lerpanim_maxdelta_framegroups, 1);
162         }
163 }
164 void CSQCModel_InterpolateAnimation_Do()
165 {
166 #ifdef CSQCMODEL_HAVE_TWO_FRAMES
167         CSQCModel_InterpolateAnimation_2To4_Do();
168 #else
169         CSQCModel_InterpolateAnimation_1To2_Do();
170 #endif
171 }
172
173 void CSQCModel_Draw()
174 {
175         // some nice flags for CSQCMODEL_IF and the hooks
176         local noref float isplayer = (self.entnum >= 1 && self.entnum <= maxclients);
177         local noref float islocalplayer = (self.entnum == player_localnum + 1);
178         local noref float isnolocalplayer = (isplayer && (self.entnum != player_localnum + 1));
179
180         // we don't do this for the local player as that one is already handled
181         // by CSQCPlayer_SetCamera()
182         if(!CSQCPlayer_IsLocalPlayer())
183                 InterpolateOrigin_Do();
184
185         CSQCModel_InterpolateAnimation_Do();
186
187         { CSQCMODEL_HOOK_PREDRAW }
188
189         // inherit draw flags easily
190         entity root = self;
191         while(root.tag_entity)
192                 root = root.tag_entity;
193         if(self != root)
194         {
195                 self.renderflags &= ~(RF_EXTERNALMODEL | RF_VIEWMODEL);
196                 self.renderflags |= (root.renderflags & (RF_EXTERNALMODEL | RF_VIEWMODEL));
197         }
198
199         // we're drawn, now teleporting is over
200         self.csqcmodel_teleported = 0;
201 }
202
203 void CSQCModel_Read(float isnew)
204 {
205         float sf;
206         sf = ReadShort();
207
208         // some nice flags for CSQCMODEL_IF and the hooks
209         local noref float isplayer = (self.entnum >= 1 && self.entnum <= maxclients);
210         local noref float islocalplayer = (self.entnum == player_localnum + 1);
211         local noref float isnolocalplayer = (isplayer && (self.entnum != player_localnum + 1));
212
213         self.classname = "csqcmodel";
214         self.iflags |= IFLAG_ORIGIN; // interpolate origin too
215         self.iflags |= IFLAG_ANGLES; // interpolate angles too
216         self.iflags |= IFLAG_VELOCITY | IFLAG_AUTOVELOCITY; // let's calculate velocity automatically
217
218         { CSQCMODEL_HOOK_PREUPDATE }
219
220         CSQCPlayer_PreUpdate();
221         InterpolateOrigin_Undo();
222         CSQCModel_InterpolateAnimation_PreNote(sf);
223
224 #define CSQCMODEL_IF(cond) if(cond) {
225 #define CSQCMODEL_ENDIF }
226 #define CSQCMODEL_PROPERTY(flag,t,r,w,f) \
227         if(sf & flag) \
228                 self.f = r();
229 #define CSQCMODEL_PROPERTY_SCALED(flag,t,r,w,f,s,mi,ma) \
230         if(sf & flag) \
231                 self.f = (r() + mi) / s;
232         ALLPROPERTIES
233 #undef CSQCMODEL_PROPERTY_SCALED
234 #undef CSQCMODEL_PROPERTY
235 #undef CSQCMODEL_ENDIF
236 #undef CSQCMODEL_IF
237
238         if(sf & CSQCMODEL_PROPERTY_MODELINDEX)
239                 setmodelindex(self, self.modelindex); // this retrieves the .model key and sets mins/maxs/absmin/absmax
240                 // FIXME do we WANT this to override mins/maxs?
241
242         if(sf & CSQCMODEL_PROPERTY_TELEPORTED)
243         {
244                 self.iflags |= IFLAG_TELEPORTED;
245                 self.csqcmodel_teleported = 1;
246         }
247         
248         CSQCModel_InterpolateAnimation_Note(sf);
249         InterpolateOrigin_Note();
250         CSQCPlayer_PostUpdate();
251
252         { CSQCMODEL_HOOK_POSTUPDATE }
253
254 #ifdef CSQCMODEL_SUPPORT_GETTAGINFO_BEFORE_DRAW
255         InterpolateOrigin_Do();
256         CSQCModel_InterpolateAnimation_Do();
257 #endif
258
259         // relink
260         setorigin(self, self.origin);
261
262         // set obvious render flags
263 #ifdef COMPAT_XON050_ENGINE
264         if(self.entnum == player_localentnum || self.entnum == spectatee_status)
265 #else
266         if(self.entnum == player_localentnum)
267 #endif
268                 self.renderflags |= RF_EXTERNALMODEL;
269         else
270                 self.renderflags &= ~RF_EXTERNALMODEL;
271
272         // draw it
273         self.drawmask = MASK_NORMAL;
274         self.predraw = CSQCModel_Draw;
275 }
276
277 entity CSQCModel_server2csqc(float pl)
278 {
279         return findfloat(world, entnum, pl); // FIXME optimize this using an array
280 }