navigation_path.h

/*
===========================================================================
Copyright (C) 2025 the OpenMoHAA team
 
This file is part of OpenMoHAA source code.
 
OpenMoHAA source code is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the License,
or (at your option) any later version.
 
OpenMoHAA source code is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with OpenMoHAA source code; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
===========================================================================
*/
 
#pragma once
 
#include "../qcommon/vector.h"
#include "../qcommon/container.h"
#include "../qcommon/lightclass.h"
 
struct PathNav {
    Vector origin;
    vec2_t dir;
    float  dist;
};
 
struct PathSearchParameter {
    Vector  leashHome;
    float   leashDist;
    int     fallHeight;
    Entity *entity;
};
 
class IPather : public LightClass
{
public:
    virtual ~IPather() = default;

    static IPather *CreatePather();

    virtual void FindPath(const Vector& start, const Vector& end, const PathSearchParameter& parameters) = 0;

    virtual void
    FindPathNear(const Vector& start, const Vector& end, float radius, const PathSearchParameter& parameters) = 0;

    virtual void FindPathAway(
        const Vector&              start,
        const Vector&              avoid,
        const Vector&              preferredDir,
        float                      radius,
        const PathSearchParameter& parameters
    ) = 0;

    virtual bool TestPath(const Vector& start, const Vector& end, const PathSearchParameter& parameters) = 0;

    virtual void UpdatePos(const Vector& origin) = 0;

    virtual void Clear() = 0;

    virtual PathNav GetNode(unsigned int index = 0) const = 0;

    virtual int GetNodeCount() const = 0;

    virtual Vector GetCurrentDelta() const = 0;

    virtual Vector GetCurrentDirection() const = 0;

    virtual Vector GetDestination() const = 0;

    virtual bool HasReachedGoal(const Vector& origin) const = 0;

    virtual bool IsQuerying() const = 0;
};