ipatheventlistobserver.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_IPathEventObserver_H
#define Navigation_IPathEventObserver_H

#include "gwnavruntime/kernel/SF_RefCount.h"
#include "gwnavruntime/base/memory.h"
#include "gwnavruntime/path/patheventlist.h"


namespace Kaim
{
class Bot;
class NavTag;

class IPathEventListObserver : public RefCountBase<IPathEventListObserver, MemStat_PathFollowing>
{
public:
    IPathEventListObserver() {}
    virtual ~IPathEventListObserver() {}

    enum FirstIntervalStatus
    {
        FirstIntervalIsNew,                    
        FirstIntervalIsExtensionOfPreviousLast 
    };

    virtual void OnPathEventListBuildingStageDone(Bot* bot, PathEventList& pathEventList, KyUInt32 startIdxOfFirstNewEventInterval, FirstIntervalStatus firstIntervalStatus) = 0;

    enum DestructionPurpose
    {
        PathIsBeeingCleared,              
        ReplacePathWithNewPath,           
        RecomputePathEventListForSamePath 
    };

    virtual void OnPathEventListDestroy(Bot* bot,  PathEventList& pathEventList, DestructionPurpose destructionPurpose) = 0;
};


class DefaultPathEventListObserver : public IPathEventListObserver
{
public:
    DefaultPathEventListObserver() {}

    virtual ~DefaultPathEventListObserver() {}

    virtual void OnPathEventListDestroy(Kaim::Bot* /*bot*/, Kaim::PathEventList& /*pathEventList*/, DestructionPurpose /*destructionPurpose*/) {}
    
    virtual void OnPathEventListBuildingStageDone(Kaim::Bot* /*bot*/, Kaim::PathEventList& /*pathEventList*/, KyUInt32 /*firstIndexOfNewEvent*/, FirstIntervalStatus /*firstIntervalStatus*/) {}
};

} // namespace Kaim

#endif // Navigation_IPathEventObserver_H