baseraycastonsegmentquery.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_BaseRayCastOnSegmentQuery_H
#define Navigation_BaseRayCastOnSegmentQuery_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 RayCastOnSegmentQueryResult
{
    RAYCASTONSEGMENT_NOT_INITIALIZED = QUERY_NOT_INITIALIZED, 
    RAYCASTONSEGMENT_NOT_PROCESSED   = QUERY_NOT_PROCESSED,   

    RAYCASTONSEGMENT_DONE_START_OUTSIDE,                      
    RAYCASTONSEGMENT_DONE_START_NAVTAG_FORBIDDEN,             
    RAYCASTONSEGMENT_DONE_CANNOT_MOVE,                        
    RAYCASTONSEGMENT_DONE_ARRIVAL_ERROR,                      
    RAYCASTONSEGMENT_DONE_LACK_OF_WORKING_MEMORY,             
    RAYCASTONSEGMENT_DONE_QUERY_TOO_LONG,                     
    RAYCASTONSEGMENT_DONE_UNKNOWN_ERROR,                      

    RAYCASTONSEGMENT_DONE_ARRIVALPOS_FOUND_MAXDIST_REACHED,   
    RAYCASTONSEGMENT_DONE_ARRIVALPOS_FOUND_AFTER_COLLISION    
};

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


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

    RayCastOnSegmentQueryResult GetResult()                 const;
    const Vec3f&                GetStartPos()               const;
    const Vec3f&                GetSegmentStartPos()        const;
    const Vec3f&                GetSegmentEndPos()          const;
    const Vec3f&                GetArrivalPos()             const;
    const NavTrianglePtr&       GetStartTrianglePtr()       const;
    const NavTrianglePtr&       GetArrivalTrianglePtr()     const;
    KyFloat32                   GetMaxDist()                const;
    DynamicOutputMode           GetDynamicOutputMode()      const;
    QueryDynamicOutput*         GetQueryDynamicOutput()     const;
    const WorldIntegerPos&      GetStartIntegerPos()        const;
    const WorldIntegerPos&      GetArrivalIntegerPos()      const;
    const WorldIntegerPos&      GetSegmentStartIntegerPos() const;
    const WorldIntegerPos&      GetSegmentEndIntegerPos()   const;

    const PositionSpatializationRange& GetPositionSpatializationRange() const;

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

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

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

    void RayCast_NoHit(const NavHalfEdgeRawPtr& lastHalfEdgeRawPtr, const WorldIntegerPos& destIntegerPos, const Vec3f& destPos3f,
        CompositeSubSegment& subSegment, ScopedDynamicOutput& scopedDynamicOutput);

protected:
    WorldIntegerPos m_startIntegerPos;
    WorldIntegerPos m_arrivalIntegerPos;
    WorldIntegerPos m_segmentStartIntegerPos;
    WorldIntegerPos m_segmentEndIntegerPos;

    Vec3f m_segmentStartPos3f; 
    Vec3f m_segmentEndPos3f;   
    Vec3f m_startPos3f;        
    Vec3f m_collisionPos3f;    
    Vec3f m_arrivalPos3f;      

    NavTrianglePtr m_startTrianglePtr;

    KyFloat32 m_maxDist;

    PositionSpatializationRange m_positionSpatializationRange;

    NavTrianglePtr m_arrivalTrianglePtr;

    NavHalfEdgePtr m_collisionHalfEdgePtr;

    RayCastOnSegmentQueryResult m_result; 

    DynamicOutputMode m_dynamicOutputMode; 

    Ptr<QueryDynamicOutput> m_queryDynamicOutput;
};

}

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



#endif //Navigation_BaseRayCastOnSegmentQuery_H