ipathfinderquery.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_IPathFinderQuery_H
#define Navigation_IPathFinderQuery_H

#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"

namespace Kaim
{

class ScopedDisplayList;

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,  
    };

    // ---------------------------------- Public Member Functions ----------------------------------

    IPathFinderQuery();
    virtual ~IPathFinderQuery() {}

    Path* GetPath() const;
    ChannelArray* GetChannelArray() const;
    const Vec3f& GetStartPos() const;

    void SetNavigationProfileId(KyUInt32 navigationProfileId);
    KyUInt32 GetNavigationProfileId() const;

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

    virtual const Vec3f* GetDestination() const = 0;

    virtual void GetPathFinderTextResult(String&) const {}

    virtual void DisplayPropagationBounds(ScopedDisplayList&) const {}

    virtual PathFinderResult GetPathFinderResult() const = 0;
protected:
    void SetPath(Path* path);
    void BindToDatabase(Database* database);
public:
    // ---------------------------------- Public Data Members ----------------------------------

    Vec3f m_startPos3f;               
    Ptr<Path> m_path;                 
    
    KyUInt32 m_navigationProfileId;

    PathFinderQueryComputeChannelMode m_computeChannelMode; 
    ChannelComputerConfig m_channelComputerConfig; 

    KyUInt32 m_dataBaseChangeIdx;     

    bool m_enableAdvancedVisualDebug;
};

KY_INLINE IPathFinderQuery::IPathFinderQuery()
    : m_startPos3f(KyFloat32MAXVAL, KyFloat32MAXVAL, KyFloat32MAXVAL)
    , m_path(KY_NULL)
    , m_navigationProfileId(0)
    , m_computeChannelMode(PATHFINDER_DO_NOT_COMPUTE_CHANNELS)
    , m_dataBaseChangeIdx(0)
    , m_enableAdvancedVisualDebug(false)
{}
KY_INLINE void IPathFinderQuery::BindToDatabase(Database* database)
{
    ITimeSlicedQuery::BindToDatabase(database);
    m_enableAdvancedVisualDebug = false;
}

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

KY_INLINE void     IPathFinderQuery::SetNavigationProfileId(KyUInt32 navigationProfileId) { m_navigationProfileId = navigationProfileId; }
KY_INLINE KyUInt32 IPathFinderQuery::GetNavigationProfileId() const { return m_navigationProfileId; }
KY_INLINE void     IPathFinderQuery::SetPath(Path* path) { m_path = path; }

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;
};

}

#endif //Navigation_IPathFinderQuery_H