1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
|
//========= Copyright Valve Corporation, All rights reserved. ============//
//
// Purpose:
//
//=============================================================================//
#ifndef INTERPOLATEDVAR_H
#define INTERPOLATEDVAR_H
#ifdef _WIN32
#pragma once
#endif
#include "tier1/utllinkedlist.h"
#include "rangecheckedvar.h"
#include "lerp_functions.h"
#include "animationlayer.h"
#include "convar.h"
#include "tier0/memdbgon.h"
#define COMPARE_HISTORY(a,b) \
( memcmp( m_VarHistory[a].GetValue(), m_VarHistory[b].GetValue(), sizeof(Type)*GetMaxCount() ) == 0 )
// Define this to have it measure whether or not the interpolated entity list
// is accurate.
//#define INTERPOLATEDVAR_PARANOID_MEASUREMENT
#define LATCH_ANIMATION_VAR (1<<0) // use AnimTime as sample basis
#define LATCH_SIMULATION_VAR (1<<1) // use SimulationTime as sample basis
#define EXCLUDE_AUTO_LATCH (1<<2)
#define EXCLUDE_AUTO_INTERPOLATE (1<<3)
#define INTERPOLATE_LINEAR_ONLY (1<<4) // don't do hermite interpolation
#define INTERPOLATE_OMIT_UPDATE_LAST_NETWORKED (1<<5)
#define EXTRA_INTERPOLATION_HISTORY_STORED 0.05f // It stores this much extra interpolation history,
// so you can always call Interpolate() this far
// in the past from your last call and be able to
// get an interpolated value.
// this global keeps the last known server packet tick (to avoid calling engine->GetLastTimestamp() all the time)
extern float g_flLastPacketTimestamp;
inline void Interpolation_SetLastPacketTimeStamp( float timestamp)
{
Assert( timestamp > 0 );
g_flLastPacketTimestamp = timestamp;
}
// Before calling Interpolate(), you can use this use this to setup the context if
// you want to enable extrapolation.
class CInterpolationContext
{
public:
CInterpolationContext()
{
m_bOldAllowExtrapolation = s_bAllowExtrapolation;
m_flOldLastTimeStamp = s_flLastTimeStamp;
// By default, disable extrapolation unless they call EnableExtrapolation.
s_bAllowExtrapolation = false;
// this is the context stack
m_pNext = s_pHead;
s_pHead = this;
}
~CInterpolationContext()
{
// restore values from prev stack element
s_bAllowExtrapolation = m_bOldAllowExtrapolation;
s_flLastTimeStamp = m_flOldLastTimeStamp;
Assert( s_pHead == this );
s_pHead = m_pNext;
}
static void EnableExtrapolation(bool state)
{
s_bAllowExtrapolation = state;
}
static bool IsThereAContext()
{
return s_pHead != NULL;
}
static bool IsExtrapolationAllowed()
{
return s_bAllowExtrapolation;
}
static void SetLastTimeStamp(float timestamp)
{
s_flLastTimeStamp = timestamp;
}
static float GetLastTimeStamp()
{
return s_flLastTimeStamp;
}
private:
CInterpolationContext *m_pNext;
bool m_bOldAllowExtrapolation;
float m_flOldLastTimeStamp;
static CInterpolationContext *s_pHead;
static bool s_bAllowExtrapolation;
static float s_flLastTimeStamp;
};
extern ConVar cl_extrapolate_amount;
template< class T >
inline T ExtrapolateInterpolatedVarType( const T &oldVal, const T &newVal, float divisor, float flExtrapolationAmount )
{
return newVal;
}
inline Vector ExtrapolateInterpolatedVarType( const Vector &oldVal, const Vector &newVal, float divisor, float flExtrapolationAmount )
{
return Lerp( 1.0f + flExtrapolationAmount * divisor, oldVal, newVal );
}
inline float ExtrapolateInterpolatedVarType( const float &oldVal, const float &newVal, float divisor, float flExtrapolationAmount )
{
return Lerp( 1.0f + flExtrapolationAmount * divisor, oldVal, newVal );
}
inline QAngle ExtrapolateInterpolatedVarType( const QAngle &oldVal, const QAngle &newVal, float divisor, float flExtrapolationAmount )
{
return Lerp<QAngle>( 1.0f + flExtrapolationAmount * divisor, oldVal, newVal );
}
// -------------------------------------------------------------------------------------------------------------- //
// IInterpolatedVar interface.
// -------------------------------------------------------------------------------------------------------------- //
abstract_class IInterpolatedVar
{
public:
virtual ~IInterpolatedVar() {}
virtual void Setup( void *pValue, int type ) = 0;
virtual void SetInterpolationAmount( float seconds ) = 0;
// Returns true if the new value is different from the prior most recent value.
virtual void NoteLastNetworkedValue() = 0;
virtual bool NoteChanged( float changetime, bool bUpdateLastNetworkedValue ) = 0;
virtual void Reset() = 0;
// Returns 1 if the value will always be the same if currentTime is always increasing.
virtual int Interpolate( float currentTime ) = 0;
virtual int GetType() const = 0;
virtual void RestoreToLastNetworked() = 0;
virtual void Copy( IInterpolatedVar *pSrc ) = 0;
virtual const char *GetDebugName() = 0;
virtual void SetDebugName( const char* pName ) = 0;
virtual void SetDebug( bool bDebug ) = 0;
};
template< typename Type, bool IS_ARRAY >
struct CInterpolatedVarEntryBase
{
CInterpolatedVarEntryBase()
{
value = NULL;
count = 0;
changetime = 0;
}
~CInterpolatedVarEntryBase()
{
delete[] value;
value = NULL;
}
// This will transfer the data from another varentry. This is used to avoid allocation
// pointers can be transferred (only one varentry has a copy), but not trivially copied
void FastTransferFrom( CInterpolatedVarEntryBase &src )
{
Assert(!value);
value = src.value;
count = src.count;
changetime = src.changetime;
src.value = 0;
src.count = 0;
}
CInterpolatedVarEntryBase& operator=( const CInterpolatedVarEntryBase& src )
{
delete[] value;
value = NULL;
count = 0;
if ( src.value )
{
count = src.count;
value = new Type[count];
for ( int i = 0; i < count; i++ )
{
value[i] = src.value[i];
}
}
return *this;
}
Type *GetValue() { return value; }
const Type *GetValue() const { return value; }
void Init(int maxCount)
{
if ( !maxCount )
{
DeleteEntry();
}
else
{
// resize
if ( maxCount != count )
{
DeleteEntry();
}
if ( !value )
{
count = maxCount;
value = new Type[maxCount];
}
}
Assert(count==maxCount);
}
Type *NewEntry( const Type *pValue, int maxCount, float time )
{
changetime = time;
Init(maxCount);
if ( value && maxCount)
{
memcpy( value, pValue, maxCount*sizeof(Type) );
}
return value;
}
void DeleteEntry()
{
delete[] value;
value = NULL;
count = 0;
}
float changetime;
int count;
Type * value;
private:
CInterpolatedVarEntryBase( const CInterpolatedVarEntryBase &src );
};
template<typename Type>
struct CInterpolatedVarEntryBase<Type, false>
{
CInterpolatedVarEntryBase() {}
~CInterpolatedVarEntryBase() {}
const Type *GetValue() const { return &value; }
Type *GetValue() { return &value; }
void Init(int maxCount)
{
Assert(maxCount==1);
}
Type *NewEntry( const Type *pValue, int maxCount, float time )
{
Assert(maxCount==1);
changetime = time;
memcpy( &value, pValue, maxCount*sizeof(Type) );
return &value;
}
void FastTransferFrom( CInterpolatedVarEntryBase &src )
{
*this = src;
}
void DeleteEntry() {}
float changetime;
Type value;
};
template<typename T>
class CSimpleRingBuffer
{
public:
CSimpleRingBuffer( int startSize = 4 )
{
m_pElements = 0;
m_maxElement = 0;
m_firstElement = 0;
m_count = 0;
m_growSize = 16;
EnsureCapacity(startSize);
}
~CSimpleRingBuffer()
{
delete[] m_pElements;
m_pElements = NULL;
}
inline int Count() const { return m_count; }
int Head() const { return (m_count>0) ? 0 : InvalidIndex(); }
bool IsIdxValid( int i ) const { return (i >= 0 && i < m_count) ? true : false; }
bool IsValidIndex(int i) const { return IsIdxValid(i); }
static int InvalidIndex() { return -1; }
T& operator[]( int i )
{
Assert( IsIdxValid(i) );
i += m_firstElement;
i = WrapRange(i);
return m_pElements[i];
}
const T& operator[]( int i ) const
{
Assert( IsIdxValid(i) );
i += m_firstElement;
i = WrapRange(i);
return m_pElements[i];
}
void EnsureCapacity( int capSize )
{
if ( capSize > m_maxElement )
{
int newMax = m_maxElement + ((capSize+m_growSize-1)/m_growSize) * m_growSize;
T *pNew = new T[newMax];
for ( int i = 0; i < m_maxElement; i++ )
{
// ------------
// If you wanted to make this a more generic container you'd probably want this code
// instead - since FastTransferFrom() is an optimization dependent on types stored
// here defining this operation.
//pNew[i] = m_pElements[WrapRange(i+m_firstElement)];
pNew[i].FastTransferFrom( m_pElements[WrapRange(i+m_firstElement)] );
// ------------
}
m_firstElement = 0;
m_maxElement = newMax;
delete[] m_pElements;
m_pElements = pNew;
}
}
int AddToHead()
{
EnsureCapacity( m_count + 1 );
int i = m_firstElement + m_maxElement - 1;
m_count++;
i = WrapRange(i);
m_firstElement = i;
return 0;
}
int AddToHead( const T &elem )
{
AddToHead();
m_pElements[m_firstElement] = elem;
return 0;
}
int AddToTail()
{
EnsureCapacity( m_count + 1 );
m_count++;
return WrapRange(m_firstElement+m_count-1);
}
void RemoveAll()
{
m_count = 0;
m_firstElement = 0;
}
void RemoveAtHead()
{
if ( m_count > 0 )
{
m_firstElement = WrapRange(m_firstElement+1);
m_count--;
}
}
void Truncate( int newLength )
{
if ( newLength < m_count )
{
Assert(newLength>=0);
m_count = newLength;
}
}
private:
inline int WrapRange( int i ) const
{
return ( i >= m_maxElement ) ? (i - m_maxElement) : i;
}
T *m_pElements;
unsigned short m_maxElement;
unsigned short m_firstElement;
unsigned short m_count;
unsigned short m_growSize;
};
// -------------------------------------------------------------------------------------------------------------- //
// CInterpolatedVarArrayBase - the main implementation of IInterpolatedVar.
// -------------------------------------------------------------------------------------------------------------- //
template< typename Type, bool IS_ARRAY>
class CInterpolatedVarArrayBase : public IInterpolatedVar
{
public:
friend class CInterpolatedVarPrivate;
CInterpolatedVarArrayBase( const char *pDebugName="no debug name" );
virtual ~CInterpolatedVarArrayBase();
// IInterpolatedVar overrides.
public:
virtual void Setup( void *pValue, int type );
virtual void SetInterpolationAmount( float seconds );
virtual void NoteLastNetworkedValue();
virtual bool NoteChanged( float changetime, bool bUpdateLastNetworkedValue );
virtual void Reset();
virtual int Interpolate( float currentTime );
virtual int GetType() const;
virtual void RestoreToLastNetworked();
virtual void Copy( IInterpolatedVar *pInSrc );
virtual const char *GetDebugName() { return m_pDebugName; }
public:
// Just like the IInterpolatedVar functions, but you can specify an interpolation amount.
bool NoteChanged( float changetime, float interpolation_amount, bool bUpdateLastNetworkedValue );
int Interpolate( float currentTime, float interpolation_amount );
void DebugInterpolate( Type *pOut, float currentTime );
void GetDerivative( Type *pOut, float currentTime );
void GetDerivative_SmoothVelocity( Type *pOut, float currentTime ); // See notes on ::Derivative_HermiteLinearVelocity for info.
void ClearHistory();
void AddToHead( float changeTime, const Type* values, bool bFlushNewer );
const Type& GetPrev( int iArrayIndex=0 ) const;
const Type& GetCurrent( int iArrayIndex=0 ) const;
// Returns the time difference betweem the most recent sample and its previous sample.
float GetInterval() const;
bool IsValidIndex( int i );
Type *GetHistoryValue( int index, float& changetime, int iArrayIndex=0 );
int GetHead() { return 0; }
int GetNext( int i )
{
int next = i + 1;
if ( !m_VarHistory.IsValidIndex(next) )
return m_VarHistory.InvalidIndex();
return next;
}
void SetHistoryValuesForItem( int item, Type& value );
void SetLooping( bool looping, int iArrayIndex=0 );
void SetMaxCount( int newmax );
int GetMaxCount() const;
// Get the time of the oldest entry.
float GetOldestEntry();
// set a debug name (if not provided by constructor)
void SetDebugName(const char *pName ) { m_pDebugName = pName; }
virtual void SetDebug( bool bDebug ) { m_bDebug = bDebug; }
bool GetInterpolationInfo( float currentTime, int *pNewer, int *pOlder, int *pOldest );
protected:
typedef CInterpolatedVarEntryBase<Type, IS_ARRAY> CInterpolatedVarEntry;
typedef CSimpleRingBuffer< CInterpolatedVarEntry > CVarHistory;
friend class CInterpolationInfo;
class CInterpolationInfo
{
public:
bool m_bHermite;
int oldest; // Only set if using hermite.
int older;
int newer;
float frac;
};
protected:
void RemoveOldEntries( float oldesttime );
void RemoveEntriesPreviousTo( float flTime );
bool GetInterpolationInfo(
CInterpolationInfo *pInfo,
float currentTime,
float interpolation_amount,
int *pNoMoreChanges );
void TimeFixup_Hermite(
CInterpolatedVarEntry &fixup,
CInterpolatedVarEntry*& prev,
CInterpolatedVarEntry*& start,
CInterpolatedVarEntry*& end );
// Force the time between prev and start to be dt (and extend prev out farther if necessary).
void TimeFixup2_Hermite(
CInterpolatedVarEntry &fixup,
CInterpolatedVarEntry*& prev,
CInterpolatedVarEntry*& start,
float dt
);
void _Extrapolate(
Type *pOut,
CInterpolatedVarEntry *pOld,
CInterpolatedVarEntry *pNew,
float flDestinationTime,
float flMaxExtrapolationAmount
);
void _Interpolate( Type *out, float frac, CInterpolatedVarEntry *start, CInterpolatedVarEntry *end );
void _Interpolate_Hermite( Type *out, float frac, CInterpolatedVarEntry *pOriginalPrev, CInterpolatedVarEntry *start, CInterpolatedVarEntry *end, bool looping = false );
void _Derivative_Hermite( Type *out, float frac, CInterpolatedVarEntry *pOriginalPrev, CInterpolatedVarEntry *start, CInterpolatedVarEntry *end );
void _Derivative_Hermite_SmoothVelocity( Type *out, float frac, CInterpolatedVarEntry *b, CInterpolatedVarEntry *c, CInterpolatedVarEntry *d );
void _Derivative_Linear( Type *out, CInterpolatedVarEntry *start, CInterpolatedVarEntry *end );
bool ValidOrder();
protected:
// The underlying data element
Type *m_pValue;
CVarHistory m_VarHistory;
// Store networked values so when we latch we can detect which values were changed via networking
Type * m_LastNetworkedValue;
float m_LastNetworkedTime;
byte m_fType;
byte m_nMaxCount;
byte * m_bLooping;
float m_InterpolationAmount;
const char * m_pDebugName;
bool m_bDebug : 1;
};
template< typename Type, bool IS_ARRAY >
inline CInterpolatedVarArrayBase<Type, IS_ARRAY>::CInterpolatedVarArrayBase( const char *pDebugName )
{
m_pDebugName = pDebugName;
m_pValue = NULL;
m_fType = LATCH_ANIMATION_VAR;
m_InterpolationAmount = 0.0f;
m_nMaxCount = 0;
m_LastNetworkedTime = 0;
m_LastNetworkedValue = NULL;
m_bLooping = NULL;
m_bDebug = false;
}
template< typename Type, bool IS_ARRAY >
inline CInterpolatedVarArrayBase<Type, IS_ARRAY>::~CInterpolatedVarArrayBase()
{
ClearHistory();
delete [] m_bLooping;
delete [] m_LastNetworkedValue;
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::Setup( void *pValue, int type )
{
m_pValue = ( Type * )pValue;
m_fType = type;
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::SetInterpolationAmount( float seconds )
{
m_InterpolationAmount = seconds;
}
template< typename Type, bool IS_ARRAY >
inline int CInterpolatedVarArrayBase<Type, IS_ARRAY>::GetType() const
{
return m_fType;
}
template< typename Type, bool IS_ARRAY >
void CInterpolatedVarArrayBase<Type, IS_ARRAY>::NoteLastNetworkedValue()
{
memcpy( m_LastNetworkedValue, m_pValue, m_nMaxCount * sizeof( Type ) );
m_LastNetworkedTime = g_flLastPacketTimestamp;
}
template< typename Type, bool IS_ARRAY >
inline bool CInterpolatedVarArrayBase<Type, IS_ARRAY>::NoteChanged( float changetime, float interpolation_amount, bool bUpdateLastNetworkedValue )
{
Assert( m_pValue );
// This is a big optimization where it can potentially avoid expensive interpolation
// involving this variable if it didn't get an actual new value in here.
bool bRet = true;
if ( m_VarHistory.Count() )
{
if ( memcmp( m_pValue, m_VarHistory[0].GetValue(), sizeof( Type ) * m_nMaxCount ) == 0 )
{
bRet = false;
}
}
if ( m_bDebug )
{
char const *pDiffString = bRet ? "differs" : "identical";
Msg( "%s LatchChanged at %f changetime %f: %s\n", GetDebugName(), gpGlobals->curtime, changetime, pDiffString );
}
AddToHead( changetime, m_pValue, true );
if ( bUpdateLastNetworkedValue )
{
NoteLastNetworkedValue();
}
#if 0
// Since we don't clean out the old entries until Interpolate(), make sure that there
// aren't any super old entries hanging around.
RemoveOldEntries( gpGlobals->curtime - interpolation_amount - 2.0f );
#else
// JAY: It doesn't seem like the above code is correct. This is keeping more than two seconds of history
// for variables that aren't being interpolated for some reason. For example, the player model isn't drawn
// in first person, so the history is only truncated here and will accumulate ~40 entries instead of 2 or 3
// changing over to the method in Interpolate() means that we always have a 3-sample neighborhood around
// any data we're going to need. Unless gpGlobals->curtime is different when samples are added vs. when
// they are interpolated I can't see this having any ill effects.
RemoveEntriesPreviousTo( gpGlobals->curtime - interpolation_amount - EXTRA_INTERPOLATION_HISTORY_STORED );
#endif
return bRet;
}
template< typename Type, bool IS_ARRAY >
inline bool CInterpolatedVarArrayBase<Type, IS_ARRAY>::NoteChanged( float changetime, bool bUpdateLastNetworkedValue )
{
return NoteChanged( changetime, m_InterpolationAmount, bUpdateLastNetworkedValue );
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::RestoreToLastNetworked()
{
Assert( m_pValue );
memcpy( m_pValue, m_LastNetworkedValue, m_nMaxCount * sizeof( Type ) );
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::ClearHistory()
{
for ( int i = 0; i < m_VarHistory.Count(); i++ )
{
m_VarHistory[i].DeleteEntry();
}
m_VarHistory.RemoveAll();
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::AddToHead( float changeTime, const Type* values, bool bFlushNewer )
{
MEM_ALLOC_CREDIT_CLASS();
int newslot;
if ( bFlushNewer )
{
// Get rid of anything that has a timestamp after this sample. The server might have
// corrected our clock and moved us back, so our current changeTime is less than a
// changeTime we added samples during previously.
while ( m_VarHistory.Count() )
{
if ( (m_VarHistory[0].changetime+0.0001f) > changeTime )
{
m_VarHistory.RemoveAtHead();
}
else
{
break;
}
}
newslot = m_VarHistory.AddToHead();
}
else
{
newslot = m_VarHistory.AddToHead();
for ( int i = 1; i < m_VarHistory.Count(); i++ )
{
if ( m_VarHistory[i].changetime <= changeTime )
break;
m_VarHistory[newslot].FastTransferFrom( m_VarHistory[i] );
newslot = i;
}
}
CInterpolatedVarEntry *e = &m_VarHistory[ newslot ];
e->NewEntry( values, m_nMaxCount, changeTime );
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::Reset()
{
ClearHistory();
if ( m_pValue )
{
AddToHead( gpGlobals->curtime, m_pValue, false );
AddToHead( gpGlobals->curtime, m_pValue, false );
AddToHead( gpGlobals->curtime, m_pValue, false );
memcpy( m_LastNetworkedValue, m_pValue, m_nMaxCount * sizeof( Type ) );
}
}
template< typename Type, bool IS_ARRAY >
inline float CInterpolatedVarArrayBase<Type, IS_ARRAY>::GetOldestEntry()
{
float lastVal = 0;
if ( m_VarHistory.Count() )
{
lastVal = m_VarHistory[m_VarHistory.Count()-1].changetime;
}
return lastVal;
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::RemoveOldEntries( float oldesttime )
{
int newCount = m_VarHistory.Count();
for ( int i = m_VarHistory.Count(); --i > 2; )
{
if ( m_VarHistory[i].changetime > oldesttime )
break;
newCount = i;
}
m_VarHistory.Truncate(newCount);
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::RemoveEntriesPreviousTo( float flTime )
{
for ( int i = 0; i < m_VarHistory.Count(); i++ )
{
if ( m_VarHistory[i].changetime < flTime )
{
// We need to preserve this sample (ie: the one right before this timestamp)
// and the sample right before it (for hermite blending), and we can get rid
// of everything else.
m_VarHistory.Truncate( i + 3 );
break;
}
}
}
template< typename Type, bool IS_ARRAY >
inline bool CInterpolatedVarArrayBase<Type, IS_ARRAY>::GetInterpolationInfo(
typename CInterpolatedVarArrayBase<Type, IS_ARRAY>::CInterpolationInfo *pInfo,
float currentTime,
float interpolation_amount,
int *pNoMoreChanges
)
{
Assert( m_pValue );
CVarHistory &varHistory = m_VarHistory;
float targettime = currentTime - interpolation_amount;
pInfo->m_bHermite = false;
pInfo->frac = 0;
pInfo->oldest = pInfo->older = pInfo->newer = varHistory.InvalidIndex();
for ( int i = 0; i < varHistory.Count(); i++ )
{
pInfo->older = i;
float older_change_time = m_VarHistory[ i ].changetime;
if ( older_change_time == 0.0f )
break;
if ( targettime < older_change_time )
{
pInfo->newer = pInfo->older;
continue;
}
if ( pInfo->newer == varHistory.InvalidIndex() )
{
// Have it linear interpolate between the newest 2 entries.
pInfo->newer = pInfo->older;
// Since the time given is PAST all of our entries, then as long
// as time continues to increase, we'll be returning the same value.
if ( pNoMoreChanges )
*pNoMoreChanges = 1;
return true;
}
float newer_change_time = varHistory[ pInfo->newer ].changetime;
float dt = newer_change_time - older_change_time;
if ( dt > 0.0001f )
{
pInfo->frac = ( targettime - older_change_time ) / ( newer_change_time - older_change_time );
pInfo->frac = MIN( pInfo->frac, 2.0f );
int oldestindex = i+1;
if ( !(m_fType & INTERPOLATE_LINEAR_ONLY) && varHistory.IsIdxValid(oldestindex) )
{
pInfo->oldest = oldestindex;
float oldest_change_time = varHistory[ oldestindex ].changetime;
float dt2 = older_change_time - oldest_change_time;
if ( dt2 > 0.0001f )
{
pInfo->m_bHermite = true;
}
}
// If pInfo->newer is the most recent entry we have, and all 2 or 3 other
// entries are identical, then we're always going to return the same value
// if currentTime increases.
if ( pNoMoreChanges && pInfo->newer == m_VarHistory.Head() )
{
if ( COMPARE_HISTORY( pInfo->newer, pInfo->older ) )
{
if ( !pInfo->m_bHermite || COMPARE_HISTORY( pInfo->newer, pInfo->oldest ) )
*pNoMoreChanges = 1;
}
}
}
return true;
}
// Didn't find any, return last entry???
if ( pInfo->newer != varHistory.InvalidIndex() )
{
pInfo->older = pInfo->newer;
return true;
}
// This is the single-element case
pInfo->newer = pInfo->older;
return (pInfo->older != varHistory.InvalidIndex());
}
template< typename Type, bool IS_ARRAY >
inline bool CInterpolatedVarArrayBase<Type, IS_ARRAY>::GetInterpolationInfo( float currentTime, int *pNewer, int *pOlder, int *pOldest )
{
CInterpolationInfo info;
bool result = GetInterpolationInfo( &info, currentTime, m_InterpolationAmount, NULL );
if (pNewer)
*pNewer = (int)info.newer;
if (pOlder)
*pOlder = (int)info.older;
if (pOldest)
*pOldest = (int)info.oldest;
return result;
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::DebugInterpolate( Type *pOut, float currentTime )
{
float interpolation_amount = m_InterpolationAmount;
int noMoreChanges = 0;
CInterpolationInfo info;
GetInterpolationInfo( &info, currentTime, interpolation_amount, &noMoreChanges );
CVarHistory &history = m_VarHistory;
if ( info.m_bHermite )
{
// base cast, we have 3 valid sample point
_Interpolate_Hermite( pOut, info.frac, &history[info.oldest], &history[info.older], &history[info.newer] );
}
else if ( info.newer == info.older )
{
// This means the server clock got way behind the client clock. Extrapolate the value here based on its
// previous velocity (out to a certain amount).
int realOlder = info.newer+1;
if ( CInterpolationContext::IsExtrapolationAllowed() &&
IsValidIndex( realOlder ) &&
history[realOlder].changetime != 0.0 &&
interpolation_amount > 0.000001f &&
CInterpolationContext::GetLastTimeStamp() <= m_LastNetworkedTime )
{
// At this point, we know we're out of data and we have the ability to get a velocity to extrapolate with.
//
// However, we only want to extraploate if the server is choking. We don't want to extrapolate if
// the object legimately stopped moving and the server stopped sending updates for it.
//
// The way we know that the server is choking is if we haven't heard ANYTHING from it for a while.
// The server's update interval should be at least as often as our interpolation amount (otherwise,
// we wouldn't have the ability to interpolate).
//
// So right here, if we see that we haven't gotten any server updates since the last interpolation
// history update to this entity (and since we're in here, we know that we're out of interpolation data),
// then we can assume that the server is choking and decide to extrapolate.
//
// The End
// Use the velocity here (extrapolate up to 1/4 of a second).
_Extrapolate( pOut, &history[realOlder], &history[info.newer], currentTime - interpolation_amount, cl_extrapolate_amount.GetFloat() );
}
else
{
_Interpolate( pOut, info.frac, &history[info.older], &history[info.newer] );
}
}
else
{
_Interpolate( pOut, info.frac, &history[info.older], &history[info.newer] );
}
}
template< typename Type, bool IS_ARRAY >
inline int CInterpolatedVarArrayBase<Type, IS_ARRAY>::Interpolate( float currentTime, float interpolation_amount )
{
int noMoreChanges = 0;
CInterpolationInfo info;
if (!GetInterpolationInfo( &info, currentTime, interpolation_amount, &noMoreChanges ))
return noMoreChanges;
CVarHistory &history = m_VarHistory;
if ( m_bDebug )
{
// "value will hold" means we are either extrapolating, or the samples in GetInterpolationInfo are all the same... In either case there are no more "changes" until we latch a new
// value and we can remove this var from the interpolated var list (bit perf optimization)
Msg( "%s Interpolate at %f%s\n", GetDebugName(), currentTime, noMoreChanges ? " [value will hold]" : "" );
}
#ifdef INTERPOLATEDVAR_PARANOID_MEASUREMENT
Type *backupValues = (Type*)_alloca( m_nMaxCount * sizeof(Type) );
memcpy( backupValues, m_pValue, sizeof( Type ) * m_nMaxCount );
#endif
if ( info.m_bHermite )
{
// base cast, we have 3 valid sample point
_Interpolate_Hermite( m_pValue, info.frac, &history[info.oldest], &history[info.older], &history[info.newer] );
}
else if ( info.newer == info.older )
{
// This means the server clock got way behind the client clock. Extrapolate the value here based on its
// previous velocity (out to a certain amount).
int realOlder = info.newer+1;
if ( CInterpolationContext::IsExtrapolationAllowed() &&
IsValidIndex( realOlder ) &&
history[realOlder].changetime != 0.0 &&
interpolation_amount > 0.000001f &&
CInterpolationContext::GetLastTimeStamp() <= m_LastNetworkedTime )
{
// At this point, we know we're out of data and we have the ability to get a velocity to extrapolate with.
//
// However, we only want to extraploate if the server is choking. We don't want to extrapolate if
// the object legimately stopped moving and the server stopped sending updates for it.
//
// The way we know that the server is choking is if we haven't heard ANYTHING from it for a while.
// The server's update interval should be at least as often as our interpolation amount (otherwise,
// we wouldn't have the ability to interpolate).
//
// So right here, if we see that we haven't gotten any server updates since the last interpolation
// history update to this entity (and since we're in here, we know that we're out of interpolation data),
// then we can assume that the server is choking and decide to extrapolate.
//
// The End
// Use the velocity here (extrapolate up to 1/4 of a second).
_Extrapolate( m_pValue, &history[realOlder], &history[info.newer], currentTime - interpolation_amount, cl_extrapolate_amount.GetFloat() );
}
else
{
_Interpolate( m_pValue, info.frac, &history[info.older], &history[info.newer] );
}
}
else
{
_Interpolate( m_pValue, info.frac, &history[info.older], &history[info.newer] );
}
#ifdef INTERPOLATEDVAR_PARANOID_MEASUREMENT
if ( memcmp( backupValues, m_pValue, sizeof( Type ) * m_nMaxCount ) != 0 )
{
extern int g_nInterpolatedVarsChanged;
extern bool g_bRestoreInterpolatedVarValues;
++g_nInterpolatedVarsChanged;
// This undoes the work that we do in here so if someone is in the debugger, they
// can find out which variable changed.
if ( g_bRestoreInterpolatedVarValues )
{
memcpy( m_pValue, backupValues, sizeof( Type ) * m_nMaxCount );
return noMoreChanges;
}
}
#endif
// Clear out all entries before the oldest since we should never access them again.
// Usually, Interpolate() calls never go backwards in time, but C_BaseAnimating::BecomeRagdollOnClient for one
// goes slightly back in time
RemoveEntriesPreviousTo( currentTime - interpolation_amount - EXTRA_INTERPOLATION_HISTORY_STORED );
return noMoreChanges;
}
template< typename Type, bool IS_ARRAY >
void CInterpolatedVarArrayBase<Type, IS_ARRAY>::GetDerivative( Type *pOut, float currentTime )
{
CInterpolationInfo info;
if (!GetInterpolationInfo( &info, currentTime, m_InterpolationAmount, NULL ))
return;
if ( info.m_bHermite )
{
_Derivative_Hermite( pOut, info.frac, &m_VarHistory[info.oldest], &m_VarHistory[info.older], &m_VarHistory[info.newer] );
}
else
{
_Derivative_Linear( pOut, &m_VarHistory[info.older], &m_VarHistory[info.newer] );
}
}
template< typename Type, bool IS_ARRAY >
void CInterpolatedVarArrayBase<Type, IS_ARRAY>::GetDerivative_SmoothVelocity( Type *pOut, float currentTime )
{
CInterpolationInfo info;
if (!GetInterpolationInfo( &info, currentTime, m_InterpolationAmount, NULL ))
return;
CVarHistory &history = m_VarHistory;
bool bExtrapolate = false;
int realOlder = 0;
if ( info.m_bHermite )
{
_Derivative_Hermite_SmoothVelocity( pOut, info.frac, &history[info.oldest], &history[info.older], &history[info.newer] );
return;
}
else if ( info.newer == info.older && CInterpolationContext::IsExtrapolationAllowed() )
{
// This means the server clock got way behind the client clock. Extrapolate the value here based on its
// previous velocity (out to a certain amount).
realOlder = info.newer+1;
if ( IsValidIndex( realOlder ) && history[realOlder].changetime != 0.0 )
{
// At this point, we know we're out of data and we have the ability to get a velocity to extrapolate with.
//
// However, we only want to extraploate if the server is choking. We don't want to extrapolate if
// the object legimately stopped moving and the server stopped sending updates for it.
//
// The way we know that the server is choking is if we haven't heard ANYTHING from it for a while.
// The server's update interval should be at least as often as our interpolation amount (otherwise,
// we wouldn't have the ability to interpolate).
//
// So right here, if we see that we haven't gotten any server updates for a whole interpolation
// interval, then we know the server is choking.
//
// The End
if ( m_InterpolationAmount > 0.000001f &&
CInterpolationContext::GetLastTimeStamp() <= (currentTime - m_InterpolationAmount) )
{
bExtrapolate = true;
}
}
}
if ( bExtrapolate )
{
// Get the velocity from the last segment.
_Derivative_Linear( pOut, &history[realOlder], &history[info.newer] );
// Now ramp it to zero after cl_extrapolate_amount..
float flDestTime = currentTime - m_InterpolationAmount;
float diff = flDestTime - history[info.newer].changetime;
diff = clamp( diff, 0.f, cl_extrapolate_amount.GetFloat() * 2 );
if ( diff > cl_extrapolate_amount.GetFloat() )
{
float scale = 1 - (diff - cl_extrapolate_amount.GetFloat()) / cl_extrapolate_amount.GetFloat();
for ( int i=0; i < m_nMaxCount; i++ )
{
pOut[i] *= scale;
}
}
}
else
{
_Derivative_Linear( pOut, &history[info.older], &history[info.newer] );
}
}
template< typename Type, bool IS_ARRAY >
inline int CInterpolatedVarArrayBase<Type, IS_ARRAY>::Interpolate( float currentTime )
{
return Interpolate( currentTime, m_InterpolationAmount );
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::Copy( IInterpolatedVar *pInSrc )
{
CInterpolatedVarArrayBase<Type, IS_ARRAY> *pSrc = dynamic_cast< CInterpolatedVarArrayBase<Type, IS_ARRAY>* >( pInSrc );
if ( !pSrc || pSrc->m_nMaxCount != m_nMaxCount )
{
if ( pSrc )
{
AssertMsg3( false, "pSrc->m_nMaxCount (%i) != m_nMaxCount (%i) for %s.", pSrc->m_nMaxCount, m_nMaxCount, m_pDebugName);
}
else
{
AssertMsg( false, "pSrc was null in CInterpolatedVarArrayBase<Type, IS_ARRAY>::Copy.");
}
return;
}
Assert( (m_fType & ~EXCLUDE_AUTO_INTERPOLATE) == (pSrc->m_fType & ~EXCLUDE_AUTO_INTERPOLATE) );
Assert( m_pDebugName == pSrc->GetDebugName() );
for ( int i=0; i < m_nMaxCount; i++ )
{
m_LastNetworkedValue[i] = pSrc->m_LastNetworkedValue[i];
m_bLooping[i] = pSrc->m_bLooping[i];
}
m_LastNetworkedTime = pSrc->m_LastNetworkedTime;
// Copy the entries.
m_VarHistory.RemoveAll();
for ( int i = 0; i < pSrc->m_VarHistory.Count(); i++ )
{
int newslot = m_VarHistory.AddToTail();
CInterpolatedVarEntry *dest = &m_VarHistory[newslot];
CInterpolatedVarEntry *src = &pSrc->m_VarHistory[i];
dest->NewEntry( src->GetValue(), m_nMaxCount, src->changetime );
}
}
template< typename Type, bool IS_ARRAY >
inline const Type& CInterpolatedVarArrayBase<Type, IS_ARRAY>::GetPrev( int iArrayIndex ) const
{
Assert( m_pValue );
Assert( iArrayIndex >= 0 && iArrayIndex < m_nMaxCount );
if ( m_VarHistory.Count() > 1 )
{
return m_VarHistory[1].GetValue()[iArrayIndex];
}
return m_pValue[ iArrayIndex ];
}
template< typename Type, bool IS_ARRAY >
inline const Type& CInterpolatedVarArrayBase<Type, IS_ARRAY>::GetCurrent( int iArrayIndex ) const
{
Assert( m_pValue );
Assert( iArrayIndex >= 0 && iArrayIndex < m_nMaxCount );
if ( m_VarHistory.Count() > 0 )
{
return m_VarHistory[0].GetValue()[iArrayIndex];
}
return m_pValue[ iArrayIndex ];
}
template< typename Type, bool IS_ARRAY >
inline float CInterpolatedVarArrayBase<Type, IS_ARRAY>::GetInterval() const
{
if ( m_VarHistory.Count() > 1 )
{
return m_VarHistory[0].changetime - m_VarHistory[1].changetime;
}
return 0.0f;
}
template< typename Type, bool IS_ARRAY >
inline bool CInterpolatedVarArrayBase<Type, IS_ARRAY>::IsValidIndex( int i )
{
return m_VarHistory.IsValidIndex( i );
}
template< typename Type, bool IS_ARRAY >
inline Type *CInterpolatedVarArrayBase<Type, IS_ARRAY>::GetHistoryValue( int index, float& changetime, int iArrayIndex )
{
Assert( iArrayIndex >= 0 && iArrayIndex < m_nMaxCount );
if ( m_VarHistory.IsIdxValid(index) )
{
CInterpolatedVarEntry *entry = &m_VarHistory[ index ];
changetime = entry->changetime;
return &entry->GetValue()[ iArrayIndex ];
}
else
{
changetime = 0.0f;
return NULL;
}
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::SetHistoryValuesForItem( int item, Type& value )
{
Assert( item >= 0 && item < m_nMaxCount );
for ( int i = 0; i < m_VarHistory.Count(); i++ )
{
CInterpolatedVarEntry *entry = &m_VarHistory[ i ];
entry->GetValue()[ item ] = value;
}
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::SetLooping( bool looping, int iArrayIndex )
{
Assert( iArrayIndex >= 0 && iArrayIndex < m_nMaxCount );
m_bLooping[ iArrayIndex ] = looping;
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::SetMaxCount( int newmax )
{
bool changed = ( newmax != m_nMaxCount ) ? true : false;
// BUGBUG: Support 0 length properly?
newmax = MAX(1,newmax);
m_nMaxCount = newmax;
// Wipe everything any time this changes!!!
if ( changed )
{
delete [] m_bLooping;
delete [] m_LastNetworkedValue;
m_bLooping = new byte[m_nMaxCount];
m_LastNetworkedValue = new Type[m_nMaxCount];
memset( m_bLooping, 0, sizeof(byte) * m_nMaxCount);
memset( m_LastNetworkedValue, 0, sizeof(Type) * m_nMaxCount);
Reset();
}
}
template< typename Type, bool IS_ARRAY >
inline int CInterpolatedVarArrayBase<Type, IS_ARRAY>::GetMaxCount() const
{
return m_nMaxCount;
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::_Interpolate( Type *out, float frac, CInterpolatedVarEntry *start, CInterpolatedVarEntry *end )
{
Assert( start );
Assert( end );
if ( start == end )
{
// quick exit
for ( int i = 0; i < m_nMaxCount; i++ )
{
out[i] = end->GetValue()[i];
Lerp_Clamp( out[i] );
}
return;
}
Assert( frac >= 0.0f && frac <= 1.0f );
// Note that QAngle has a specialization that will do quaternion interpolation here...
for ( int i = 0; i < m_nMaxCount; i++ )
{
if ( m_bLooping[ i ] )
{
out[i] = LoopingLerp( frac, start->GetValue()[i], end->GetValue()[i] );
}
else
{
out[i] = Lerp( frac, start->GetValue()[i], end->GetValue()[i] );
}
Lerp_Clamp( out[i] );
}
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::_Extrapolate(
Type *pOut,
CInterpolatedVarEntry *pOld,
CInterpolatedVarEntry *pNew,
float flDestinationTime,
float flMaxExtrapolationAmount
)
{
if ( fabs( pOld->changetime - pNew->changetime ) < 0.001f || flDestinationTime <= pNew->changetime )
{
for ( int i=0; i < m_nMaxCount; i++ )
pOut[i] = pNew->GetValue()[i];
}
else
{
float flExtrapolationAmount = MIN( flDestinationTime - pNew->changetime, flMaxExtrapolationAmount );
float divisor = 1.0f / (pNew->changetime - pOld->changetime);
for ( int i=0; i < m_nMaxCount; i++ )
{
pOut[i] = ExtrapolateInterpolatedVarType( pOld->GetValue()[i], pNew->GetValue()[i], divisor, flExtrapolationAmount );
}
}
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::TimeFixup2_Hermite(
typename CInterpolatedVarArrayBase<Type, IS_ARRAY>::CInterpolatedVarEntry &fixup,
typename CInterpolatedVarArrayBase<Type, IS_ARRAY>::CInterpolatedVarEntry*& prev,
typename CInterpolatedVarArrayBase<Type, IS_ARRAY>::CInterpolatedVarEntry*& start,
float dt1
)
{
float dt2 = start->changetime - prev->changetime;
// If times are not of the same interval renormalize the earlier sample to allow for uniform hermite spline interpolation
if ( fabs( dt1 - dt2 ) > 0.0001f &&
dt2 > 0.0001f )
{
// Renormalize
float frac = dt1 / dt2;
// Fixed interval into past
fixup.changetime = start->changetime - dt1;
for ( int i = 0; i < m_nMaxCount; i++ )
{
if ( m_bLooping[i] )
{
fixup.GetValue()[i] = LoopingLerp( 1-frac, prev->GetValue()[i], start->GetValue()[i] );
}
else
{
fixup.GetValue()[i] = Lerp( 1-frac, prev->GetValue()[i], start->GetValue()[i] );
}
}
// Point previous sample at fixed version
prev = &fixup;
}
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::TimeFixup_Hermite(
typename CInterpolatedVarArrayBase<Type, IS_ARRAY>::CInterpolatedVarEntry &fixup,
typename CInterpolatedVarArrayBase<Type, IS_ARRAY>::CInterpolatedVarEntry*& prev,
typename CInterpolatedVarArrayBase<Type, IS_ARRAY>::CInterpolatedVarEntry*& start,
typename CInterpolatedVarArrayBase<Type, IS_ARRAY>::CInterpolatedVarEntry*& end )
{
TimeFixup2_Hermite( fixup, prev, start, end->changetime - start->changetime );
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::_Interpolate_Hermite(
Type *out,
float frac,
CInterpolatedVarEntry *prev,
CInterpolatedVarEntry *start,
CInterpolatedVarEntry *end,
bool looping )
{
Assert( start );
Assert( end );
// Disable range checks because we can produce weird values here and it's not an error.
// After interpolation, we will clamp the values.
CDisableRangeChecks disableRangeChecks;
CInterpolatedVarEntry fixup;
fixup.Init(m_nMaxCount);
TimeFixup_Hermite( fixup, prev, start, end );
for( int i = 0; i < m_nMaxCount; i++ )
{
// Note that QAngle has a specialization that will do quaternion interpolation here...
if ( m_bLooping[ i ] )
{
out[ i ] = LoopingLerp_Hermite( frac, prev->GetValue()[i], start->GetValue()[i], end->GetValue()[i] );
}
else
{
out[ i ] = Lerp_Hermite( frac, prev->GetValue()[i], start->GetValue()[i], end->GetValue()[i] );
}
// Clamp the output from interpolation. There are edge cases where something like m_flCycle
// can get set to a really high or low value when we set it to zero after a really small
// time interval (the hermite blender will think it's got a really high velocity and
// skyrocket it off into la-la land).
Lerp_Clamp( out[i] );
}
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::_Derivative_Hermite(
Type *out,
float frac,
CInterpolatedVarEntry *prev,
CInterpolatedVarEntry *start,
CInterpolatedVarEntry *end )
{
Assert( start );
Assert( end );
// Disable range checks because we can produce weird values here and it's not an error.
// After interpolation, we will clamp the values.
CDisableRangeChecks disableRangeChecks;
CInterpolatedVarEntry fixup;
fixup.value = (Type*)_alloca( sizeof(Type) * m_nMaxCount );
TimeFixup_Hermite( fixup, prev, start, end );
float divisor = 1.0f / (end->changetime - start->changetime);
for( int i = 0; i < m_nMaxCount; i++ )
{
Assert( !m_bLooping[ i ] );
out[i] = Derivative_Hermite( frac, prev->GetValue()[i], start->GetValue()[i], end->GetValue()[i] );
out[i] *= divisor;
}
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::_Derivative_Hermite_SmoothVelocity(
Type *out,
float frac,
CInterpolatedVarEntry *b,
CInterpolatedVarEntry *c,
CInterpolatedVarEntry *d )
{
CInterpolatedVarEntry fixup;
fixup.Init(m_nMaxCount);
TimeFixup_Hermite( fixup, b, c, d );
for ( int i=0; i < m_nMaxCount; i++ )
{
Type prevVel = (c->GetValue()[i] - b->GetValue()[i]) / (c->changetime - b->changetime);
Type curVel = (d->GetValue()[i] - c->GetValue()[i]) / (d->changetime - c->changetime);
out[i] = Lerp( frac, prevVel, curVel );
}
}
template< typename Type, bool IS_ARRAY >
inline void CInterpolatedVarArrayBase<Type, IS_ARRAY>::_Derivative_Linear(
Type *out,
CInterpolatedVarEntry *start,
CInterpolatedVarEntry *end )
{
if ( start == end || fabs( start->changetime - end->changetime ) < 0.0001f )
{
for( int i = 0; i < m_nMaxCount; i++ )
{
out[ i ] = start->GetValue()[i] * 0;
}
}
else
{
float divisor = 1.0f / (end->changetime - start->changetime);
for( int i = 0; i < m_nMaxCount; i++ )
{
out[ i ] = (end->GetValue()[i] - start->GetValue()[i]) * divisor;
}
}
}
template< typename Type, bool IS_ARRAY >
inline bool CInterpolatedVarArrayBase<Type, IS_ARRAY>::ValidOrder()
{
float newestchangetime = 0.0f;
bool first = true;
for ( int i = 0; i < m_VarHistory.Count(); i++ )
{
CInterpolatedVarEntry *entry = &m_VarHistory[ i ];
if ( first )
{
first = false;
newestchangetime = entry->changetime;
continue;
}
// They should get older as wel walk backwards
if ( entry->changetime > newestchangetime )
{
Assert( 0 );
return false;
}
newestchangetime = entry->changetime;
}
return true;
}
template< typename Type, int COUNT >
class CInterpolatedVarArray : public CInterpolatedVarArrayBase<Type, true >
{
public:
CInterpolatedVarArray( const char *pDebugName = "no debug name" )
: CInterpolatedVarArrayBase<Type, true>( pDebugName )
{
this->SetMaxCount( COUNT );
}
};
// -------------------------------------------------------------------------------------------------------------- //
// CInterpolatedVar.
// -------------------------------------------------------------------------------------------------------------- //
template< typename Type >
class CInterpolatedVar : public CInterpolatedVarArrayBase< Type, false >
{
public:
CInterpolatedVar( const char *pDebugName = NULL )
: CInterpolatedVarArrayBase< Type, false >(pDebugName)
{
this->SetMaxCount( 1 );
}
};
#include "tier0/memdbgoff.h"
#endif // INTERPOLATEDVAR_H
|