basesegmentcastquery.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_BaseSegmentCastQuery_H
#define Navigation_BaseSegmentCastQuery_H

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


namespace Kaim
{

enum SegmentCastQueryResult
{
    SEGMENTCAST_NOT_INITIALIZED = QUERY_NOT_INITIALIZED, 
    SEGMENTCAST_NOT_PROCESSED   = QUERY_NOT_PROCESSED,   

    SEGMENTCAST_DONE_START_OUTSIDE,                      
    SEGMENTCAST_DONE_START_NAVTAG_FORBIDDEN,             
    SEGMENTCAST_DONE_CANNOT_MOVE,                        
    SEGMENTCAST_DONE_COLLISION_FOUND_ARRIVAL_ERROR,      
    SEGMENTCAST_DONE_LACK_OF_WORKING_MEMORY,             
    SEGMENTCAST_DONE_UNKNOWN_ERROR,                      

    SEGMENTCAST_DONE_ARRIVALPOS_FOUND_MAXDIST_REACHED,   
    SEGMENTCAST_DONE_ARRIVALPOS_FOUND_AFTER_COLLISION    
};

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

    SegmentCastQueryResult GetResult()                  const;
    const Vec3f&           GetStartPos()                const;
    const Vec3f&           GetCollisionPos()            const;
    const Vec3f&           GetArrivalPos()              const;
    const Vec2f&           GetNormalizedDir2d()         const;
    const NavTrianglePtr&  GetStartTrianglePtr()        const;
    const NavTrianglePtr&  GetArrivalTrianglePtr()      const;
    const NavHalfEdgePtr&  GetCollisionNavHalfEdgePtr() const;
    KyFloat32              GetRadius()                  const;
    KyFloat32              GetMaxDist()                 const;
    KyFloat32              GetSafetyDist()              const;
    DynamicOutputMode      GetDynamicOutputMode()       const;
    QueryDynamicOutput*    GetQueryDynamicOutput()      const;

    const PositionSpatializationRange& GetPositionSpatializationRange() const;

    const WorldIntegerPos& GetStartIntegerPos() const;
    const WorldIntegerPos& GetArrivalIntegerPos() const;

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

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

    void SetStartTrianglePtr(const NavTrianglePtr& startTrianglePtr);
    void SetPositionSpatializationRange(const PositionSpatializationRange& positionSpatializationRange);
    void SetSafetyDist(KyFloat32 safetyDist);
    void SetDynamicOutputMode(DynamicOutputMode savingMode);
    void SetQueryDynamicOutput(QueryDynamicOutput* queryDynamicOutput);

    void SetStartIntegerPos(const WorldIntegerPos& startIntegerPos);
    void SetResult(SegmentCastQueryResult result);
    SegmentCastQueryResult ConvertTraversalResultToSegmentCastResult(TraversalResult traversalRC);

protected:
    WorldIntegerPos m_startIntegerPos;
    WorldIntegerPos m_arrivalIntegerPos;

    Vec3f m_startPos3f;                
    Vec2f m_normalizedDir2d;           
    KyFloat32 m_radius;                
    KyFloat32 m_maxDist;               
    NavTrianglePtr m_startTrianglePtr; 

    KyFloat32 m_safetyDist;

    PositionSpatializationRange m_positionSpatializationRange;

    Vec3f m_collisionPos3f;

    Vec3f m_arrivalPos3f;

    NavTrianglePtr m_arrivalTrianglePtr;

    NavHalfEdgePtr m_collisionHalfEdgePtr;

    SegmentCastQueryResult m_result; 

    DynamicOutputMode m_dynamicOutputMode; 

    Ptr<QueryDynamicOutput> m_queryDynamicOutput;
};

}

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

#endif //Navigation_BaseSegmentCastQuery_H