baseraycangoquery.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_BaseRayCanGoQuery_H
#define Navigation_BaseRayCanGoQuery_H

#include "gwnavruntime/querysystem/iquery.h"
#include "gwnavruntime/queries/utils/rayqueryutils.h"
#include "gwnavruntime/queries/utils/queryutils.h"
#include "gwnavruntime/navmesh/worldintegerpos.h"
#include "gwnavruntime/database/positionspatializationrange.h"


namespace Kaim
{

class NavHalfEdgeRawPtr;
class RawNavTagSubSegment;
template <class T> class WorkingMemArray;

enum RayCanGoQueryResult
{
    RAYCANGO_NOT_INITIALIZED = QUERY_NOT_INITIALIZED, 
    RAYCANGO_NOT_PROCESSED   = QUERY_NOT_PROCESSED,   

    RAYCANGO_DONE_START_OUTSIDE,                      
    RAYCANGO_DONE_START_NAVTAG_FORBIDDEN,             
    RAYCANGO_DONE_COLLISION_DETECTED,                 
    RAYCANGO_DONE_BORDER_DETECTED_WITHIN_MARGIN,      
    RAYCANGO_DONE_ARRIVAL_IN_WRONG_FLOOR,             
    RAYCANGO_DONE_LACK_OF_WORKING_MEMORY,             
    RAYCANGO_DONE_UNKNOWN_ERROR,                      

    RAYCANGO_DONE_SUCCESS                             
};

class BaseRayCanGoQuery : public IAtomicQuery
{
public:
    static  QueryType GetStaticType() { return TypeRayCanGo; }
    virtual QueryType GetType() const { return TypeRayCanGo; }
    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 ----------------------------------

    RayCanGoQueryResult    GetResult()                 const;
    const Vec3f&           GetStartPos()               const;
    const Vec3f&           GetDestPos()                const;
    const NavTrianglePtr&  GetStartTrianglePtr()       const;
    const NavTrianglePtr&  GetDestTrianglePtr()        const;
    ComputeCostMode        GetComputeCostMode()        const;
    KyFloat32              GetComputedCost()           const;
    DynamicOutputMode      GetDynamicOutputMode()      const;
    QueryDynamicOutput*    GetQueryDynamicOutput()     const;
    const WorldIntegerPos& GetStartIntegerPos()        const;
    const WorldIntegerPos& GetDestIntegerPos()         const;
    RayCanGoMarginMode     GetMarginMode()             const;

    const PositionSpatializationRange& GetPositionSpatializationRange() const;


public : // internal
    void BindToDatabase(Database* database);
    void Initialize(const Vec3f& startPos, const Vec3f& destPos);

    void SetStartTrianglePtr(const NavTrianglePtr& startTrianglePtr);
    void SetPositionSpatializationRange(const PositionSpatializationRange& positionSpatializationRange);
    void SetMarginMode(RayCanGoMarginMode marginMode);
    void SetDynamicOutputMode(DynamicOutputMode dynamicOutputMode);
    void SetComputeCostMode(ComputeCostMode computeCostMode);
    void SetQueryDynamicOutput(QueryDynamicOutput* queryDynamicOutput);
    void SetStartIntegerPos(const WorldIntegerPos& startIntegerPos);
    void SetDestIntegerPos(const WorldIntegerPos& destIntegerPos);

protected:
    BaseRayCanGoQuery();
    virtual ~BaseRayCanGoQuery() {}

    void SetResult(RayCanGoQueryResult result);
    void RayCanGo_NoHit(const NavHalfEdgeRawPtr& lastHalfEdgeRawPtr, CompositeSubSegment& subSegment, ScopedDynamicOutput& scopedDynamicOutput);

protected:
    WorldIntegerPos m_startIntegerPos;
    WorldIntegerPos m_destIntegerPos;

    Vec3f m_startPos3f; 
    Vec3f m_destPos3f;  

    NavTrianglePtr m_startTrianglePtr; 
    NavTrianglePtr m_destTrianglePtr; 

    PositionSpatializationRange m_positionSpatializationRange;

    RayCanGoQueryResult m_result; 

    ComputeCostMode m_computeCostMode; 
    KyFloat32 m_cost; 

    RayCanGoMarginMode m_marginMode; 

    DynamicOutputMode m_dynamicOutputMode; 

    Ptr<QueryDynamicOutput> m_queryDynamicOutput;
};

}

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



#endif //Navigation_BaseRayCanGoQuery_H