gatedefinitioncomputer.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.
*/

#ifndef Navigation_GateDefinitionComputer_H
#define Navigation_GateDefinitionComputer_H


#include "gwnavruntime/channel/gatedefinition.h"
#include "gwnavruntime/kernel/SF_RefCount.h"
#include "gwnavruntime/navmesh/identifiers/navtriangleptr.h"


namespace Kaim
{

class Database;
class WorkingMemory;
class Bubble;
class StringPulledEdge;
class StringPulledBubbleList;
class GateDefinitionArray;


class GateDefinitionComputerConfig
{
public:
    GateDefinitionComputerConfig() { SetDefaults(); }

    void SetDefaults();

    KyFloat32 m_turnSamplingAngleDeg;
};

enum GateDefinitionComputerResult
{
    GateDefinitionComputer_NotProcessed,

    GateDefinitionComputer_ComputingStartGateDefinition,
    GateDefinitionComputer_ComputingTurnGateDefinition,
    GateDefinitionComputer_ComputingEndGateDefinition,

    GateDefinitionComputer_Success,

    GateDefinitionComputer_Error_NoMargin,
    GateDefinitionComputer_Error_Clamping
};

class GateDefinitionComputer
{
public:
    GateDefinitionComputer()
        : m_traverseLogicUserData(KY_NULL)
        , m_database(KY_NULL)
        , m_stringPulledBubbleList(KY_NULL)
        , m_result(GateDefinitionComputer_NotProcessed)
        , m_channelMargin(0.0f)
        , m_turnSamplingAngleRad(0.0f)
        , m_internalBubbleCount(0)
        , m_bubbleIdx(0)
    {
        m_turnSamplingAngleRad = m_channelMargin * m_bubbleIdx;
    }

    void Initialize(Database* database, const StringPulledBubbleList& stringPulledBubbleList, GateDefinitionArray* gateDefinitionArray);
    bool IsFinished() const;
    GateDefinitionComputerResult GetResult() const;

    void* GetTraverseLogicUserData() const;
    void SetTraverseLogicUserData(void* traverseLogicUserData);

    template<class TraverseLogic>
    GateDefinitionComputerResult Advance(WorkingMemory* workingMemory);

private:
    void InitializeProcessing();

    template<class TraverseLogic>
    void ProcessStartGateDefinition(WorkingMemory* workingMemory);

    template<class TraverseLogic>
    void ProcessTurnGateDefinition(WorkingMemory* workingMemory);

    template<class TraverseLogic>
    void ProcessEndGateDefinition(WorkingMemory* workingMemory);

    template<class TraverseLogic>
    GateDefinitionComputerResult ComputeTurnGateDefinitions(const Bubble& bubble, const StringPulledEdge& prevEdge, const StringPulledEdge& nextEdge, WorkingMemory* workingMemory);

    template<class TraverseLogic>
    KyResult ClampPosition(Vec3f& pos, WorkingMemory* workingMemory);

private:
    void*                         m_traverseLogicUserData;

    Database*                     m_database;
    const StringPulledBubbleList* m_stringPulledBubbleList;
    Ptr<GateDefinitionArray>      m_gateDefinitionArray;

    GateDefinitionComputerResult m_result;

    // Internal values from parameters
    KyFloat32 m_channelMargin;
    KyFloat32 m_turnSamplingAngleRad;

    // Time-slicing
    KyUInt32 m_internalBubbleCount;
    KyUInt32 m_bubbleIdx;

    // Clamping
    Vec3f m_lastClampedPosition;
    NavTrianglePtr m_lastClampedPositionTriangle;


public:
    GateDefinitionComputerConfig m_computerConfig;
};

KY_INLINE bool GateDefinitionComputer::IsFinished() const
{
    return (
        (m_result == GateDefinitionComputer_Success)        ||
        (m_result == GateDefinitionComputer_Error_NoMargin) ||
        (m_result == GateDefinitionComputer_Error_Clamping)
        );
}

KY_INLINE GateDefinitionComputerResult GateDefinitionComputer::GetResult() const { return m_result; }
KY_INLINE void GateDefinitionComputer::SetTraverseLogicUserData(void* traverseLogicUserData) { m_traverseLogicUserData = traverseLogicUserData; }
KY_INLINE void* GateDefinitionComputer::GetTraverseLogicUserData() const { return m_traverseLogicUserData; }

} // namespace Kaim


#include "gwnavruntime/channel/gatedefinition.h"
#include "gwnavruntime/channel/bubble.h"
#include "gwnavruntime/channel/stringpulledbubblelist.h"
#include "gwnavruntime/kernel/SF_RefCount.h"
#include "gwnavruntime/queries/diskcastquery.h"
#include "gwnavruntime/queries/diskexpansionquery.h"
#include "gwnavruntime/queries/trianglefromposquery.h"

#include "gwnavruntime/channel/gatedefinitioncomputer.inl"


#endif // Navigation_GateDefinitionComputer_H