latest sources commit

src/common/Collision/Management/IVMapMgr.h

@@ -0,0 +1,134 @@
+/*
+ * This file is part of the AzerothCore Project. See AUTHORS file for Copyright information
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as published by the
+ * Free Software Foundation; either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * This program 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 Affero General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef _IVMAPMANAGER_H
+#define _IVMAPMANAGER_H
+
+#include "Define.h"
+#include "ModelIgnoreFlags.h"
+#include "Optional.h"
+#include <string>
+
+//===========================================================
+
+/**
+This is the minimum interface to the VMapMamager.
+*/
+
+namespace VMAP
+{
+    enum VMAP_LOAD_RESULT
+    {
+        VMAP_LOAD_RESULT_ERROR,
+        VMAP_LOAD_RESULT_OK,
+        VMAP_LOAD_RESULT_IGNORED
+    };
+
+    enum class LoadResult : uint8
+    {
+        Success,
+        FileNotFound,
+        VersionMismatch
+    };
+
+    #define VMAP_INVALID_HEIGHT       -100000.0f            // for check
+    #define VMAP_INVALID_HEIGHT_VALUE -200000.0f            // real assigned value in unknown height case
+
+    struct AreaAndLiquidData
+    {
+        struct AreaInfo
+        {
+            AreaInfo(int32 _adtId, int32 _rootId, int32 _groupId, uint32 _flags)
+                : adtId(_adtId), rootId(_rootId), groupId(_groupId), mogpFlags(_flags) { }
+            int32 const  adtId;
+            int32 const  rootId;
+            int32 const  groupId;
+            uint32 const mogpFlags;
+        };
+
+        struct LiquidInfo
+        {
+            LiquidInfo(uint32 _type, float _level)
+                : type(_type), level(_level) {}
+            uint32 const type;
+            float const  level;
+        };
+
+        float                floorZ = VMAP_INVALID_HEIGHT;
+        Optional<AreaInfo>   areaInfo;
+        Optional<LiquidInfo> liquidInfo;
+    };
+
+    //===========================================================
+    class IVMapMgr
+    {
+    private:
+        bool iEnableLineOfSightCalc{true};
+        bool iEnableHeightCalc{true};
+
+    public:
+        IVMapMgr()  { }
+
+        virtual ~IVMapMgr() = default;
+
+        virtual int loadMap(const char* pBasePath, unsigned int pMapId, int x, int y) = 0;
+
+        virtual LoadResult existsMap(const char* pBasePath, unsigned int pMapId, int x, int y) = 0;
+
+        virtual void unloadMap(unsigned int pMapId, int x, int y) = 0;
+        virtual void unloadMap(unsigned int pMapId) = 0;
+
+        virtual bool isInLineOfSight(unsigned int pMapId, float x1, float y1, float z1, float x2, float y2, float z2, ModelIgnoreFlags ignoreFlags) = 0;
+        virtual float getHeight(unsigned int pMapId, float x, float y, float z, float maxSearchDist) = 0;
+        /**
+        test if we hit an object. return true if we hit one. rx, ry, rz will hold the hit position or the dest position, if no intersection was found
+        return a position, that is pReduceDist closer to the origin
+        */
+        virtual bool GetObjectHitPos(unsigned int pMapId, float x1, float y1, float z1, float x2, float y2, float z2, float& rx, float& ry, float& rz, float pModifyDist) = 0;
+        /**
+        send debug commands
+        */
+        virtual bool processCommand(char* pCommand) = 0;
+
+        /**
+        Enable/disable LOS calculation
+        It is enabled by default. If it is enabled in mid game the maps have to loaded manualy
+        */
+        void setEnableLineOfSightCalc(bool pVal) { iEnableLineOfSightCalc = pVal; }
+        /**
+        Enable/disable model height calculation
+        It is enabled by default. If it is enabled in mid game the maps have to loaded manualy
+        */
+        void setEnableHeightCalc(bool pVal) { iEnableHeightCalc = pVal; }
+
+        [[nodiscard]] bool isLineOfSightCalcEnabled() const { return (iEnableLineOfSightCalc); }
+        [[nodiscard]] bool isHeightCalcEnabled() const { return (iEnableHeightCalc); }
+        [[nodiscard]] bool isMapLoadingEnabled() const { return (iEnableLineOfSightCalc || iEnableHeightCalc  ); }
+
+        [[nodiscard]] virtual std::string getDirFileName(unsigned int pMapId, int x, int y) const = 0;
+        /**
+        Query world model area info.
+        \param z gets adjusted to the ground height for which this are info is valid
+        */
+        virtual bool GetAreaInfo(uint32 pMapId, float x, float y, float& z, uint32& flags, int32& adtId, int32& rootId, int32& groupId) const      = 0;
+        virtual bool GetLiquidLevel(uint32 pMapId, float x, float y, float z, uint8 ReqLiquidType, float& level, float& floor, uint32& type, uint32& mogpFlags) const = 0;
+        // get both area + liquid data in a single vmap lookup
+        virtual void GetAreaAndLiquidData(uint32 mapId, float x, float y, float z, uint8 reqLiquidType, AreaAndLiquidData& data) const = 0;
+    };
+}
+
+#endif