findfirstvisiblepositiononpathquery.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_FindFirstVisiblePositionOnPathQuery_H
#define Navigation_FindFirstVisiblePositionOnPathQuery_H

#include "gwnavruntime/queries/utils/basefindfirstvisiblepositiononpathquery.h"
#include "gwnavruntime/database/database.h"
#include "gwnavruntime/querysystem/workingmemcontainers/workingmemarray.h"
#include "gwnavruntime/visualsystem/displaylist.h"


namespace Kaim
{

template<class TraverseLogic>
class FindFirstVisiblePositionOnPathQuery : public BaseFindFirstVisiblePositionOnPathQuery
{
public:
    // ---------------------------------- Public Member Functions ----------------------------------

    FindFirstVisiblePositionOnPathQuery();
    virtual ~FindFirstVisiblePositionOnPathQuery() {}

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

    void BindToDatabase(Database* database);

    void Initialize(const PositionOnPath& startPositionOnPath, const PositionOnPath& endPositionOnPath, const Vec3f& visibilityStartPoint);

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

    void SetVisibilityStartTrianglePtr(const NavTrianglePtr& visibilityStartTrianglePtr);

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

    void SetSamplingDistance(KyFloat32 samplingDistance);

    void SetRayCanGoMarginMode(RayCanGoMarginMode rayCanGoMarginMode);


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

    virtual void Advance(WorkingMemory* workingMemory);

    void PerformQuery(WorkingMemory* workingMemory = KY_NULL);

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

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

private:
    CandidateValidationResult ValidateCandidate(
        RayCanGoQuery<TraverseLogic>& rayCanGoQuery, const PositionOnPath& candidate, WorkingMemory* workingMemory);

public:
    ScopedDisplayList* m_displayList;
};

// Small utility class that simply wrap a WorkingMemArray<PositionOnPath> to clean it correctly in destructor.
class PositionOnPathWorkingMemArray
{
public:
    PositionOnPathWorkingMemArray() {}

    KyResult BindToDatabase(WorkingMemory* workingMemory, KyUInt32 capacity)
    {
        m_array.Init(workingMemory);

        if (m_array.IsInitialized() == false)
            return KY_ERROR;

        return m_array.SetMinimumCapacity(capacity);
    }

    KyResult PushBack(const PositionOnPath& positionOnPath)
    {
        return m_array.PushBack(InternalPositionOnPath(positionOnPath));
    }

    void GetPositionOnPath(KyUInt32 index, PositionOnPath& positionOnPath) const
    {
        m_array[index].CopyToPositionOnPath(positionOnPath);
    }

    KyUInt32 GetCount() const { return m_array.GetCount(); }

private:
    class InternalPositionOnPath
    {
    public:
        InternalPositionOnPath(const PositionOnPath& positionOnPath)
        {
            positionOnPath.GetRawValues(m_path, m_position, m_onPathStatus, m_currentIndexOnPath, m_distanceToEndOfPath);
        }

        void CopyToPositionOnPath(PositionOnPath& positionOnPath) const
        {
            positionOnPath.SetRawValues(m_path, m_position, m_onPathStatus, m_currentIndexOnPath, m_distanceToEndOfPath);
        }

        Path* m_path;
        Vec3f m_position;
        PositionOnPathStatus m_onPathStatus;
        KyUInt32 m_currentIndexOnPath;
        KyFloat32 m_distanceToEndOfPath;
    };

    WorkingMemArray<InternalPositionOnPath> m_array;
};

//class PositionOnPathWorkingMemArray
//{
//public:
//  PositionOnPathWorkingMemArray(WorkingMemory* /*workingMemory*/, KyUInt32 /*capacity*/) {}
//
//  KyArray<PositionOnPath> m_array;
//};

}

#include "gwnavruntime/queries/findfirstvisiblepositiononpathquery.inl"


#endif // Navigation_FindFirstVisiblePositionOnPathQuery_H