basemoveonnavmeshquery.h

Go to the documentation of this file.

/*
 * Copyright 2016 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.
 */

#pragma once

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

namespace Kaim
{

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 { return m_result; }

    const Vec3f& GetStartPos() const { return m_startPos3f; }

    const Vec3f& GetArrivalPos() const { return m_arrivalPos3f; }

    const Vec2f& GetNormalizedDir2d() const { return m_normalizedDir2d; }

    const NavTrianglePtr& GetStartTrianglePtr() const { return m_startTrianglePtr; }

    KyFloat32 GetDistanceToBoundary() const { return m_distanceToBoundary; }

    KyFloat32 GetDistance() const { return m_moveDistance; }

    const WorldIntegerPos& GetStartIntegerPos() const { return m_startIntegerPos; }

public: // internal
    void BindToDatabase(Database* database);

    void Initialize(const Vec3f& startPos, const Vec2f& normalizedDir2d, KyFloat32 maxDist);

    void SetStartTrianglePtr(const NavTrianglePtr& startTrianglePtr) { m_startTrianglePtr = startTrianglePtr; }

    void SetDistanceToBoundary(KyFloat32 distanceToBoundary); // Must be called after BindToDatabase were called for the given value to be clamped at half of pixelSize.

    void SetStartIntegerPos(const WorldIntegerPos& startIntegerPos) { m_startIntegerPos = startIntegerPos; }

    static KyFloat32 CapDistanceToBoundary(Kaim::Database* database, KyFloat32 distanceToBoundary); // Use by SetDistanceToBoundary and for tests

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

    void SetResult(MoveOnNavMeshQueryResult result) { m_result = 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; 
};
}