bhaveWanderAgent.h

Go to the documentation of this file.

/*
* Copyright 2010 Autodesk, Inc.  All rights reserved.
* Use of this software is subject to the terms of the Autodesk license agreement provided at the time of installation or download, 
* or which otherwise accompanies this software in either electronic or hard copy form.
*/

   



#ifndef KY_bhaveWanderAgent_H
#define KY_bhaveWanderAgent_H


#include <bhaveSim/bhaveSimDefines.h>
#include <kyruntime/agents/wandertraversal.h>
#include <kyruntime/graph/traversalmanager.h>
#include <bhaveSim/restrictedWanderTraversal.h>

#include <kyruntime/core/pointwrapper.h>
#include <kyruntime/graph/pointinfo_vertexsafeptr.h>
#include <vrfobjcore/vrfObject.h>


namespace Kaim
{

class GraphManager;
class PathFinder;



class DT_DLL_bhaveSim bhaveWanderAgent
{
   KY_DEFINE_NEW_DELETE_OPERATORS

   friend class WanderTraversal;

public:
   bhaveWanderAgent();

   ~bhaveWanderAgent();

   KyResult Initialize(Bot& bot, TraversalManager::ConfigId traversalConfigId, TraversalManager::ConfigId restrictedTraversalConfigId);

   void Clear();

   void ReInit();
   
   KyBool Think();

   void SetGraph(GraphManager& graphManager);
   
   const GraphManager* GetGraph() const { return m_graphManager; }
   
   WanderTraversal* GetTraversal() const { return m_traversal; }
   
   void SetSpeed(const KyFloat32 speed);
   
   KyFloat32 GetSpeed() const { return m_speed; }

   const PointWrapper& GetDestination() const { return m_destination; }

   void SetDestination(Kaim::Vec3f fixedDestination);
   
   KyBool HasArrived() const { return m_hasArrived;}
   
   KyFloat32 GetDestinationTimeStamp() const { return m_destinationTimeStamp; }

   DtVrfObject* wanderArea() const { return myWanderArea; }
   void setWanderArea(DtVrfObject* val);

   static void objectAboutToBeRemovedCallback(DtVrfObject*, void*);
   virtual void processObjectAboutToBeRemoved(DtVrfObject*);

private:
   KyBool ComputeDestination();


private:
   Bot* m_bot;

   BHAVE::DtRestrictedWanderTraversal* myRestrictedTraversal;
   TraversalManager::ConfigId myRestrictedTraversalConfigId;
   WanderTraversal* m_traversal;
   TraversalManager::ConfigId m_traversalConfigId;

   KyFloat32 m_destinationTimeStamp; //<Contains the date when destination was computed
   PointWrapper m_destination;
   PointInfo_VertexSafePtr m_destinationSafePtr;

   GraphManager* m_graphManager; //<Currently used graph

   PropagationBias_Wander m_bias;
   BHAVE::PropagationBias_RestrictedWander myRestrictedBias;

   KyBool m_hasArrived; //<Boolean flag activated when entity reached its target point
   KyFloat32 m_speed; //< Contains agents move speed
   DtVrfObject* myWanderArea;
   bool myUsingFixedDestination;

   bool myWanderAreaRemoved;
   bool myWarnedOnce;
};

} //Kaim

#endif