basemoveonnavmeshquery.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: LAPA - secondary contact: JUBA
#ifndef Navigation_BaseMoveOnNavMeshQuery_H
#define Navigation_BaseMoveOnNavMeshQuery_H

#include "gwnavruntime/querysystem/iquery.h"
#include "gwnavruntime/navmesh/identifiers/navtriangleptr.h"
#include "gwnavruntime/navmesh/worldintegerpos.h"

namespace Kaim
{

class Path;

enum MoveOnNavMeshQueryResult
{
    MOVEONNAVMESH_NOT_INITIALIZED = QUERY_NOT_INITIALIZED, 
    MOVEONNAVMESH_NOT_PROCESSED   = QUERY_NOT_PROCESSED,   

    MOVEONNAVMESH_DONE_START_OUTSIDE,                      
    MOVEONNAVMESH_DONE_START_NAVTAG_FORBIDDEN,             
    MOVEONNAVMESH_DONE_START_LINKONEDGE_ERROR,             
    MOVEONNAVMESH_DONE_LACK_OF_WORKING_MEMORY,             
    MOVEONNAVMESH_DONE_UNKNOWN_ERROR,                      

    MOVEONNAVMESH_DONE_ARRIVALPOS_FOUND_NO_COLLISION,      
    MOVEONNAVMESH_DONE_ARRIVALPOS_FOUND_AFTER_COLLISION,   
    MOVEONNAVMESH_DONE_INTERMEDIARYPOS_FOUND               
};

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

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

    MoveOnNavMeshQueryResult GetResult()             const;
    const Vec3f&             GetStartPos()           const;
    const Vec3f&             GetArrivalPos()         const;
    const Vec2f&             GetNormalizedDir2d()    const;
    const NavTrianglePtr&    GetStartTrianglePtr()   const;
    KyFloat32                GetDistanceToBoundary() const;
    KyFloat32                GetDistance()           const;
    KyFloat32                GetAltitudeTolerance()  const;
    const WorldIntegerPos&   GetStartIntegerPos()    const;

public: //internal
    void BindToDatabase(Database* database);
    void Initialize(const Vec3f& startPos, const Vec2f& normalizedDir2d, KyFloat32 maxDist);
    void SetStartTrianglePtr(const NavTrianglePtr& startTrianglePtr);
    void SetDistanceToBoundary(KyFloat32 distanceToBoundary);
    void SetStartIntegerPos(const WorldIntegerPos& startIntegerPos);

protected:
    BaseMoveOnNavMeshQuery(); 
    virtual ~BaseMoveOnNavMeshQuery() {}
    void SetResult(MoveOnNavMeshQueryResult result);

protected:
    WorldIntegerPos m_startIntegerPos;

    Vec3f m_startPos3f;      
    Vec2f m_normalizedDir2d; 

    NavTrianglePtr m_startTrianglePtr; 

    KyFloat32 m_distanceToBoundary;

    KyFloat32 m_moveDistance;

    Vec3f m_arrivalPos3f;

    MoveOnNavMeshQueryResult m_result; 

public:
    bool m_visualDebugActivated; 
};



KY_INLINE void BaseMoveOnNavMeshQuery::SetStartIntegerPos(const WorldIntegerPos& startIntegerPos)  { m_startIntegerPos    = startIntegerPos;    }
KY_INLINE void BaseMoveOnNavMeshQuery::SetStartTrianglePtr(const NavTrianglePtr& startTrianglePtr) { m_startTrianglePtr   = startTrianglePtr;   }
KY_INLINE void BaseMoveOnNavMeshQuery::SetDistanceToBoundary(KyFloat32 distanceToBoundary)         { m_distanceToBoundary = distanceToBoundary; }
KY_INLINE void BaseMoveOnNavMeshQuery::SetResult(MoveOnNavMeshQueryResult result)                  { m_result             = result;             }

KY_INLINE MoveOnNavMeshQueryResult BaseMoveOnNavMeshQuery::GetResult()             const { return m_result;             }
KY_INLINE const Vec3f&             BaseMoveOnNavMeshQuery::GetStartPos()           const { return m_startPos3f;         }
KY_INLINE const Vec3f&             BaseMoveOnNavMeshQuery::GetArrivalPos()         const { return m_arrivalPos3f;       }
KY_INLINE const Vec2f&             BaseMoveOnNavMeshQuery::GetNormalizedDir2d()    const { return m_normalizedDir2d;    }
KY_INLINE const NavTrianglePtr&    BaseMoveOnNavMeshQuery::GetStartTrianglePtr()   const { return m_startTrianglePtr;   }
KY_INLINE KyFloat32                BaseMoveOnNavMeshQuery::GetDistanceToBoundary() const { return m_distanceToBoundary; }
KY_INLINE KyFloat32                BaseMoveOnNavMeshQuery::GetDistance()           const { return m_moveDistance;       }
KY_INLINE const WorldIntegerPos&   BaseMoveOnNavMeshQuery::GetStartIntegerPos()    const { return m_startIntegerPos;    }
}

#endif //Navigation_BaseMoveOnNavMeshQuery_H