traversalparams.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_TraversalParams_H
#define Navigation_TraversalParams_H

#include "gwnavruntime/database/positionspatializationrange.h"
#include "gwnavruntime/database/database.h"
#include "gwnavruntime/queries/utils/pathfinderabstractgraphtraversalmode.h"

namespace Kaim
{

class TraversalParameters
{
public:
    // ---------------------------------- Main API functions ----------------------------------

    KyUInt32  GetNumberOfProcessedNodePerFrame()       const;
    KyFloat32 GetFromOutsideNavMeshDistance()          const;
    KyFloat32 GetToOutsideNavMeshDistance()            const;

    PathFinderAbstractGraphTraversalMode GetAbstractGraphTraversalMode() const;
    const PositionSpatializationRange&  GetPositionSpatializationRange() const;

public: // Internal
    TraversalParameters() { SetDefaults(KY_NULL); }
    virtual ~TraversalParameters() {}

    // public because can be used by the Bot basic path finding helper functions
    void SetDefaults(Database* database)
    {
        m_numberOfVisitedNodePerFrame = 30;
        m_numberOfCanGoTestInRefinerPerFrame = 15;
        m_numberOfIntersectionTestPerFrame = 100;
        m_fromOutsideNavMeshDistance = 1.5f;
        m_toOutsideNavMeshDistance = 1.5f;
        m_abstractGraphTraversalMode = PATHFINDER_TRAVERSE_ABSTRACT_GRAPHS;

        if (database != KY_NULL)
            SetPositionSpatializationRange(database->GetPositionSpatializationRange());
    }

    void SetNumberOfProcessedNodePerFrame(KyUInt32 numberOfProcessedNodePerFrame);
    void SetPositionSpatializationRange(const PositionSpatializationRange& positionSpatializationRange);
    void SetFromOutsideNavMeshDistance(KyFloat32 fromOutsideNavMeshDistance);
    void SetToOutsideNavMeshDistance(KyFloat32 toOutsideNavMeshDistance);
    void SetAbstractGraphTraversalMode(PathFinderAbstractGraphTraversalMode abstractGraphTraversalMode);

public: // Internal
    PositionSpatializationRange m_positionSpatializationRange;

    KyFloat32 m_fromOutsideNavMeshDistance;

    KyFloat32 m_toOutsideNavMeshDistance;

    KyUInt32 m_numberOfVisitedNodePerFrame;

    KyUInt32 m_numberOfCanGoTestInRefinerPerFrame;

    KyUInt32 m_numberOfIntersectionTestPerFrame;

    PathFinderAbstractGraphTraversalMode m_abstractGraphTraversalMode;
    CellBox m_startActiveDataCellBoxForAbstractGraph;
    CellBox m_destActiveDataCellBoxForAbstractGraph;
};


KY_INLINE void TraversalParameters::SetFromOutsideNavMeshDistance(KyFloat32 fromOutsideNavMeshDistance)       { m_fromOutsideNavMeshDistance    = fromOutsideNavMeshDistance;    }
KY_INLINE void TraversalParameters::SetToOutsideNavMeshDistance(KyFloat32 toOutsideNavMeshDistance)           { m_toOutsideNavMeshDistance      = toOutsideNavMeshDistance;      }
KY_INLINE void TraversalParameters::SetNumberOfProcessedNodePerFrame(KyUInt32 numberOfProcessedNodePerFrame)  { m_numberOfVisitedNodePerFrame   = numberOfProcessedNodePerFrame; }

KY_INLINE KyFloat32 TraversalParameters::GetFromOutsideNavMeshDistance()    const { return m_fromOutsideNavMeshDistance;    }
KY_INLINE KyFloat32 TraversalParameters::GetToOutsideNavMeshDistance()      const { return m_toOutsideNavMeshDistance;      }
KY_INLINE KyUInt32  TraversalParameters::GetNumberOfProcessedNodePerFrame() const { return m_numberOfVisitedNodePerFrame;   }

KY_INLINE const PositionSpatializationRange& TraversalParameters::GetPositionSpatializationRange() const { return m_positionSpatializationRange; }
KY_INLINE void TraversalParameters::SetPositionSpatializationRange(const PositionSpatializationRange& positionSpatializationRange)
{
    m_positionSpatializationRange = positionSpatializationRange;
}

KY_INLINE void TraversalParameters::SetAbstractGraphTraversalMode(PathFinderAbstractGraphTraversalMode abstractGraphTraversalMode)
{
    m_abstractGraphTraversalMode = abstractGraphTraversalMode;
}

KY_INLINE PathFinderAbstractGraphTraversalMode TraversalParameters::GetAbstractGraphTraversalMode() const
{
    return m_abstractGraphTraversalMode;
}

}

#endif //Navigation_TraversalParams_H