basesegmentcangoquery.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_BaseSegmentCanGoQuery_H
#define Navigation_BaseSegmentCanGoQuery_H

#include "gwnavruntime/querysystem/iquery.h"
#include "gwnavruntime/queries/utils/queryutils.h"
#include "gwnavruntime/navmesh/worldintegerpos.h"
#include "gwnavruntime/queries/utils/baseraycangoquery.h"
#include "gwnavruntime/queries/utils/navmeshtraversalcommon.h"

namespace Kaim
{

enum SegmentCanGoQueryResult
{
    SEGMENTCANGO_NOT_INITIALIZED = QUERY_NOT_INITIALIZED, 
    SEGMENTCANGO_NOT_PROCESSED   = QUERY_NOT_PROCESSED,   

    SEGMENTCANGO_DONE_START_OUTSIDE,                      
    SEGMENTCANGO_DONE_START_NAVTAG_FORBIDDEN,             
    SEGMENTCANGO_DONE_COLLISION_DETECTED,                 
    SEGMENTCANGO_DONE_ARRIVAL_WRONG_FLOOR,                
    SEGMENTCANGO_DONE_LACK_OF_WORKING_MEMORY,             
    SEGMENTCANGO_DONE_UNKNOWN_ERROR,                      

    SEGMENTCANGO_DONE_SUCCESS                             
};

class BaseSegmentCanGoQuery : public IAtomicQuery
{
public:
    static  QueryType GetStaticType() { return TypeSegmentCanGo; }
    virtual QueryType GetType() const { return TypeSegmentCanGo; }
    virtual void BuildQueryBlob(BaseBlobHandler* blobHandler);
    virtual void InitFromQueryBlob(World* world, void* blob);
    virtual Ptr<BaseBlobHandler> CreateQueryBlobHandler() { return CreateStaticQueryBlobHandler(); }
    static Ptr<BaseBlobHandler> CreateStaticQueryBlobHandler();


    // ---------------------------------- Main API Functions ----------------------------------

    SegmentCanGoQueryResult GetResult()             const;
    const Vec3f&            GetStartPos()           const;
    const Vec3f&            GetDestPos()            const;
    const NavTrianglePtr&   GetStartTrianglePtr()   const;
    const NavTrianglePtr&   GetDestTrianglePtr()    const;
    KyFloat32               GetRadius()             const;
    DynamicOutputMode       GetDynamicOutputMode()  const;
    QueryDynamicOutput*     GetQueryDynamicOutput() const;
    const WorldIntegerPos&  GetStartIntegerPos()    const;
    const WorldIntegerPos&  GetDestIntegerPos()     const;

    const PositionSpatializationRange& GetPositionSpatializationRange() const;

protected:
    BaseSegmentCanGoQuery();
    ~BaseSegmentCanGoQuery() {}

    void BindToDatabase(Database* database);
    void Initialize(const Vec3f& startPos, const Vec3f& destPos, KyFloat32 radius);

    void SetStartTrianglePtr(const NavTrianglePtr& startTrianglePtr);
    void SetPositionSpatializationRange(const PositionSpatializationRange& positionSpatializationRange);
    void SetDynamicOutputMode(DynamicOutputMode savingMode);
    void SetQueryDynamicOutput(QueryDynamicOutput* queryDynamicOutput);
    void SetStartIntegerPos(const WorldIntegerPos& startIntegerPos);
    void SetDestIntegerPos(const WorldIntegerPos& destIntegerPos);
    void SetResult(SegmentCanGoQueryResult result);

    SegmentCanGoQueryResult ConvertRayCanGoResultToSegmentCanGoResult(RayCanGoQueryResult result);
    SegmentCanGoQueryResult ConvertTraversalResultToSegmentCanGoResult(TraversalResult traversalRC);

protected:
    WorldIntegerPos m_startIntegerPos;
    WorldIntegerPos m_destIntegerPos;

    Vec3f m_startPos3f;                
    Vec3f m_destPos3f;                 
    NavTrianglePtr m_startTrianglePtr; 
    NavTrianglePtr m_destTrianglePtr;  
    KyFloat32 m_radius;                

    PositionSpatializationRange m_positionSpatializationRange;

    SegmentCanGoQueryResult m_result; 

    DynamicOutputMode m_dynamicOutputMode; 

    Ptr<QueryDynamicOutput> m_queryDynamicOutput;
};

}

#include "gwnavruntime/queries/utils/basesegmentcangoquery.inl"

#endif //Navigation_BaseSegmentCanGoQuery_H