File: controller.hpp

package info (click to toggle)
openmw 0.49.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 33,992 kB
  • sloc: cpp: 372,479; xml: 2,149; sh: 1,403; python: 797; makefile: 26
file content (654 lines) | stat: -rw-r--r-- 17,940 bytes parent folder | download
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
#ifndef OPENMW_COMPONENTS_NIF_CONTROLLER_HPP
#define OPENMW_COMPONENTS_NIF_CONTROLLER_HPP

#include "base.hpp"
#include "niftypes.hpp"
#include "property.hpp"

namespace Nif
{

    struct ControlledBlock
    {
        std::string mTargetName;
        NiInterpolatorPtr mInterpolator;
        NiTimeControllerPtr mController;
        NiBlendInterpolatorPtr mBlendInterpolator;
        uint16_t mBlendIndex;
        uint8_t mPriority;
        NiStringPalettePtr mStringPalette;
        uint32_t mNodeNameOffset;
        uint32_t mPropertyTypeOffset;
        uint32_t mControllerTypeOffset;
        uint32_t mControllerIdOffset;
        uint32_t mInterpolatorIdOffset;
        std::string mNodeName;
        std::string mPropertyType;
        std::string mControllerType;
        std::string mControllerId;
        std::string mInterpolatorId;

        void read(NIFStream* nif);
        void post(Reader& nif);
    };

    // Gamebryo KF root node record type (pre-10.0)
    struct NiSequence : public Record
    {
        std::string mName;
        std::string mAccumRootName;
        ExtraPtr mTextKeys;
        uint32_t mArrayGrowBy;
        std::vector<ControlledBlock> mControlledBlocks;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    // Gamebryo KF root node record type (10.0+)
    struct NiControllerSequence : public NiSequence
    {
        float mWeight{ 1.f };
        NiTimeController::ExtrapolationMode mExtrapolationMode{ NiTimeController::ExtrapolationMode::Constant };
        float mFrequency{ 1.f };
        float mPhase{ 1.f };
        float mStartTime, mStopTime;
        bool mPlayBackwards{ false };
        NiControllerManagerPtr mManager;
        NiStringPalettePtr mStringPalette;
        BSAnimNotesList mAnimNotesList;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    // Base class for controllers that use NiInterpolators to animate objects.
    struct NiInterpController : public NiTimeController
    {
        // Usually one of the flags.
        bool mManagerControlled{ false };

        void read(NIFStream* nif) override;
    };

    // Base class for controllers that use one NiInterpolator.
    struct NiSingleInterpController : public NiInterpController
    {
        NiInterpolatorPtr mInterpolator;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    // Base class for controllers that use a NiFloatInterpolator to animate their target.
    struct NiFloatInterpController : public NiSingleInterpController
    {
    };

    // Ditto for NiBoolInterpolator.
    struct NiBoolInterpController : public NiSingleInterpController
    {
    };

    // Ditto for NiPoint3Interpolator.
    struct NiPoint3InterpController : public NiSingleInterpController
    {
    };

    struct NiParticleInfo
    {
        osg::Vec3f mVelocity;
        osg::Vec3f mRotationAxis;
        float mAge;
        float mLifespan;
        float mLastUpdate;
        uint16_t mSpawnGeneration;
        uint16_t mCode;

        void read(NIFStream* nif);
    };

    struct NiParticleSystemController : public NiTimeController
    {
        enum BSPArrayController
        {
            BSPArrayController_AtNode = 0x8,
            BSPArrayController_AtVertex = 0x10
        };

        enum EmitFlags
        {
            EmitFlag_NoAutoAdjust = 0x1 // If this flag is set, we use the emitRate value. Otherwise,
                                        // we calculate an emit rate so that the maximum number of particles
                                        // in the system (numParticles) is never exceeded.
        };

        float mSpeed;
        float mSpeedVariation;
        float mDeclination;
        float mDeclinationVariation;
        float mPlanarAngle;
        float mPlanarAngleVariation;
        osg::Vec3f mInitialNormal;
        osg::Vec4f mInitialColor;
        float mInitialSize;
        float mEmitStartTime;
        float mEmitStopTime;
        bool mResetParticleSystem{ false };
        float mBirthRate;
        float mLifetime;
        float mLifetimeVariation;
        uint16_t mEmitFlags{ 0 };
        osg::Vec3f mEmitterDimensions;
        NiAVObjectPtr mEmitter;
        uint16_t mNumSpawnGenerations;
        float mPercentageSpawned;
        uint16_t mSpawnMultiplier;
        float mSpawnSpeedChaos;
        float mSpawnDirChaos;
        uint16_t mNumParticles;
        uint16_t mNumValid;
        std::vector<NiParticleInfo> mParticles;
        NiParticleModifierPtr mModifier;
        NiParticleModifierPtr mCollider;
        uint8_t mStaticTargetBound;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;

        bool noAutoAdjust() const { return mEmitFlags & EmitFlag_NoAutoAdjust; }
        bool emitAtVertex() const { return mFlags & BSPArrayController_AtVertex; }
    };
    using NiBSPArrayController = NiParticleSystemController;

    struct NiLightColorController : public NiPoint3InterpController
    {
        enum class Mode
        {
            DiffuseSpecular = 0,
            Ambient = 1,
        };

        NiPosDataPtr mData;
        Mode mMode = Mode::DiffuseSpecular;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct NiMaterialColorController : public NiPoint3InterpController
    {
        enum class TargetColor
        {
            Ambient = 0,
            Diffuse = 1,
            Specular = 2,
            Emissive = 3,
        };

        NiPosDataPtr mData;
        TargetColor mTargetColor = TargetColor::Ambient;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct NiPathController : public NiTimeController
    {
        enum Flags
        {
            Flag_CVDataNeedsUpdate = 0x01,
            Flag_OpenCurve = 0x02,
            Flag_AllowFlip = 0x04,
            Flag_Bank = 0x08,
            Flag_ConstVelocity = 0x10,
            Flag_Follow = 0x20,
            Flag_FlipFollowAxis = 0x40,
        };

        uint16_t mPathFlags;
        int32_t mBankDirection;
        float mMaxBankAngle;
        float mSmoothing;
        uint16_t mFollowAxis;
        NiPosDataPtr mPathData;
        NiFloatDataPtr mPercentData;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct NiLookAtController : public NiTimeController
    {
        enum Flags
        {
            Flag_Flip = 0x1,
            Flag_LookYAxis = 0x2,
            Flag_LookZAxis = 0x4,
        };

        uint16_t mLookAtFlags{ 0 };
        NiAVObjectPtr mLookAt;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct NiUVController : public NiTimeController
    {
        NiUVDataPtr mData;
        uint16_t mUvSet;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct NiKeyframeController : public NiSingleInterpController
    {
        NiKeyframeDataPtr mData;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct NiMultiTargetTransformController : public NiInterpController
    {
        NiAVObjectList mExtraTargets;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct NiAlphaController : public NiFloatInterpController
    {
        NiFloatDataPtr mData;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct NiRollController : public NiSingleInterpController
    {
        NiFloatDataPtr mData;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct NiGeomMorpherController : public NiInterpController
    {
        bool mUpdateNormals{ false };
        bool mAlwaysActive{ false };
        NiMorphDataPtr mData;
        NiInterpolatorList mInterpolators;
        std::vector<float> mWeights;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct NiVisController : public NiBoolInterpController
    {
        NiVisDataPtr mData;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct NiFlipController : public NiFloatInterpController
    {
        NiTexturingProperty::TextureType mTexSlot;
        float mDelta; // Time between two flips. delta = (start_time - stop_time) / num_sources
        NiSourceTextureList mSources;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct NiTextureTransformController : public NiFloatInterpController
    {
        bool mShaderMap;
        NiTexturingProperty::TextureType mTexSlot;
        uint32_t mTransformMember;
        NiFloatDataPtr mData;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct NiBoneLODController : NiTimeController
    {
        struct SkinInfo
        {
            NiTriBasedGeomPtr mShape;
            NiSkinInstancePtr mSkin;
        };

        uint32_t mLOD;
        uint32_t mNumNodeGroups;
        std::vector<NiAVObjectList> mNodeGroups;
        std::vector<std::vector<SkinInfo>> mSkinnedShapeGroups;
        NiTriBasedGeomList mShapeGroups;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct bhkBlendController : public NiTimeController
    {
        void read(NIFStream* nif) override;
    };

    struct BSEffectShaderPropertyFloatController : public NiFloatInterpController
    {
        uint32_t mControlledVariable;

        void read(NIFStream* nif) override;
    };

    struct BSEffectShaderPropertyColorController : public NiPoint3InterpController
    {
        uint32_t mControlledColor;

        void read(NIFStream* nif) override;
    };

    struct BSKeyframeController : NiKeyframeController
    {
        NiKeyframeDataPtr mData2;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct BSLagBoneController : NiTimeController
    {
        float mLinearVelocity;
        float mLinearRotation;
        float mMaximumDistance;

        void read(NIFStream* nif) override;
    };

    struct BSProceduralLightningController : NiTimeController
    {
        NiInterpolatorPtr mGenerationInterp;
        NiInterpolatorPtr mMutationInterp;
        NiInterpolatorPtr mSubdivisionInterp;
        NiInterpolatorPtr mNumBranchesInterp;
        NiInterpolatorPtr mNumBranchesVarInterp;
        NiInterpolatorPtr mLengthInterp;
        NiInterpolatorPtr mLengthVarInterp;
        NiInterpolatorPtr mWidthInterp;
        NiInterpolatorPtr mArcOffsetInterp;
        uint16_t mSubdivisions;
        uint16_t mNumBranches;
        uint16_t mNumBranchesVar;
        float mLength;
        float mLengthVar;
        float mWidth;
        float mChildWidthMult;
        float mArcOffset;
        bool mFadeMainBolt;
        bool mFadeChildBolts;
        bool mAnimateArcOffset;
        BSShaderPropertyPtr mShaderProperty;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct NiControllerManager : public NiTimeController
    {
        bool mCumulative;
        NiControllerSequenceList mSequences;
        NiDefaultAVObjectPalettePtr mObjectPalette;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    // Abstract
    struct NiExtraDataController : NiSingleInterpController
    {
        std::string mExtraDataName;

        void read(NIFStream* nif) override;
    };

    struct NiFloatExtraDataController : NiExtraDataController
    {
        NiFloatDataPtr mData;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct NiFloatsExtraDataController : NiExtraDataController
    {
        int32_t mFloatsExtraDataIndex;
        NiFloatDataPtr mData;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct NiFloatsExtraDataPoint3Controller : NiExtraDataController
    {
        int32_t mFloatsExtraDataIndex;

        void read(NIFStream* nif) override;
    };

    // Abstract
    struct NiInterpolator : public Record
    {
    };

    template <class T, class DataPtr>
    struct TypedNiInterpolator : public NiInterpolator
    {
        T mDefaultValue;
        DataPtr mData;

        void read(NIFStream* nif) override
        {
            nif->read(mDefaultValue);
            mData.read(nif);
        }

        void post(Reader& nif) override { mData.post(nif); }
    };

    using NiPoint3Interpolator = TypedNiInterpolator<osg::Vec3f, NiPosDataPtr>;
    using NiBoolInterpolator = TypedNiInterpolator<bool, NiBoolDataPtr>;
    using NiFloatInterpolator = TypedNiInterpolator<float, NiFloatDataPtr>;
    using NiTransformInterpolator = TypedNiInterpolator<NiQuatTransform, NiKeyframeDataPtr>;
    using NiColorInterpolator = TypedNiInterpolator<osg::Vec4f, NiColorDataPtr>;

    struct NiPathInterpolator : public NiInterpolator
    {
        // Uses the same flags as NiPathController
        uint16_t mFlags;
        int32_t mBankDirection;
        float mMaxBankAngle;
        float mSmoothing;
        uint16_t mFollowAxis;
        NiPosDataPtr mPathData;
        NiFloatDataPtr mPercentData;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    struct NiLookAtInterpolator : NiInterpolator
    {
        // Uses the same flags as NiLookAtController
        uint16_t mLookAtFlags{ 0 };
        NiAVObjectPtr mLookAt;
        std::string mLookAtName;
        NiQuatTransform mTransform;
        NiInterpolatorPtr mTranslation;
        NiInterpolatorPtr mRoll;
        NiInterpolatorPtr mScale;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    // Abstract
    struct NiBlendInterpolator : public NiInterpolator
    {
        enum Flags
        {
            Flag_ManagerControlled = 0x1,
            Flag_OnlyUseHighestWeight = 0x2,
        };

        struct Item
        {
            NiInterpolatorPtr mInterpolator;
            float mWeight, mNormalizedWeight;
            int32_t mPriority;
            float mEaseSpinner;

            void read(NIFStream* nif);
            void post(Reader& nif);
        };

        uint8_t mFlags{ 0 };
        uint16_t mArrayGrowBy{ 0 };
        float mWeightThreshold;
        uint16_t mInterpCount;
        uint16_t mSingleIndex;
        int32_t mHighPriority, mNextHighPriority;
        float mSingleTime;
        float mHighWeightsSum, mNextHighWeightsSum;
        float mHighEaseSpinner;
        std::vector<Item> mItems;
        NiInterpolatorPtr mSingleInterpolator;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    template <typename T>
    struct TypedNiBlendInterpolator : public NiBlendInterpolator
    {
        T mValue;

        void read(NIFStream* nif) override
        {
            NiBlendInterpolator::read(nif);

            nif->read(mValue);
        }
    };

    template <>
    struct TypedNiBlendInterpolator<NiQuatTransform> : public NiBlendInterpolator
    {
        NiQuatTransform mValue;

        void read(NIFStream* nif) override
        {
            NiBlendInterpolator::read(nif);

            if (nif->getVersion() <= NIFStream::generateVersion(10, 1, 0, 109))
                nif->read(mValue);
        }
    };

    using NiBlendBoolInterpolator = TypedNiBlendInterpolator<uint8_t>;
    using NiBlendFloatInterpolator = TypedNiBlendInterpolator<float>;
    using NiBlendPoint3Interpolator = TypedNiBlendInterpolator<osg::Vec3f>;
    using NiBlendTransformInterpolator = TypedNiBlendInterpolator<NiQuatTransform>;

    // Abstract
    struct NiBSplineInterpolator : public NiInterpolator
    {
        float mStartTime;
        float mStopTime;
        NiBSplineDataPtr mSplineData;
        NiBSplineBasisDataPtr mBasisData;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

    // Abstract
    struct NiBSplineFloatInterpolator : public NiBSplineInterpolator
    {
        float mValue;
        uint32_t mHandle;

        void read(NIFStream* nif) override;
    };

    struct NiBSplineCompFloatInterpolator : public NiBSplineFloatInterpolator
    {
        float mOffset;
        float mHalfRange;

        void read(NIFStream* nif) override;
    };

    // Abstract
    struct NiBSplinePoint3Interpolator : public NiBSplineInterpolator
    {
        osg::Vec3f mValue;
        uint32_t mHandle;

        void read(NIFStream* nif) override;
    };

    struct NiBSplineCompPoint3Interpolator : public NiBSplinePoint3Interpolator
    {
        float mOffset;
        float mHalfRange;

        void read(NIFStream* nif) override;
    };

    struct NiBSplineTransformInterpolator : public NiBSplineInterpolator
    {
        NiQuatTransform mValue;
        uint32_t mTranslationHandle;
        uint32_t mRotationHandle;
        uint32_t mScaleHandle;

        void read(NIFStream* nif) override;
    };

    struct NiBSplineCompTransformInterpolator : public NiBSplineTransformInterpolator
    {
        float mTranslationOffset;
        float mTranslationHalfRange;
        float mRotationOffset;
        float mRotationHalfRange;
        float mScaleOffset;
        float mScaleHalfRange;

        void read(NIFStream* nif) override;
    };

    struct BSTreadTransform
    {
        std::string mName;
        NiQuatTransform mTransform1;
        NiQuatTransform mTransform2;

        void read(NIFStream* nif);
    };

    struct BSTreadTransfInterpolator : public NiInterpolator
    {
        std::vector<BSTreadTransform> mTransforms;
        NiFloatDataPtr mData;

        void read(NIFStream* nif) override;
        void post(Reader& nif) override;
    };

}
#endif