basediskcangoquery.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_BaseDiskCanGoQuery_H
#define Navigation_BaseDiskCanGoQuery_H

#include "gwnavruntime/querysystem/iquery.h"
#include "gwnavruntime/queries/utils/queryutils.h"
#include "gwnavruntime/queries/utils/navmeshtraversalcommon.h"
#include "gwnavruntime/navmesh/worldintegerpos.h"
#include "gwnavruntime/queries/utils/baseraycangoquery.h"


namespace Kaim
{

class NavTriangleRawPtr;

enum DiskCanGoQueryResult
{
    DISKCANGO_NOT_INITIALIZED = QUERY_NOT_INITIALIZED, 
    DISKCANGO_NOT_PROCESSED   = QUERY_NOT_PROCESSED,   

    DISKCANGO_DONE_START_OUTSIDE,                      
    DISKCANGO_DONE_START_NAVTAG_FORBIDDEN,             
    DISKCANGO_DONE_COLLISION_DETECTED,                 
    DISKCANGO_DONE_ARRIVAL_WRONG_FLOOR,                
    DISKCANGO_DONE_LACK_OF_WORKING_MEMORY,             
    DISKCANGO_DONE_UNKNOWN_ERROR,                      

    DISKCANGO_DONE_SUCCESS                             
};

enum DiskCanGoQueryType
{
    DISKCANGO_DONT_ADAPT_TO_STARTPOS,

    DISKCANGO_ADAPT_TO_STARTPOS
};


class BaseDiskCanGoQuery : public IAtomicQuery
{
public:
    static  QueryType GetStaticType() { return TypeDiskCanGo; }
    virtual QueryType GetType() const { return TypeDiskCanGo; }
    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 ----------------------------------

    DiskCanGoQueryResult   GetResult()             const;
    const Vec3f&           GetStartPos()           const;
    const Vec3f&           GetDestPos()            const;
    const NavTrianglePtr&  GetStartTrianglePtr()   const;
    const NavTrianglePtr&  GetDestTrianglePtr()    const;
    KyFloat32              GetRadius()             const;
    DiskCanGoQueryType     GetQueryType()          const;
    DynamicOutputMode      GetDynamicOutputMode()  const;
    QueryDynamicOutput*    GetQueryDynamicOutput() const;
    const WorldIntegerPos& GetStartIntegerPos()    const;
    const WorldIntegerPos& GetDestIntegerPos()     const;

    const PositionSpatializationRange& GetPositionSpatializationRange() const;

protected:
    BaseDiskCanGoQuery();
    virtual ~BaseDiskCanGoQuery() {}

    void BindToDatabase(Database* database);
    void Initialize(const Vec3f& startPos, const Vec3f& destPos, KyFloat32 radius);

    void SetStartTrianglePtr(const NavTrianglePtr& startTrianglePtr);
    void SetPositionSpatializationRange(const PositionSpatializationRange& positionSpatializationRange);
    void SetQueryType(DiskCanGoQueryType queryType);
    void SetDynamicOutputMode(DynamicOutputMode savingMode);
    void SetQueryDynamicOutput(QueryDynamicOutput* queryDynamicOutput);
    void SetStartIntegerPos(const WorldIntegerPos& startIntegerPos);
    void SetDestIntegerPos(const WorldIntegerPos& destIntegerPos);
    void SetResult(DiskCanGoQueryResult result);

    DiskCanGoQueryResult ConvertRayCanGoResultToDiskCanGoResult(RayCanGoQueryResult result);
    DiskCanGoQueryResult ConvertTraversalResultToDiskCanGoResult(TraversalResult traversalRC);

protected:
    WorldIntegerPos m_startIntegerPos;
    WorldIntegerPos m_destIntegerPos;

    Vec3f m_startPos3f; 
    Vec3f m_destPos3f;  

    NavTrianglePtr m_startTrianglePtr;

    NavTrianglePtr m_destTrianglePtr; 

    KyFloat32 m_radius; 

    PositionSpatializationRange m_positionSpatializationRange;

    DiskCanGoQueryType m_queryType;

    DiskCanGoQueryResult m_result; 

    DynamicOutputMode m_dynamicOutputMode; 

    Ptr<QueryDynamicOutput> m_queryDynamicOutput;
};

}

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



#endif //Navigation_BaseDiskCanGoQuery_H