basepathfrompolylinequery.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/queries/ipathfinderquery.h"
#include "gwnavruntime/querysystem/workingmemcontainers/navdatachangeindexingrid.h"
#include "gwnavruntime/queries/utils/pathfinderqueryutils.h"
#include "gwnavruntime/queries/utils/pathrefinercontext.h"
#include "gwnavruntime/queries/utils/pathclampercontext.h"

namespace Kaim
{

class Path;


enum PathFromPolylineQueryResult
{
    PATHFROMPOLYLINE_NOT_INITIALIZED = QUERY_NOT_INITIALIZED, 
    PATHFROMPOLYLINE_NOT_PROCESSED   = QUERY_NOT_PROCESSED,   

    PATHFROMPOLYLINE_PROCESSING_PATHCLAMPING_INIT,      
    PATHFROMPOLYLINE_PROCESSING_PATHCLAMPING,           
    PATHFROMPOLYLINE_PROCESSING_PATHBUILDING,           
    PATHFROMPOLYLINE_PROCESSING_CHANNEL_INIT,           
    PATHFROMPOLYLINE_PROCESSING_CHANNEL_COMPUTE,        

    PATHFROMPOLYLINE_DONE_DATABASE_EMPTY,               
    PATHFROMPOLYLINE_DONE_END_OUTSIDE,                  
    PATHFROMPOLYLINE_DONE_POLYLINE_INVALID,             
    PATHFROMPOLYLINE_DONE_PATH_NOT_FOUND,               
    PATHFROMPOLYLINE_DONE_NAVDATA_CHANGED,              
    PATHFROMPOLYLINE_DONE_ERROR_LACK_OF_WORKING_MEMORY, 
    PATHFROMPOLYLINE_DONE_COMPUTATION_ERROR,            
    PATHFROMPOLYLINE_DONE_CHANNELCONFIG_ERROR,          
    PATHFROMPOLYLINE_DONE_CHANNELCOMPUTATION_ERROR,     
    PATHFROMPOLYLINE_DONE_COMPUTATION_CANCELED,         
    PATHFROMPOLYLINE_DONE_ERROR_POLYLINE_EMPTY,         

    PATHFROMPOLYLINE_DONE_DEST_IS_START_NO_PATH,        
    PATHFROMPOLYLINE_DONE_PATH_FOUND,                   
};


class BasePathFromPolylineQuery : public IPathFinderQuery
{
public:
    static  QueryType            GetStaticType() { return TypePathFromPolyline; }
    virtual QueryType            GetType() const { return TypePathFromPolyline; }

    // ---------------------------------- Main API functions ----------------------------------

    virtual void                      GetPathFinderTextResult(String&)        const;
    virtual PathFinderResult          GetPathFinderResult()                   const;
    virtual const Vec3f*              GetDestination()                        const;

    PathFromPolylineQueryResult       GetResult()                             const;
    const Vec3f&                      GetStartPos()                           const;
    const KyArrayPOD<Vec3f>&          GetPolyline()                           const;
    PathFinderQueryComputeChannelMode GetComputeChannelMode()                 const;
    const ChannelComputerConfig&      GetChannelComputerConfig()              const;
    Path*                             GetPath()                               const;
    ChannelArray*                     GetChannelArray()                       const;
    KyUInt32                          GetNumberOfProcessedNodePerFrame()      const;

    const PositionSpatializationRange& GetPositionSpatializationRange() const;

public: // internal
    void BindToDatabase(Database* database);
    void Initialize(const Vec3f* vertexBuffer, KyUInt32 vertexCount);

    void SetComputeChannelMode(PathFinderQueryComputeChannelMode computeChannelMode);
    void SetChannelComputerConfig(const ChannelComputerConfig& channelComputerConfig);
    void SetPositionSpatializationRange(const PositionSpatializationRange& positionSpatializationRange);

    void SetPathClamperFlagMask(PathClamperFlagMask pathClamperFlagMask); // Call this method after BindToDatabase()

protected:
    BasePathFromPolylineQuery();
    virtual ~BasePathFromPolylineQuery() {}
    void SetResult(PathFromPolylineQueryResult result);

protected:
    KyArrayPOD<Vec3f> m_polylinePositions;

    PositionSpatializationRange m_positionSpatializationRange;

    PathFromPolylineQueryResult m_result; 

    PathClamperFlagMask m_pathClamperFlagMask;

public: //internal
    KyUInt32 m_numberOfRayCastPerAdavance;

    KyUInt32 m_numberOfIntersectionTestPerAdvance;
};


KY_INLINE void BasePathFromPolylineQuery::SetResult(PathFromPolylineQueryResult result)                 { m_result                = result; }
KY_INLINE void BasePathFromPolylineQuery::SetComputeChannelMode(PathFinderQueryComputeChannelMode mode) { m_computeChannelMode    = mode;   }
KY_INLINE void BasePathFromPolylineQuery::SetChannelComputerConfig(const ChannelComputerConfig& config) { m_channelComputerConfig = config; }

KY_INLINE PathFromPolylineQueryResult       BasePathFromPolylineQuery::GetResult()                const { return m_result;                        }
KY_INLINE Path*                             BasePathFromPolylineQuery::GetPath()                  const { return m_path;                          }
KY_INLINE PathFinderQueryComputeChannelMode BasePathFromPolylineQuery::GetComputeChannelMode()    const { return m_computeChannelMode;            }
KY_INLINE const ChannelComputerConfig&      BasePathFromPolylineQuery::GetChannelComputerConfig() const { return m_channelComputerConfig;         }
KY_INLINE const Vec3f&                      BasePathFromPolylineQuery::GetStartPos()              const { return IPathFinderQuery::GetStartPos(); }
KY_INLINE const KyArrayPOD<Vec3f>&          BasePathFromPolylineQuery::GetPolyline()              const { return m_polylinePositions;             }
KY_INLINE const Vec3f* BasePathFromPolylineQuery::GetDestination() const
{
    if (m_polylinePositions.GetCount() == 0)
        return nullptr;

    return &m_polylinePositions.Back();
}

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

KY_INLINE void BasePathFromPolylineQuery::SetPathClamperFlagMask(PathClamperFlagMask pathClamperFlagMask) { m_pathClamperFlagMask = pathClamperFlagMask; }

}