raycangoquery.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_RayCanGoQuery_H
#define Navigation_RayCanGoQuery_H

#include "gwnavruntime/queries/utils/baseraycangoquery.h"
#include "gwnavruntime/database/database.h"
#include "gwnavruntime/querysystem/workingmemcontainers/workingmemarray.h"

namespace Kaim
{

template<class TraverseLogic>
class RayCanGoQuery : public BaseRayCanGoQuery
{
public:
    // ---------------------------------- Public Member Functions ----------------------------------

    RayCanGoQuery();
    virtual ~RayCanGoQuery() {}

    // ---------------------------------- Functions to set up the query ----------------------------------

    void BindToDatabase(Database* database);

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

    // ---------------------------------- write accessors for query inputs ----------------------------------

    void SetStartTrianglePtr(const NavTrianglePtr& startTrianglePtr);

    void SetQueryDynamicOutput(QueryDynamicOutput* queryDynamicOutput);

    // ---------------------------------- write accessors for query parameters ----------------------------------

    void SetPositionSpatializationRange(const PositionSpatializationRange& positionSpatializationRange);

    void SetComputeCostMode(ComputeCostMode computeCostMode);

    void SetMarginMode(RayCanGoMarginMode marginMode);

    void SetDynamicOutputMode(DynamicOutputMode savingMode);

    // ---------------------------------- Query framework functions ----------------------------------

    virtual void Advance(WorkingMemory* workingMemory);

    void PerformQuery(WorkingMemory* workingMemory = KY_NULL);

    // ---------------------------------- Accessors ----------------------------------

    RayCanGoQueryResult   GetResult()             const;
    const Vec3f&          GetStartPos()           const;
    const Vec3f&          GetDestPos()            const;
    const NavTrianglePtr& GetStartTrianglePtr()   const;
    const NavTrianglePtr& GetDestTrianglePtr()    const;
    ComputeCostMode       GetComputeCostMode()    const;
    KyFloat32             GetComputedCost()       const;
    DynamicOutputMode     GetDynamicOutputMode()  const;
    QueryDynamicOutput*   GetQueryDynamicOutput() const;
    RayCanGoMarginMode    GetMarginMode()         const;

    const PositionSpatializationRange& GetPositionSpatializationRange() const;

public : // internal
    void PerformQueryWithInputCoordPos(WorkingMemory* workingMemory);
    void SetStartIntegerPos(const WorldIntegerPos& startIntegerPos);
    void SetDestIntegerPos(const WorldIntegerPos& destIntegerPos);
    const WorldIntegerPos& GetStartIntegerPos() const;
    const WorldIntegerPos& GetDestIntegerPos() const;
};

}

#include "gwnavruntime/queries/raycangoquery.inl"


#endif //Navigation_RayCanGoQuery_H