circlearcsplinecomputationquery.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_CircleArcSplineComputationQuery_H
#define Navigation_CircleArcSplineComputationQuery_H

#include "gwnavruntime/querysystem/iquery.h"
#include "gwnavruntime/pathfollower/circlearcsplinecomputer.h"


namespace Kaim
{

enum CircleArcSplineComputationQueryResult
{
    CIRCLEARCSPLINECOMPUTATION_NOT_INITIALIZED = QUERY_NOT_INITIALIZED, 
    CIRCLEARCSPLINECOMPUTATION_NOT_PROCESSED   = QUERY_NOT_PROCESSED  , 

    CIRCLEARCSPLINECOMPUTATION_DONE_INVALIDINPUTS                     , 
    CIRCLEARCSPLINECOMPUTATION_DONE_COMPUTERINTERNALERROR             , 
    CIRCLEARCSPLINECOMPUTATION_DONE_COMPUTATION_CANCELED              , 

    CIRCLEARCSPLINECOMPUTATION_DONE_SUCCESS                             
};

class CircleArcSplineComputationQuery : public ITimeSlicedQuery
{
public:
    CircleArcSplineComputationQuery();
    virtual ~CircleArcSplineComputationQuery() {}

    static  QueryType GetStaticType() { return TypeCircleArcSplineComputation; }
    virtual QueryType GetType() const { return TypeCircleArcSplineComputation; }


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

    void BindToDatabase(Database* database);

    void Initialize(
        const Vec3f& startPosition, const ChannelSectionPtr& startSection,
        const Vec3f& endPosition, const ChannelSectionPtr& endSection);


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

    void SetStartConstraint(const Vec2f& constraint)            { m_startConstraint = constraint; }
    void SetEndConstraint(const Vec2f& constraint)              { m_endConstraint   = constraint; }
    void SetSplineConfig(const SplineComputationConfig& config) { m_splineConfig    = config;     }

    SplineComputationConfig& GetSplineConfig() { return m_splineConfig; }


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

    virtual void Advance(WorkingMemory* workingMemory);

    void PerformQuery(WorkingMemory* workingMemory = KY_NULL);

    virtual void ReleaseWorkingMemoryOnCancelDuringProcess(WorkingMemory* workingMemory = KY_NULL);


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

    const SplineComputationConfig& GetSplineConfig()           const { return m_splineConfig;       }
    const Vec3f&                   GetStartPos()               const { return m_startPosition;      }
    const Vec3f&                   GetEndPos()                 const { return m_endPosition;        }
    const ChannelSectionPtr&       GetStartChannelSectionPtr() const { return m_startSection;       }
    const ChannelSectionPtr&       GetEndChannelSectionPtr()   const { return m_endSection;         }


    CircleArcSplineComputationQueryResult             GetResult()               const { return m_result;                    }

    const CircleArcSplineComputer&                    GetComputer()             const { return m_computer;                  }
    CircleArcSplineComputationResult                  GetComputerResult()       const { return m_computerResult;            }
    KyUInt32                                          GetOutputCount()          const { return m_computer.GetOutputCount(); }
    const RadiusProfileCircleArcSplineComputerOutput& GetOutput(KyUInt32 index) const { return m_computer.GetOutput(index); }

protected:
    void SetResult(CircleArcSplineComputationQueryResult result) { m_result = result; }


protected:
    CircleArcSplineComputer m_computer;

    // Inputs & config
    SplineComputationConfig m_splineConfig;
    Vec3f                   m_startPosition;
    Vec3f                   m_endPosition;
    ChannelSectionPtr       m_startSection;
    ChannelSectionPtr       m_endSection;
    Vec2f                   m_startConstraint;
    Vec2f                   m_endConstraint;

    CircleArcSplineComputationQueryResult m_result;
    CircleArcSplineComputationResult      m_computerResult;


public:
    CircleArcSplineComputerVisualDebugConfig m_visualDebugConfig;
};

} // namespace Kaim

#endif //Navigation_CircleArcSplineComputationQuery_H