basefindfirstvisiblepositiononpathquery.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: LAPA - secondary contact: NOBODY
#ifndef Navigation_BaseFindFirstVisiblePositionOnPathQuery_H
#define Navigation_BaseFindFirstVisiblePositionOnPathQuery_H

#include "gwnavruntime/querysystem/iquery.h"
#include "gwnavruntime/queries/utils/queryutils.h"
#include "gwnavruntime/path/positiononpath.h"


namespace Kaim
{

enum FindFirstVisiblePositionOnPathQueryResult
{
    FINDFIRSTVISIBLEPOSITIONONPATH_NOT_INITIALIZED = QUERY_NOT_INITIALIZED,          
    FINDFIRSTVISIBLEPOSITIONONPATH_NOT_PROCESSED   = QUERY_NOT_PROCESSED,            

    FINDFIRSTVISIBLEPOSITIONONPATH_DONE_VISIBILITYSTARTPOINT_OUTSIDE,                
    FINDFIRSTVISIBLEPOSITIONONPATH_DONE_VISIBILITYSTARTPOINT_NAVTAG_FORBIDDEN,       
    FINDFIRSTVISIBLEPOSITIONONPATH_DONE_NO_VISIBLE_POSITION_FOUND,                   
    FINDFIRSTVISIBLEPOSITIONONPATH_DONE_LACK_OF_WORKING_MEMORY,                      
    FINDFIRSTVISIBLEPOSITIONONPATH_DONE_UNKNOWN_ERROR,                               

    FINDFIRSTVISIBLEPOSITIONONPATH_DONE_SUCCESS                                      
};

class BaseFindFirstVisiblePositionOnPathQuery : public IAtomicQuery
{
public:
    static  QueryType GetStaticType() { return TypeFindFirstVisiblePositionOnPath; }
    virtual QueryType GetType() const { return TypeFindFirstVisiblePositionOnPath; }
    virtual void BuildQueryBlob(BaseBlobHandler* blobHandler);
    virtual void InitFromQueryBlob(World* world, void* blob);
    virtual Ptr<BaseBlobHandler> CreateQueryBlobHandler() { return CreateStaticQueryBlobHandler(); }
    static Ptr<BaseBlobHandler> CreateStaticQueryBlobHandler();


    // ---------------------------------- Main API Functions ----------------------------------

    FindFirstVisiblePositionOnPathQueryResult GetResult()   const;
    const PositionOnPath& GetStartPositionOnPath()          const;
    const PositionOnPath& GetEndPositionOnPath()            const;
    const Vec3f&          GetVisibilityStartPoint()         const;
    const NavTrianglePtr& GetVisibilityStartTrianglePtr()   const;
    KyFloat32             GetSamplingDistance()             const;
    RayCanGoMarginMode    GetRayCanGoMarginMode()           const;
    KyFloat32             GetCostToVisiblePositionOnPath() const;
    const PositionOnPath& GetFirstVisiblePositionOnPath()   const;

protected:
    enum CandidateValidationResult
    {
        ContinueSampling,
        StopSampling
    };

    BaseFindFirstVisiblePositionOnPathQuery();
    virtual ~BaseFindFirstVisiblePositionOnPathQuery() {}

    void BindToDatabase(Database* database);
    void Initialize(const PositionOnPath& startPositionOnPath, const PositionOnPath& endPositionOnPath, const Vec3f& visibilityStartPoint);

    void SetVisibilityStartTrianglePtr(const NavTrianglePtr& startTrianglePtr);
    void SetSamplingDistance(KyFloat32 samplingDistance);
    void SetRayCanGoMarginMode(RayCanGoMarginMode rayCanGoMarginMode);
    void SetResult(FindFirstVisiblePositionOnPathQueryResult result);

protected:
    PositionOnPath m_startPositionOnPath; 
    PositionOnPath m_endPositionOnPath;   

    Vec3f m_visibilityStartPos3f; 
    NavTrianglePtr m_visibilityStartTrianglePtr; 

    RayCanGoMarginMode m_rayCanGoMarginMode; 

    KyFloat32 m_samplingDistance;

    FindFirstVisiblePositionOnPathQueryResult m_result; 
    PositionOnPath m_firstVisiblePositionOnPath;  
    KyFloat32 m_costToVisibleTargetOnPath;
};

} // namespace Kaim

#include "gwnavruntime/queries/utils/basefindfirstvisiblepositiononpathquery.inl"



#endif // Navigation_BaseFindFirstVisiblePositionOnPathQuery_H