manualcontrolinterval.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_ManualControlInterval_H
#define Navigation_ManualControlInterval_H

#include "gwnavruntime/path/positiononlivepath.h"

namespace Kaim
{
class PathValidityInterval;
class Bot;

enum ManualControlStatus
{
    ManualControlStatus_NotInitialized,  
    ManualControlStatus_PositionInvalid, 
    ManualControlStatus_EventInvalid,    
    ManualControlStatus_Pending,         
    ManualControlStatus_Valid,           
};

// Beware that ManualControlInterval should not be maintain over several frames
// due to PositionOnLivePath members whose validity must be maintained by the Bot
class ManualControlInterval
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_Bot)
    KY_CLASS_WITHOUT_COPY(ManualControlInterval)

public:
    ManualControlInterval(Bot* bot);

    // Find the ManualControl entry and exit points based on the given NavTag
    ManualControlStatus Compute(const NavTag* navTag, const PositionOnLivePath& positionOnLivePath);
    ManualControlStatus Compute(const DynamicNavTag* navTag, const PositionOnLivePath& positionOnLivePath);

private:
    ManualControlStatus GetStatus(const PositionOnLivePath& positionOnLivePath) const;

    // Move to NavTag Entry
    // if already on the NavTag it will give the entry of the _current_ EventInterval that is backward from positionOnLivePath!
    // if not on the NavTag it will give the entry of the _next_ EventInterval that is forward from positionOnLivePath!
    template<class TNavTag> void MovePositionOnPathToCurrentOrNextNavTagEntry(const TNavTag* navTag, PositionOnLivePath& positionOnLivePath);

    // Move to NavTag Exit
    // if already on the NavTag it will give the exit of the _current_ EventInterval that is forward from positionOnLivePath!
    // if not on the NavTag it will give the exit of the _previous_ EventInterval that is backward from positionOnLivePath!
    template<class TNavTag> void MovePositionOnPathToCurrentOrPreviousNavTagExit(const TNavTag* navTag, PositionOnLivePath& positionOnLivePath);

    // Find the ManualControl entry and exit points based on the given NavTag
    // if m_progressOnLivePath already on the NavTag, it gives the previous entry and current exit
    // if m_progressOnLivePath not on the NavTag, it gives the next entry and next exit
    // Beware that ManualControlInterval should not be kept over several frames.
    template<class TNavTag> ManualControlStatus GetCurrentOrNextManualControlInterval(const TNavTag* navTag, const PositionOnLivePath& positionOnLivePath);

public: // internal
    ManualControlInterval() : m_pathValidityInterval(KY_NULL) {}
    void BindToPathValdityInterval(PathValidityInterval* pathValidityInterval);
    
    ManualControlStatus GetEnterStatus() const { return GetStatus(m_enterPos); }
    ManualControlStatus GetExitStatus() const;

    // Be sure to check GetEnterStatus() and GetExitStatus() first
    const PositionOnLivePath& GetEnterPositionOnLivePath() const { return m_enterPos; }
    const PositionOnLivePath& GetExitPositionOnLivePath() const { return m_exitPos; }
    const PositionOnPath& GetEnterPositionOnPath() const { return m_enterPos.GetPositionOnPath(); }
    const PositionOnPath& GetExitPositionOnPath() const { return m_exitPos.GetPositionOnPath(); }
    const Vec3f& GetEnterPosition() const { return m_enterPos.GetPosition(); }
    const Vec3f& GetExitPosition() const { return m_exitPos.GetPosition(); }

    void Clear()
    {
        m_enterPos.Clear();
        m_exitPos.Clear();
    }

    // event information are invalidated, but PositionOnPath are maintained
    void ClearEventListLocation()
    {
        m_enterPos.ClearEventListLocation();
        m_exitPos.ClearEventListLocation();
    }

    void FindLocationOnEventListFromScratch();

    // Should be called only if ExitPosition was pending by the PathProgressComputer
    void UpdatePendingExitPosition();


public: // internal
    PathValidityInterval* m_pathValidityInterval;
    PositionOnLivePath m_enterPos;
    PositionOnLivePath m_exitPos;
};

}

#endif