VGearsTriggersFile.h

Go to the documentation of this file.

/*
 * Copyright (C) 2022 The V-Gears Team
 *
 * This file is part of V-Gears
 *
 * V-Gears is free software: you can redistribute it and/or modify it under
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, version 3.0 (GPLv3) of the License.
 *
 * V-Gears is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 */
 
#pragma once
 
#include <memory>
#include <array>
#include <OgreResourceManager.h>
#include "VGearsPrerequisites.h"
#include "common/VGearsResource.h"
#include "VGearsSerializer.h"
 
namespace VGears{
 
    class TriggersFileManager :
      public Ogre::ResourceManager, public Ogre::Singleton<TriggersFileManager>
    {
 
        // TODO: Move this to it's own file?
 
        public:
 
            TriggersFileManager();
 
            virtual ~TriggersFileManager();
 
            static TriggersFileManager& GetSingleton();
 
            static TriggersFileManager* GetSingletonPtr();
 
        protected:
 
            Ogre::Resource *createImpl(
              const Ogre::String &name, Ogre::ResourceHandle handle, const Ogre::String &group,
              bool is_manual, Ogre::ManualResourceLoader *loader,
              const Ogre::NameValuePairList *create_params
            );
    };
 
    class TriggersFile : public Resource{
 
        public:
 
            TriggersFile(
              Ogre::ResourceManager* creator, const String &name, Ogre::ResourceHandle handle,
              const String& group, bool is_manual = false,
              Ogre::ManualResourceLoader* loader = nullptr
            );
 
            virtual ~TriggersFile();
 
            static const String RESOURCE_TYPE;
 
            struct Range{
 
                s16 left;
 
                s16 top;
 
                s16 right;
 
                s16 bottom;
            };
 
            struct TriggerVertex{
 
                s16 x;
 
                s16 y;
 
                s16 z;
            };
 
            struct Gateway{
 
                std::array<TriggerVertex, 2> exit_line;
 
                TriggerVertex destination;
 
                u16 destination_field_id;
 
                u8 dir;
 
                u8 dir_copy1;
 
                u8 dir_copy2;
 
                u8 dir_copy3;
            };
 
            struct Trigger{
 
                std::array<TriggerVertex, 2> trigger_line;
 
                u8 background_parameter;
 
                u8 background_state;
 
                u8 behavior;
 
                u8 sound_id;
            };
 
            struct Arrow{
 
                s32 x;
 
                s32 z;
 
                s32 y;
 
                u32 type;
            };
 
            struct TriggerData{
 
                std::array<char, 9> name;
 
                u8 control;
 
                s16 camera_focus_height;
 
                Range camera_range;
 
                u8 bg_layer1_flag;
 
                u8 bg_layer2_flag;
 
                u8 bg_layer3_flag;
 
                u8 bg_layer4_flag;
 
                s16 bg_layer3_width;
 
                s16 bg_layer3_height;
 
                s16 bg_layer4_width;
 
                s16 bg_layer4_height;
 
                std::array<u8, 24> unknown;
 
                std::array<Gateway, 12> doors;
 
                std::array<Trigger, 12> triggers;
 
                std::array<u8, 12> display_arrow;
 
                std::array<Arrow, 12> arrows;
            };
 
 
            const Range& GetCameraRange() const{return trigger_data_->camera_range;}
 
            float MovementRotation() const{
                return 180.0f * (static_cast<float>(trigger_data_->control) - 128.0f) / 128.0f;
            }
 
            const std::array<Gateway, 12>& GetGateways() const{return trigger_data_->doors;}
 
        protected:
 
            virtual void loadImpl() override;
 
            virtual void unloadImpl() override;
 
            virtual size_t calculateSize(void) const override;
 
        private:
 
            std::unique_ptr<TriggerData> trigger_data_;
 
            friend class TriggerFileSerializer;
    };
    
    class TriggerFileSerializer : public Serializer{
 
        // TODO Move this to it's own file.
 
        public:
 
            TriggerFileSerializer();
 
            void ImportTriggerFile(Ogre::DataStreamPtr &stream, TriggersFile *dest);
 
        private:
 
            void ReadTriggerVertex(
              Ogre::DataStreamPtr& stream, TriggersFile::TriggerVertex& vertex
            );
 
            void ReadRange(Ogre::DataStreamPtr& stream, TriggersFile::Range& range);
 
            void ReadGateway(Ogre::DataStreamPtr& stream, TriggersFile::Gateway& exit);
 
            void ReadArrow(Ogre::DataStreamPtr& stream, TriggersFile::Arrow& arrow);
 
            void ReadTrigger(Ogre::DataStreamPtr& stream, TriggersFile::Trigger& trigger);
    };
 
    typedef Ogre::SharedPtr<TriggersFile> TriggersFilePtr;
}