tagvolumesfromposquery.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_TagVolumesFromPosQuery_H
#define Navigation_TagVolumesFromPosQuery_H

#include "gwnavruntime/querysystem/iquery.h"
#include "gwnavruntime/navmesh/worldintegerpos.h"
#include "gwnavruntime/database/positionspatializationrange.h"
#include "gwnavruntime/queries/querydynamicoutput.h"

namespace Kaim
{

class ActiveCell;
class NavCell;
class NavFloorBlob;
template <class T> class WorkingMemArray;


enum TagVolumesFromPosQueryResult
{
    TAGVOLUMESROMPOS_NOT_INITIALIZED = QUERY_NOT_INITIALIZED, 
    TAGVOLUMESROMPOS_NOT_PROCESSED   = QUERY_NOT_PROCESSED,   

    TAGVOLUMESROMPOS_DONE_NO_TAGVOLUMES_FOUND,                  
    TAGVOLUMESROMPOS_DONE_LACK_OF_WORKING_MEMORY,             

    TAGVOLUMESROMPOS_DONE_TAGVOLUMES_FOUND                      
};


// Note that this query returns the TagVolumes that are integrated at runtime.
// Added tagVolumes that are not integrated yet or already fully deIntegrated won't be retrieved.
class TagVolumesFromPosQuery : public IAtomicQuery
{
public:
    static  QueryType GetStaticType() { return TypeTagVolumesFromPos; }
    virtual QueryType GetType() const { return TypeTagVolumesFromPos; }

    // ---------------------------------- Public Member Functions ----------------------------------

    TagVolumesFromPosQuery();
    virtual ~TagVolumesFromPosQuery() {}

    // ---------------------------------- Functions to set up the query ----------------------------------

    void BindToDatabase(Database* database);

    void Initialize(const Vec3f& pos);

    // ---------------------------------- write accessors for query parameters ----------------------------------

    void SetQueryDynamicOutput(QueryDynamicOutput* queryDynamicOutput);

    void SetPositionSpatializationRange(const PositionSpatializationRange& positionSpatializationRange);

    // ---------------------------------- Query framework functions ----------------------------------

    virtual void Advance(WorkingMemory* workingMemory);

    void PerformQuery(WorkingMemory* workingMemory = KY_NULL);

    // ---------------------------------- Accessors ----------------------------------

    TagVolumesFromPosQueryResult GetResult()                           const;
    const Vec3f&                 GetInputPos()                         const;
    QueryDynamicOutput*          GetQueryDynamicOutput()               const;

    const PositionSpatializationRange& GetPositionSpatializationRange() const;

public: // internal
    void SetInputIntegerPos(const WorldIntegerPos& integerPos);
    const WorldIntegerPos& GetInputIntegerPos() const;
    void PerformQueryWithInputCoordPos(WorkingMemory* workingMemory);

private :
    void SetResult(TagVolumesFromPosQueryResult result);
    void GetTagVolumesFromPos(WorkingMemory* workingMemory);
    
private:
    WorldIntegerPos m_inputIntegerPos;

    Vec3f m_inputPos3f; 

    Ptr<QueryDynamicOutput> m_queryDynamicOutput;

    PositionSpatializationRange m_positionSpatializationRange; 

    TagVolumesFromPosQueryResult m_result; 
};

}

#include "gwnavruntime/queries/tagvolumesfromposquery.inl"



#endif //Navigation_TagVolumesFromPosQuery_H