baseraycangoonsegmentquery.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_BaseRayCanGoOnSegmentQuery_H
#define Navigation_BaseRayCanGoOnSegmentQuery_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/navmesh/identifiers/navhalfedgeptr.h"
#include "gwnavruntime/database/positionspatializationrange.h"



namespace Kaim
{

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

enum RayCanGoOnSegmentQueryResult
{
    RAYCANGOONSEGMENT_NOT_INITIALIZED = QUERY_NOT_INITIALIZED, 
    RAYCANGOONSEGMENT_NOT_PROCESSED   = QUERY_NOT_PROCESSED,   

    RAYCANGOONSEGMENT_DONE_START_OUTSIDE,                      
    RAYCANGOONSEGMENT_DONE_START_NAVTAG_FORBIDDEN,             
    RAYCANGOONSEGMENT_DONE_COLLISION_DETECTED,                 
    RAYCANGOONSEGMENT_DONE_ARRIVAL_IN_WRONG_FLOOR,             
    RAYCANGOONSEGMENT_DONE_LACK_OF_WORKING_MEMORY,             
    RAYCANGOONSEGMENT_DONE_QUERY_TOO_LONG,                     

    RAYCANGOONSEGMENT_DONE_SUCCESS,                            
};

class BaseRayCanGoOnSegmentQuery : public IAtomicQuery
{
public:
    static  QueryType GetStaticType() { return TypeRayCanGoOnSegment; }
    virtual QueryType GetType() const { return TypeRayCanGoOnSegment; }


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

    RayCanGoOnSegmentQueryResult       GetResult()                      const;
    const Vec3f&                       GetStartPos()                    const;
    const Vec3f&                       GetSegmentStartPos()             const;
    const Vec3f&                       GetSegmentEndPos()               const;
    const NavTrianglePtr&              GetStartTrianglePtr()            const;
    const NavTrianglePtr&              GetArrivalTrianglePtr()          const;
    ComputeCostMode                    GetComputeCostMode()             const;
    KyFloat32                          GetComputedCost()                const;
    DynamicOutputMode                  GetDynamicOutputMode()           const;
    QueryDynamicOutput*                GetQueryDynamicOutput()          const;
    const PositionSpatializationRange& GetPositionSpatializationRange() const;
    const WorldIntegerPos&             GetStartIntegerPos()             const;
    const WorldIntegerPos&             GetSegmentStartIntegerPos()      const;
    const WorldIntegerPos&             GetSegmentEndIntegerPos()        const;

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

    void BindToDatabase(Database* database);
    void Initialize(const Vec3f& startPos, const NavTrianglePtr& startTrianglePtr, const Vec3f& segmentStartPos, const Vec3f& segmentEndPos);

    void SetPositionSpatializationRange(const PositionSpatializationRange& positionSpatializationRange);
    void SetDynamicOutputMode(DynamicOutputMode dynamicOutputMode);
    void SetComputeCostMode(ComputeCostMode computeCostMode);
    void SetQueryDynamicOutput(QueryDynamicOutput* queryDynamicOutput);
    void SetStartIntegerPos(const WorldIntegerPos& startIntegerPos);
    void SetSegmentStartIntegerPos(const WorldIntegerPos& segmentStartIntegerPos);
    void SetSegmentEndIntegerPos(const WorldIntegerPos& segmentEndIntegerPos);
    void SetResult(RayCanGoOnSegmentQueryResult result);

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

protected:
    WorldIntegerPos m_startIntegerPos;
    WorldIntegerPos m_segmentStartIntegerPos;
    WorldIntegerPos m_segmentEndIntegerPos;

    Vec3f m_segmentStartPos3f; 
    Vec3f m_segmentEndPos3f;   
    Vec3f m_startPos3f;        

    NavTrianglePtr m_startTrianglePtr; 

    PositionSpatializationRange m_positionSpatializationRange;

    NavTrianglePtr m_destTrianglePtr;

    RayCanGoOnSegmentQueryResult m_result; 

    ComputeCostMode m_computeCostMode; 
    KyFloat32 m_cost; 

    DynamicOutputMode m_dynamicOutputMode; 

    Ptr<QueryDynamicOutput> m_queryDynamicOutput;
};

}

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



#endif //Navigation_BaseRayCanGoOnSegmentQuery_H