OpenMW/components/nif/base.hpp

/// This file holds the main classes of NIF Records used by everything else.
#ifndef OPENMW_COMPONENTS_NIF_BASE_HPP
#define OPENMW_COMPONENTS_NIF_BASE_HPP

#include "recordptr.hpp"

namespace Nif
{
    struct File;
    struct Record;
    struct Stream;

    // An extra data record. All the extra data connected to an object form a linked list.
    struct Extra : public Record
    {
        std::string mName;
        ExtraPtr mNext; // Next extra data record in the list
        uint32_t mRecordSize{ 0u };

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

    struct Controller : public Record
    {
        enum Flags
        {
            Flag_Active = 0x8
        };

        enum ExtrapolationMode
        {
            Cycle = 0,
            Reverse = 2,
            Constant = 4,
            Mask = 6
        };

        ControllerPtr next;
        int flags;
        float frequency, phase;
        float timeStart, timeStop;
        NiObjectNETPtr target;

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

        bool isActive() const { return flags & Flag_Active; }
        ExtrapolationMode extrapolationMode() const { return static_cast<ExtrapolationMode>(flags & Mask); }
    };

    /// Abstract object that has a name, extra data and controllers
    struct NiObjectNET : public Record
    {
        std::string mName;
        ExtraPtr mExtra;
        ExtraList mExtraList;
        ControllerPtr mController;

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

        // Collect extra records attached to the object
        ExtraList getExtraList() const;
    };

}
#endif