querydynamicoutput.h

Go to the documentation of this file.

/*
* Copyright 2016 Autodesk, Inc. All rights reserved.
* Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
* or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
*/

#pragma once

#include "gwnavruntime/querysystem/workingmemcontainers/workingmemarray.h"
#include "gwnavruntime/queries/utils/navtagsubsegment.h"
#include "gwnavruntime/queries/utils/costmultipliersubsegment.h"
#include "gwnavruntime/queries/utils/halfedgeintersection.h"
#include "gwnavruntime/navmesh/identifiers/navtriangleptr.h"
#include "gwnavruntime/spatialization/spatializedpoint.h"
#include "gwnavruntime/world/tagvolume.h"

namespace Kaim
{

enum DynamicOutputMode
{
    QUERY_SAVE_NOTHING                   = 0,      
    QUERY_SAVE_FLOORS                    = 1 << 1, 
    QUERY_SAVE_TRIANGLES                 = 1 << 2, 
    QUERY_SAVE_NAVTAGSUBSEGMENTS         = 1 << 3, 
    QUERY_SAVE_HALFEDGEINTERSECTIONS     = 1 << 4, 
    QUERY_SAVE_COSTMULTIPLIERSUBSEGMENTS = 1 << 5, 
    QUERY_SAVE_SPATIALIZEDPOINTS         = 1 << 6, 
    QUERY_SAVE_TAGVOLUMES                = 1 << 7, 
    QUERY_SAVE_TRIANGLES_AND_SUBSEGMENTS = QUERY_SAVE_TRIANGLES | QUERY_SAVE_NAVTAGSUBSEGMENTS, 
};

class WorkingMemory;

template <class T>
class QueryOutputBuffer_Impl
{
public:
    QueryOutputBuffer_Impl() : m_buffer(nullptr), m_count(0) {}

    void ClearBuffer();
    void InitBuffer(KyUInt32 count, char*& memory);

    KyUInt32 GetCount() const { return m_count; }

    const T& Get(KyUInt32 index) const { KY_ASSERT(index < m_count); return m_buffer[index]; }
          T& Get(KyUInt32 index)       { KY_ASSERT(index < m_count); return m_buffer[index]; }

    void Set(KyUInt32 index, const T& object) { KY_ASSERT(index < m_count); m_buffer[index] = object; }

    T* m_buffer;
    KyUInt32 m_count;
};

class QueryDynamicOutput
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_QueryOutput)
public:
    class Config
    {
    public:
        Config();
        bool IsZero() const;
    public:
        KyUInt32 m_floorCount;
        KyUInt32 m_triangleCount;
        KyUInt32 m_navTagSubSegmentCount;
        KyUInt32 m_costMultiplierSubSegmentCount;
        KyUInt32 m_halfEdgeIntersectionCount;
        KyUInt32 m_spatializedPointCount;
        KyUInt32 m_tagVolumeCount;
    };

    QueryDynamicOutput() : m_byteSize(0), RefCount(1) {}

    // ------------------------------ Getters -----------------------------

    KyUInt32 GetNavFloorPtrCount()              const { return m_navFloorPtrs.GetCount();          }
    KyUInt32 GetNavTrianglePtrCount()           const { return m_navTrianglePtrs.GetCount();       }
    KyUInt32 GetNavTagSubSegmentCount()         const { return m_navTagSubSegments.GetCount();     }
    KyUInt32 GetCostMultiplierSubSegmentCount() const { return m_costMultSubSegments.GetCount();   }
    KyUInt32 GetHalfEdgeIntersectionCount()     const { return m_halfEgdeIntersections.GetCount(); }
    KyUInt32 GetSpatializedPointCount()         const { return m_spatializedPoints.GetCount();     }
    KyUInt32 GetTagVolumeCount()                const { return m_tagVolumes.GetCount();            }

    const NavFloorPtr&              GetNavFloorPtr(KyUInt32 idx)              const { return m_navFloorPtrs.Get(idx);          }
          NavFloorPtr&              GetNavFloorPtr(KyUInt32 idx)                    { return m_navFloorPtrs.Get(idx);          }

    const NavTrianglePtr&           GetNavTrianglePtr(KyUInt32 idx)           const { return m_navTrianglePtrs.Get(idx);       }
          NavTrianglePtr&           GetNavTrianglePtr(KyUInt32 idx)                 { return m_navTrianglePtrs.Get(idx);       }

    const NavTagSubSegment&         GetNavTagSubSegment(KyUInt32 idx)         const { return m_navTagSubSegments.Get(idx);     }
          NavTagSubSegment&         GetNavTagSubSegment(KyUInt32 idx)               { return m_navTagSubSegments.Get(idx);     }

    const CostMultiplierSubSegment& GetCostMultiplierSubSegment(KyUInt32 idx) const { return m_costMultSubSegments.Get(idx);   }
          CostMultiplierSubSegment& GetCostMultiplierSubSegment(KyUInt32 idx)       { return m_costMultSubSegments.Get(idx);   }

    const HalfEdgeIntersection&     GetHalfEdgeIntersection(KyUInt32 idx)     const { return m_halfEgdeIntersections.Get(idx); }
          HalfEdgeIntersection&     GetHalfEdgeIntersection(KyUInt32 idx)           { return m_halfEgdeIntersections.Get(idx); }

    const Ptr<SpatializedPoint>&    GetSpatializedPoint(KyUInt32 idx)         const { return m_spatializedPoints.Get(idx);     }
          Ptr<SpatializedPoint>&    GetSpatializedPoint(KyUInt32 idx)               { return m_spatializedPoints.Get(idx);     }

    const Ptr<TagVolume>&           GetTagVolume(KyUInt32 idx)                const { return m_tagVolumes.Get(idx);            }
          Ptr<TagVolume>&           GetTagVolume(KyUInt32 idx)                      { return m_tagVolumes.Get(idx);            }

public: // internal
    void SetNavFloorPtr(KyUInt32 idx, const NavFloorPtr& navFloorPtr)                                  { m_navFloorPtrs.Set(idx, navFloorPtr);                   }
    void SetNavTrianglePtr(KyUInt32 idx, const NavTrianglePtr& navTrianglePtr)                         { m_navTrianglePtrs.Set(idx, navTrianglePtr);             }
    void SetNavTagSubSegment(KyUInt32 idx, const NavTagSubSegment& navTagSubSegment)                   { m_navTagSubSegments.Set(idx, navTagSubSegment);         }
    void SetCostMultiplierSubSegment(KyUInt32 idx, const CostMultiplierSubSegment& costMultSubSegment) { m_costMultSubSegments.Set(idx, costMultSubSegment);     }
    void SetHalfEdgeIntersection(KyUInt32 idx, const HalfEdgeIntersection& halfEdgeIntersection)       { m_halfEgdeIntersections.Set(idx, halfEdgeIntersection); }
    void SetSpatializedPoint(KyUInt32 idx, const Ptr<SpatializedPoint>& spatializedPoint)              { m_spatializedPoints.Set(idx, spatializedPoint);         }
    void SetTagVolume(KyUInt32 idx, const Ptr<TagVolume>& tagVolume)                                   { m_tagVolumes.Set(idx, tagVolume);                       }

    static KyUInt32 ComputeByteSize(const Config& config);
    static Ptr<QueryDynamicOutput> Create(const Config& config);

    void ClearBuffers();
    bool IsEnoughMemoryForStoringDynamicOutput(const Config& config) { return ComputeByteSize(config) <= m_byteSize; }
    void InitBuffers( const Config& config);

    bool IsEmpty() const;

private:
    QueryOutputBuffer_Impl<NavFloorPtr             > m_navFloorPtrs;
    QueryOutputBuffer_Impl<NavTrianglePtr          > m_navTrianglePtrs;
    QueryOutputBuffer_Impl<NavTagSubSegment        > m_navTagSubSegments;
    QueryOutputBuffer_Impl<HalfEdgeIntersection    > m_halfEgdeIntersections;
    QueryOutputBuffer_Impl<CostMultiplierSubSegment> m_costMultSubSegments;
    QueryOutputBuffer_Impl<Ptr<SpatializedPoint>   > m_spatializedPoints;
    QueryOutputBuffer_Impl<Ptr<TagVolume>          > m_tagVolumes;

    KyUInt32 m_byteSize;
    KyUInt32 RefCount; // consider thread-safetyness here with mutable std::atomic<int> RefCount;

public: // internal
    // Lifetime - separate implementation due to Create function
    KY_INLINE void AddRef() { RefCount ++; }

    KY_INLINE void Release()
    {
        if (RefCount-- == 1)
        {
            ClearBuffers();
            KY_FREE(this);
        }
    }

    // Debug method only.
    int GetRefCount() const { return RefCount; }
};

class ScopedDynamicOutput
{
public:
    ScopedDynamicOutput(Ptr<QueryDynamicOutput>& dynamicOutput) : m_queryDynamicOutput(&dynamicOutput) {}

    ~ScopedDynamicOutput() { CopyCrossedDataIntoDynamicOutput(); }

    KyResult Init(WorkingMemory* workingMemory, DynamicOutputMode outputMode);

private:
    void CopyCrossedDataIntoDynamicOutput();
    Ptr<QueryDynamicOutput>* m_queryDynamicOutput;

public: // internal
    WorkingMemArray<NavFloorRawPtr> m_navFloorRawPtrs;
    WorkingMemArray<NavTriangleRawPtr> m_navTriangleRawPtrs;
    WorkingMemArray<RawNavTagSubSegment> m_rawNavTagSubSegments;
    WorkingMemArray<CostMultiplierSubSegment> m_costMultiplierSubSegments;
    WorkingMemArray<RawHalfEdgeIntersection> m_rawHalfEdgeIntersections;
    WorkingMemArray<SpatializedPoint*> m_spatializedPoints;
    WorkingMemArray<TagVolume*> m_tagVolumes;
};

} // namespace Kaim


#include "gwnavruntime/queries/querydynamicoutput.inl"