basediskcangoquery.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/querysystem/iquery.h"
#include "gwnavruntime/queries/utils/navmeshtraversalcommon.h"
#include "gwnavruntime/queries/utils/baseraycangoquery.h"

namespace Kaim
{

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; }
    static Ptr<BaseBlobHandler> CreateStaticQueryBlobHandler();

    virtual QueryType GetType() const { return TypeDiskCanGo; }
    virtual void BuildQueryBlob(BaseBlobHandler* blobHandler);
    virtual void InitFromQueryBlob(World* world, void* blob);
    virtual Ptr<BaseBlobHandler> CreateQueryBlobHandler() { return CreateStaticQueryBlobHandler(); }

    // ------------------------------ BindToDatabase ------------------------------

    void BindToDatabase(Database* database);

    // ------------------------------ input setters -----------------------------

    void Initialize(const Vec3f& startPos, const Vec3f& destPos, KyFloat32 radius);

    void SetStartTrianglePtr(const NavTrianglePtr& startTrianglePtr) { m_startTrianglePtr = startTrianglePtr; } 
    void SetDestTrianglePtr(const NavTrianglePtr& destTrianglePtr) { m_destTrianglePtr = destTrianglePtr; } 
    void SetQueryDynamicOutput(QueryDynamicOutput* queryDynamicOutput) { m_queryDynamicOutput = queryDynamicOutput; } 

    void SetStartIntegerPos(const WorldIntegerPos& startIntegerPos) { m_startIntegerPos = startIntegerPos; }
    void SetDestIntegerPos(const WorldIntegerPos& destIntegerPos) { m_destIntegerPos = destIntegerPos; }

    // ------------------------------ configuration setters ------------------------------

    void SetPositionSpatializationRange(const PositionSpatializationRange& range) { m_positionSpatializationRange = range; } 
    void SetDynamicOutputMode(DynamicOutputMode dynamicOutputMode) { m_dynamicOutputMode = dynamicOutputMode; }              

    void SetQueryType(DiskCanGoQueryType queryType) { m_queryType = queryType; }                                             

    // ------------------------------ results getter -----------------------------

    DiskCanGoQueryResult   GetResult()             const { return m_result;             }
    QueryDynamicOutput*    GetQueryDynamicOutput() const { return m_queryDynamicOutput; }

    // ------------------------------ inputs getters -----------------------------

    const Vec3f&           GetStartPos()           const { return m_startPos3f;         }
    const Vec3f&           GetDestPos()            const { return m_destPos3f;          }

    const NavTrianglePtr&  GetStartTrianglePtr()   const { return m_startTrianglePtr;   }
    const NavTrianglePtr&  GetDestTrianglePtr()    const { return m_destTrianglePtr;    }

    WorldIntegerPos        GetStartIntegerPos()    const { return m_startIntegerPos;    }
    WorldIntegerPos        GetDestIntegerPos()     const { return m_destIntegerPos;     }

    KyFloat32              GetRadius()             const { return m_radius;             }
    DiskCanGoQueryType     GetQueryType()          const { return m_queryType;          }

    // ------------------------------ configuration getters ------------------------------

    DynamicOutputMode GetDynamicOutputMode()  const { return m_dynamicOutputMode;  }
    const PositionSpatializationRange& GetPositionSpatializationRange() const { return m_positionSpatializationRange; }

protected:
    BaseDiskCanGoQuery();
    virtual ~BaseDiskCanGoQuery() {}
    void SetResult(DiskCanGoQueryResult result) { m_result = result; }
    DiskCanGoQueryResult ConvertRayCanGoResultToDiskCanGoResult(RayCanGoQueryResult result);
    DiskCanGoQueryResult ConvertTraversalResultToDiskCanGoResult(TraversalResult traversalRC);

protected:
    // ------------------------------ inputs -----------------------------
    // inputs members are cleared by BindToDatabase() and Initialize().

    Vec3f m_startPos3f;                
    NavTrianglePtr m_startTrianglePtr; 
    WorldIntegerPos m_startIntegerPos;

    Vec3f m_destPos3f;                
    NavTrianglePtr m_destTrianglePtr; 
    WorldIntegerPos m_destIntegerPos;

    KyFloat32 m_radius;               

    // ------------------------------ configuration -----------------------------
    // configuration members are cleared by BindToDatabase() but not by Initialize().

    PositionSpatializationRange m_positionSpatializationRange;

    DynamicOutputMode m_dynamicOutputMode;

    DiskCanGoQueryType m_queryType;

    // ------------------------------ results -----------------------------
    // results members are cleared by BindToDatabase() and Initialize().

    DiskCanGoQueryResult m_result;

    Ptr<QueryDynamicOutput> m_queryDynamicOutput;
};

}