querydynamicoutput.h

Go to the documentation of this file.

/*
* Copyright 2015 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.
*/


// Primary contact: JUBA - secondary contact: NOBODY
#ifndef Navigation_QueryDynamicOutput_H
#define Navigation_QueryDynamicOutput_H

#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(KY_NULL), m_count(0) {}
    void ClearBuffer();
    void InitBuffer(KyUInt32 count, char*& memory);
    KyUInt32 GetCount() const;
    const T& Get(KyUInt32 index) const;
    T& Get(KyUInt32 index);
    void Set(KyUInt32 index, const T& object);

    T* m_buffer;
    KyUInt32 m_count;
};



class QueryDynamicOutput
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_QueryOutput)
    QueryDynamicOutput();

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;
    };

    // ---------------------------------- Main API functions ----------------------------------

    KyUInt32 GetNavFloorPtrCount()              const;
    KyUInt32 GetNavTrianglePtrCount()           const;
    KyUInt32 GetNavTagSubSegmentCount()         const;
    KyUInt32 GetCostMultiplierSubSegmentCount() const;
    KyUInt32 GetHalfEdgeIntersectionCount()     const;
    KyUInt32 GetSpatializedPointCount()         const;
    KyUInt32 GetTagVolumeCount()                const;

    const NavTrianglePtr& GetNavTrianglePtr(KyUInt32 trianglePtrIndex) const;
          NavTrianglePtr& GetNavTrianglePtr(KyUInt32 trianglePtrIndex);

    const NavFloorPtr& GetNavFloorPtr(KyUInt32 floorPtrIndex) const;
          NavFloorPtr& GetNavFloorPtr(KyUInt32 floorPtrIndex);

    const NavTagSubSegment& GetNavTagSubSegment(KyUInt32 navTagSubSegmentIndex) const;
          NavTagSubSegment& GetNavTagSubSegment(KyUInt32 navTagSubSegmentIndex);

    const CostMultiplierSubSegment& GetCostMultiplierSubSegment(KyUInt32 costMultSubSegmentIdx) const;
          CostMultiplierSubSegment& GetCostMultiplierSubSegment(KyUInt32 costMultSubSegmentIdx);

    const HalfEdgeIntersection& GetHalfEdgeIntersection(KyUInt32 halfEdgeIntersectionIndex) const;
          HalfEdgeIntersection& GetHalfEdgeIntersection(KyUInt32 halfEdgeIntersectionIndex);

    const Ptr<SpatializedPoint>& GetSpatializedPoint(KyUInt32 spatializedPointIndex) const;
          Ptr<SpatializedPoint>& GetSpatializedPoint(KyUInt32 spatializedPointIndex);

    const Ptr<TagVolume>& GetTagVolume(KyUInt32 tagVolumeIdx) const;
          Ptr<TagVolume>& GetTagVolume(KyUInt32 tagVolumeIdx);

    void SetNavTrianglePtr          (KyUInt32 trianglePtrIndex,          const NavTrianglePtr& navTrianglePtr);
    void SetNavTagSubSegment        (KyUInt32 navTagSubSegmentIndex,     const NavTagSubSegment& navTagSubSegment);
    void SetCostMultiplierSubSegment(KyUInt32 costMultSubSegmentIdx,     const CostMultiplierSubSegment& costMultSubSegment);
    void SetHalfEdgeIntersection    (KyUInt32 halfEdgeIntersectionIndex, const HalfEdgeIntersection& halfEdgeIntersection);
    void SetNavFloorPtr             (KyUInt32 floorPtrIndex,             const NavFloorPtr& navFloorPtr);
    void SetSpatializedPoint        (KyUInt32 spatializedPointIndex,     const Ptr<SpatializedPoint>& spatializedPoint);
    void SetTagVolume               (KyUInt32 tagVolumeIndex,            const Ptr<TagVolume>& tagVolume);

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

    void ClearBuffers();
    bool IsEnoughMemoryForStoringDynamicOutput(const Config& config);
    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 AtomicInt<int> RefCount;


public:
    // 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);
    ~ScopedDynamicOutput();

    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"

#endif //Navigation_QueryDynamicOutput_H