botneedfullcomputeflags.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: GUAL - secondary contact: NONE
#ifndef Navigation_BotNeedFullComputeFlags_H
#define Navigation_BotNeedFullComputeFlags_H

#include "gwnavruntime/base/memory.h"


namespace Kaim
{


class BotNeedFullComputeFlags
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_Bot)

public:
    // ---------------------------------- Public Member Functions ----------------------------------

    BotNeedFullComputeFlags() { SetDefaults(); }

    void SetDefaults()
    {
        m_pathEventListNeedFullCompute      = true;
        m_colliderCollectionNeedFullCompute = true;
        m_trajectoryNeedFullCompute         = true;
        m_trajectoryFailedToFollowPath     = false;
        m_pathEventListChangedLastUpdate    = false;
        m_spatializationNeedUpdate = true;
    }

    bool GetPathEventListNeedFullCompute()      const { return m_pathEventListNeedFullCompute;      }
    bool GetColliderCollectionNeedFullCompute() const { return m_colliderCollectionNeedFullCompute; }
    bool GetTrajectoryNeedFullCompute()         const { return m_trajectoryNeedFullCompute;         }
    bool GetTrajectoryFailedToFollowPath()      const { return m_trajectoryFailedToFollowPath;      }
    bool GetPathEventListChangedLastUpdate()    const { return m_pathEventListChangedLastUpdate;    }
    bool GetSpatializationNeedUpdate()          const { return m_spatializationNeedUpdate; }

    void PathHasChanged()
    {
        m_trajectoryFailedToFollowPath = false;
        m_pathEventListNeedFullCompute  = true;
        m_trajectoryNeedFullCompute     = true;
    }

    void PathEventListStartedFullCompute()
    {
        m_pathEventListNeedFullCompute = false; // ok PathEventList compute started
    }

    void PathEventListHasChanged()
    {
        m_pathEventListChangedLastUpdate = true;
    }

    void PathEventListUnchanged()
    {
        m_pathEventListChangedLastUpdate = false;
    }

    void TrajectoryHasBeenFullyRecomputed()
    {
        m_trajectoryNeedFullCompute = false;
    }

    void TrajectoryFailedToFollowPath()
    {
        m_trajectoryFailedToFollowPath = true;
    }

    void ColliderCollectionHasBeenFullyRecomputed()
    {
        m_colliderCollectionNeedFullCompute = false;
    }

    void EnableAvoidanceHasChanged()
    {
        // do nothing, avoidance is computed every frame
    }

    void PathEventListConfigHasChanged()
    {
        m_pathEventListNeedFullCompute = true;
        m_trajectoryNeedFullCompute    = true;
    }

    void ShortcutTrajectoryConfigHasChanged()
    {
        m_trajectoryNeedFullCompute = true;
    }

    void SplineTrajectoryConfigHasChanged()
    {
        m_trajectoryNeedFullCompute = true;
    }

    void TrajectoryModeHasChanged()
    {
        m_trajectoryNeedFullCompute = true;
    }

    void ColliderCollectorConfigHasChanged()
    {
        m_colliderCollectionNeedFullCompute = true;
        m_trajectoryNeedFullCompute         = true;
    }

    void AvoidanceConfigHasChanged()
    {
        // do nothing, avoidance is computed every frame
    }

    void DoComputeTrajectoryHasBecomeTrue()
    {
        m_trajectoryNeedFullCompute = true;
    }

    void PositionHasChanged()
    {
        m_spatializationNeedUpdate = true;
    }

    void SpatializationUpdated()
    {
        m_spatializationNeedUpdate = false;
    }

public:
    // ---------------------------------- Public Data Members ----------------------------------
    bool m_pathEventListNeedFullCompute;
    bool m_colliderCollectionNeedFullCompute;
    bool m_trajectoryNeedFullCompute;
    bool m_trajectoryFailedToFollowPath;
    bool m_pathEventListChangedLastUpdate;
    bool m_spatializationNeedUpdate;
};


} // namespace Kaim

#endif // Navigation_BotNeedFullComputeFlags_H