ipathfinderquery.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/querysystem/iquery.h"
#include "gwnavruntime/math/vec3f.h"
#include "gwnavruntime/queries/blobs/queryblobcategory.h"
#include "gwnavruntime/blob/baseblobbuilder.h"
#include "gwnavruntime/path/path.h"
#include "gwnavruntime/channel/channelcomputerconfig.h"
#include "gwnavruntime/kernel/SF_String.h"
#include "gwnavruntime/queries/fulldebug.h"

namespace Kaim
{

class DisplayList;

enum PathFinderQueryComputeChannelMode
{
    PATHFINDER_DO_NOT_COMPUTE_CHANNELS,
    PATHFINDER_DO_COMPUTE_CHANNELS,
};

class IPathFinderQuery : public ITimeSlicedQuery
{
public:
    enum PathFinderResult
    {
        PathFinderNotInitialized,          
        PathFinderNotComputed,             
        PathFinderUnderProcess,            
        PathFinderSuccess,                 
        PathFinderFailure,                 
        PathFinderFailure_NavDataChanged,  
    };

    // ------------------------------ Functions -----------------------------

    IPathFinderQuery();
    virtual ~IPathFinderQuery() {}

    Path* GetPath() const            { return m_path;       }
    const Vec3f& GetStartPos() const { return m_startPos3f; }

    void SetNavigationProfileId(KyUInt32 navigationProfileId) { m_navigationProfileId = navigationProfileId; }
    KyUInt32 GetNavigationProfileId() const  { return m_navigationProfileId; }

    // ---------------------------------- Virtual Member Functions ----------------------------------

    virtual const Vec3f* GetDestination() const = 0;

    virtual void GetPathFinderTextResult(String&) const {}

    virtual void DisplayPropagationBounds(DisplayList&) const {}

    virtual PathFinderResult GetPathFinderResult() const = 0;

protected:
    void SetPath(Path* path) { m_path = path; }
    void BindToDatabase(Database* database);
    void Initialize();

public:
    // ---------------------------------- Public Data Members ----------------------------------
    KyUInt32 m_navigationProfileId;

    // start
    Vec3f m_startPos3f;               

    // configuration
    PathFinderQueryComputeChannelMode m_computeChannelMode; 
    ChannelComputerConfig m_channelComputerConfig; 
    FullDebug m_fullDebug;
    bool m_doClampRawPath; // only useful for tests

    // computed
    KyUInt32 m_lastAdvanceDatabaseChangeIdx; // used to test if there was a change in the database since last call to Advance

    // result
    Ptr<Path> m_path; 
};

KY_INLINE IPathFinderQuery::IPathFinderQuery()
    : m_navigationProfileId(0)
    , m_computeChannelMode(PATHFINDER_DO_NOT_COMPUTE_CHANNELS)
    , m_doClampRawPath(true)
    , m_lastAdvanceDatabaseChangeIdx(0)
    , m_path(nullptr)
{}

KY_INLINE void IPathFinderQuery::BindToDatabase(Database* database)
{
    ITimeSlicedQuery::BindToDatabase(database);

    // start
    m_startPos3f.Zero();

    // configuration
    m_computeChannelMode = PATHFINDER_DO_NOT_COMPUTE_CHANNELS;
    m_channelComputerConfig.SetDefaults();
    m_fullDebug.Clear();
    m_doClampRawPath = true;

    // computed
    m_lastAdvanceDatabaseChangeIdx = 0;

    // result
    m_path = nullptr;
}

KY_INLINE void IPathFinderQuery::Initialize()
{
    ITimeSlicedQuery::Initialize();

    // start
    m_startPos3f.Zero();

    // computed
    m_lastAdvanceDatabaseChangeIdx = 0;

    // result
    m_path = nullptr;
}

class ScopedSetPathNavigationProfile
{
public:
    ScopedSetPathNavigationProfile(IPathFinderQuery* query) : m_query(query) {}
    ~ScopedSetPathNavigationProfile()
    {
        if (m_query->m_path)
            m_query->m_path->SetNavigationProfileId(m_query->GetNavigationProfileId());
    }
    IPathFinderQuery* m_query;
};

}