Urho3D::CrowdManager Class Reference

Crowd manager scene component. Should be added only to the root scene node. More...

#include <Urho3D/Navigation/CrowdManager.h>

Inheritance diagram for Urho3D::CrowdManager:

Collaboration diagram for Urho3D::CrowdManager:

Public Member Functions
	CrowdManager (Context *context)
	Construct.
virtual	~CrowdManager ()
	Destruct.
virtual void	ApplyAttributes ()
	Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
virtual void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
	Draw the agents' pathing debug data.
void	DrawDebugGeometry (bool depthTest)
	Add debug geometry to the debug renderer.
void	SetCrowdTarget (const Vector3 &position, Node *node=0)
	Set the crowd target position. The target position is set to all crowd agents found in the specified node. Defaulted to scene node.
void	SetCrowdVelocity (const Vector3 &velocity, Node *node=0)
	Set the crowd move velocity. The move velocity is applied to all crowd agents found in the specified node. Defaulted to scene node.
void	ResetCrowdTarget (Node *node=0)
	Reset any crowd target for all crowd agents found in the specified node. Defaulted to scene node.
void	SetMaxAgents (unsigned maxAgents)
	Set the maximum number of agents.
void	SetMaxAgentRadius (float maxAgentRadius)
	Set the maximum radius of any agent.
void	SetNavigationMesh (NavigationMesh *navMesh)
	Assigns the navigation mesh for the crowd.
void	SetQueryFilterTypesAttr (const VariantVector &value)
	Set all the query filter types configured in the crowd based on the corresponding attribute.
void	SetIncludeFlags (unsigned queryFilterType, unsigned short flags)
	Set the include flags for the specified query filter type.
void	SetExcludeFlags (unsigned queryFilterType, unsigned short flags)
	Set the exclude flags for the specified query filter type.
void	SetAreaCost (unsigned queryFilterType, unsigned areaID, float cost)
	Set the cost of an area for the specified query filter type.
void	SetObstacleAvoidanceTypesAttr (const VariantVector &value)
	Set all the obstacle avoidance types configured in the crowd based on the corresponding attribute.
void	SetObstacleAvoidanceParams (unsigned obstacleAvoidanceType, const CrowdObstacleAvoidanceParams &params)
	Set the params for the specified obstacle avoidance type.
PODVector< CrowdAgent * >	GetAgents (Node *node=0, bool inCrowdFilter=true) const
	Get all the crowd agent components in the specified node hierarchy. If the node is not specified then use scene node. When inCrowdFilter is set to true then only get agents that are in the crowd.
Vector3	FindNearestPoint (const Vector3 &point, int queryFilterType, dtPolyRef *nearestRef=0)
	Find the nearest point on the navigation mesh to a given point using the crowd initialized query extent (based on maxAgentRadius) and the specified query filter type.
Vector3	MoveAlongSurface (const Vector3 &start, const Vector3 &end, int queryFilterType, int maxVisited=3)
	Try to move along the surface from one point to another using the crowd initialized query extent (based on maxAgentRadius) and the specified query filter type.
void	FindPath (PODVector< Vector3 > &dest, const Vector3 &start, const Vector3 &end, int queryFilterType)
	Find a path between world space points using the crowd initialized query extent (based on maxAgentRadius) and the specified query filter type. Return non-empty list of points if successful.
Vector3	GetRandomPoint (int queryFilterType, dtPolyRef *randomRef=0)
	Return a random point on the navigation mesh using the crowd initialized query extent (based on maxAgentRadius) and the specified query filter type.
Vector3	GetRandomPointInCircle (const Vector3 &center, float radius, int queryFilterType, dtPolyRef *randomRef=0)
	Return a random point on the navigation mesh within a circle using the crowd initialized query extent (based on maxAgentRadius) and the specified query filter type. The circle radius is only a guideline and in practice the returned point may be further away.
float	GetDistanceToWall (const Vector3 &point, float radius, int queryFilterType, Vector3 *hitPos=0, Vector3 *hitNormal=0)
	Return distance to wall from a point using the crowd initialized query extent (based on maxAgentRadius) and the specified query filter type. Maximum search radius must be specified.
Vector3	Raycast (const Vector3 &start, const Vector3 &end, int queryFilterType, Vector3 *hitNormal=0)
	Perform a walkability raycast on the navigation mesh between start and end using the crowd initialized query extent (based on maxAgentRadius) and the specified query filter type. Return the point where a wall was hit, or the end point if no walls.
unsigned	GetMaxAgents () const
	Get the maximum number of agents.
float	GetMaxAgentRadius () const
	Get the maximum radius of any agent.
NavigationMesh *	GetNavigationMesh () const
	Get the Navigation mesh assigned to the crowd.
unsigned	GetNumQueryFilterTypes () const
	Get the number of configured query filter types.
unsigned	GetNumAreas (unsigned queryFilterType) const
	Get the number of configured area in the specified query filter type.
VariantVector	GetQueryFilterTypesAttr () const
	Return all the filter types configured in the crowd as attribute.
unsigned short	GetIncludeFlags (unsigned queryFilterType) const
	Get the include flags for the specified query filter type.
unsigned short	GetExcludeFlags (unsigned queryFilterType) const
	Get the exclude flags for the specified query filter type.
float	GetAreaCost (unsigned queryFilterType, unsigned areaID) const
	Get the cost of an area for the specified query filter type.
unsigned	GetNumObstacleAvoidanceTypes () const
	Get the number of configured obstacle avoidance types.
VariantVector	GetObstacleAvoidanceTypesAttr () const
	Return all the obstacle avoidance types configured in the crowd as attribute.
const CrowdObstacleAvoidanceParams &	GetObstacleAvoidanceParams (unsigned obstacleAvoidanceType) const
	Get the params for the specified obstacle avoidance type.
Public Member Functions inherited from Urho3D::Component
	Component (Context *context)
	Construct.
virtual	~Component ()
	Destruct.
virtual void	OnSetEnabled ()
	Handle enabled/disabled state change.
virtual bool	Save (Serializer &dest) const
	Save as binary data. Return true if successful.
virtual bool	SaveXML (XMLElement &dest) const
	Save as XML data. Return true if successful.
virtual bool	SaveJSON (JSONValue &dest) const
	Save as JSON data. Return true if successful.
virtual void	MarkNetworkUpdate ()
	Mark for attribute check on the next network update.
virtual void	GetDependencyNodes (PODVector< Node * > &dest)
	Return the depended on nodes to order network updates.
void	SetEnabled (bool enable)
	Set enabled/disabled state.
void	Remove ()
	Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
unsigned	GetID () const
	Return ID.
Node *	GetNode () const
	Return scene node.
Scene *	GetScene () const
	Return the scene the node belongs to.
bool	IsEnabled () const
	Return whether is enabled.
bool	IsEnabledEffective () const
	Return whether is effectively enabled (node is also enabled.)
Component *	GetComponent (StringHash type) const
	Return component in the same scene node by type. If there are several, returns the first.
void	GetComponents (PODVector< Component * > &dest, StringHash type) const
	Return components in the same scene node by type.
template<class T >
T *	GetComponent () const
	Template version of returning a component in the same scene node by type.
template<class T >
void	GetComponents (PODVector< T * > &dest) const
	Template version of returning components in the same scene node by type.
void	AddReplicationState (ComponentReplicationState *state)
	Add a replication state that is tracking this component.
void	PrepareNetworkUpdate ()
	Prepare network update by comparing attributes and marking replication states dirty as necessary.
void	CleanupConnection (Connection *connection)
	Clean up all references to a network connection that is about to be removed.
Public Member Functions inherited from Urho3D::Animatable
	Animatable (Context *context)
	Construct.
virtual	~Animatable ()
	Destruct.
virtual bool	LoadXML (const XMLElement &source, bool setInstanceDefault=false)
	Load from XML data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
virtual bool	LoadJSON (const JSONValue &source, bool setInstanceDefault=false)
	Load from JSON data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
void	SetAnimationEnabled (bool enable)
	Set automatic update of animation, default true.
void	SetAnimationTime (float time)
	Set time position of all attribute animations or an object animation manually. Automatic update should be disabled in this case.
void	SetObjectAnimation (ObjectAnimation *objectAnimation)
	Set object animation.
void	SetAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode=WM_LOOP, float speed=1.0f)
	Set attribute animation.
void	SetAttributeAnimationWrapMode (const String &name, WrapMode wrapMode)
	Set attribute animation wrap mode.
void	SetAttributeAnimationSpeed (const String &name, float speed)
	Set attribute animation speed.
void	SetAttributeAnimationTime (const String &name, float time)
	Set attribute animation time position manually. Automatic update should be disabled in this case.
void	RemoveObjectAnimation ()
	Remove object animation. Same as calling SetObjectAnimation with a null pointer.
void	RemoveAttributeAnimation (const String &name)
	Remove attribute animation. Same as calling SetAttributeAnimation with a null pointer.
bool	GetAnimationEnabled () const
	Return animation enabled.
ObjectAnimation *	GetObjectAnimation () const
	Return object animation.
ValueAnimation *	GetAttributeAnimation (const String &name) const
	Return attribute animation.
WrapMode	GetAttributeAnimationWrapMode (const String &name) const
	Return attribute animation wrap mode.
float	GetAttributeAnimationSpeed (const String &name) const
	Return attribute animation speed.
float	GetAttributeAnimationTime (const String &name) const
	Return attribute animation time position.
void	SetObjectAnimationAttr (const ResourceRef &value)
	Set object animation attribute.
ResourceRef	GetObjectAnimationAttr () const
	Return object animation attribute.
Public Member Functions inherited from Urho3D::Serializable
	Serializable (Context *context)
	Construct.
virtual	~Serializable ()
	Destruct.
virtual void	OnSetAttribute (const AttributeInfo &attr, const Variant &src)
	Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.
virtual void	OnGetAttribute (const AttributeInfo &attr, Variant &dest) const
	Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
virtual const Vector < AttributeInfo > *	GetAttributes () const
	Return attribute descriptions, or null if none defined.
virtual const Vector < AttributeInfo > *	GetNetworkAttributes () const
	Return network replication attribute descriptions, or null if none defined.
virtual bool	Load (Deserializer &source, bool setInstanceDefault=false)
	Load from binary data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful.
virtual bool	SaveDefaultAttributes () const
	Return whether should save default-valued attributes into XML. Default false.
bool	SetAttribute (unsigned index, const Variant &value)
	Set attribute by index. Return true if successfully set.
bool	SetAttribute (const String &name, const Variant &value)
	Set attribute by name. Return true if successfully set.
void	ResetToDefault ()
	Reset all editable attributes to their default values.
void	RemoveInstanceDefault ()
	Remove instance's default values if they are set previously.
void	SetTemporary (bool enable)
	Set temporary flag. Temporary objects will not be saved.
void	SetInterceptNetworkUpdate (const String &attributeName, bool enable)
	Enable interception of an attribute from network updates. Intercepted attributes are sent as events instead of applying directly. This can be used to implement client side prediction.
void	AllocateNetworkState ()
	Allocate network attribute state.
void	WriteInitialDeltaUpdate (Serializer &dest, unsigned char timeStamp)
	Write initial delta network update.
void	WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits, unsigned char timeStamp)
	Write a delta network update according to dirty attribute bits.
void	WriteLatestDataUpdate (Serializer &dest, unsigned char timeStamp)
	Write a latest data network update.
bool	ReadDeltaUpdate (Deserializer &source)
	Read and apply a network delta update. Return true if attributes were changed.
bool	ReadLatestDataUpdate (Deserializer &source)
	Read and apply a network latest data update. Return true if attributes were changed.
Variant	GetAttribute (unsigned index) const
	Return attribute value by index. Return empty if illegal index.
Variant	GetAttribute (const String &name) const
	Return attribute value by name. Return empty if not found.
Variant	GetAttributeDefault (unsigned index) const
	Return attribute default value by index. Return empty if illegal index.
Variant	GetAttributeDefault (const String &name) const
	Return attribute default value by name. Return empty if not found.
unsigned	GetNumAttributes () const
	Return number of attributes.
unsigned	GetNumNetworkAttributes () const
	Return number of network replication attributes.
bool	IsTemporary () const
	Return whether is temporary.
bool	GetInterceptNetworkUpdate (const String &attributeName) const
	Return whether an attribute's network updates are being intercepted.
NetworkState *	GetNetworkState () const
	Return the network attribute state, if allocated.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
virtual	~Object ()
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
	Return type hash.
virtual const String &	GetTypeName () const =0
	Return type name.
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.
bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
void	SubscribeToEvent (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData)
	Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers. More...
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
	Return global variable based on key.
const VariantMap &	GetGlobalVars () const
	Return all global variables.
void	SetGlobalVar (StringHash key, const Variant &value)
	Set global variable with the respective key and value.
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const String &	GetCategory () const
	Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
void	AddRef ()
	Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void	ReleaseRef ()
	Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int	Refs () const
	Return reference count.
int	WeakRefs () const
	Return weak reference count.
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.

Static Public Member Functions
static void	RegisterObject (Context *context)
	Register object factory.

Protected Member Functions
bool	CreateCrowd ()
	Create and initialized internal Detour crowd object. When it is a recreate, it preserves the configuration and attempts to re-add existing agents in the previous crowd back to the newly created crowd.
int	AddAgent (CrowdAgent *agent, const Vector3 &pos)
	Create and adds an detour crowd agent, Agent's radius and height is set through the navigation mesh. Return -1 on error, agent ID on success.
void	RemoveAgent (CrowdAgent *agent)
	Removes the detour crowd agent.
virtual void	OnSceneSet (Scene *scene)
	Handle scene being assigned.
void	Update (float delta)
	Update the crowd simulation.
const dtCrowdAgent *	GetDetourCrowdAgent (int agent) const
	Get the detour crowd agent.
const dtQueryFilter *	GetDetourQueryFilter (unsigned queryFilterType) const
	Get the detour query filter.
dtCrowd *	GetCrowd () const
	Get the internal detour crowd component.
Protected Member Functions inherited from Urho3D::Component
virtual void	OnAttributeAnimationAdded ()
	Handle attribute animation added.
virtual void	OnAttributeAnimationRemoved ()
	Handle attribute animation removed.
virtual void	OnNodeSet (Node *node)
	Handle scene node being assigned at creation.
virtual void	OnMarkedDirty (Node *node)
	Handle scene node transform dirtied.
virtual void	OnNodeSetEnabled (Node *node)
	Handle scene node enabled status changing.
void	SetID (unsigned id)
	Set ID. Called by Scene.
void	SetNode (Node *node)
	Set scene node. Called by Node when creating the component.
void	HandleAttributeAnimationUpdate (StringHash eventType, VariantMap &eventData)
	Handle scene attribute animation update event.
Component *	GetFixedUpdateSource ()
	Return a component from the scene root that sends out fixed update events (either PhysicsWorld or PhysicsWorld2D). Return null if neither exists.
Protected Member Functions inherited from Urho3D::Animatable
virtual Animatable *	FindAttributeAnimationTarget (const String &name, String &outName)
	Find target of an attribute animation from object hierarchy by name.
void	SetObjectAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode, float speed)
	Set object attribute animation internal.
void	OnObjectAnimationAdded (ObjectAnimation *objectAnimation)
	Handle object animation added.
void	OnObjectAnimationRemoved (ObjectAnimation *objectAnimation)
	Handle object animation removed.
void	UpdateAttributeAnimations (float timeStep)
	Update attribute animations.
bool	IsAnimatedNetworkAttribute (const AttributeInfo &attrInfo) const
	Is animated network attribute.
AttributeAnimationInfo *	GetAttributeAnimationInfo (const String &name) const
	Return attribute animation info.
void	HandleAttributeAnimationAdded (StringHash eventType, VariantMap &eventData)
	Handle attribute animation added.
void	HandleAttributeAnimationRemoved (StringHash eventType, VariantMap &eventData)
	Handle attribute animation removed.

Private Member Functions
	URHO3D_OBJECT (CrowdManager, Component)
void	HandleSceneSubsystemUpdate (StringHash eventType, VariantMap &eventData)
	Handle the scene subsystem update event.
void	HandleNavMeshChanged (StringHash eventType, VariantMap &eventData)
	Handle navigation mesh changed event. It can be navmesh being rebuilt or being removed from its node.

Private Attributes
dtCrowd *	crowd_
	Internal Detour crowd object.
NavigationMesh *	navigationMesh_
	NavigationMesh for which the crowd was created.
unsigned	navigationMeshId_
	The NavigationMesh component Id for pending crowd creation.
unsigned	maxAgents_
	The maximum number of agents the crowd can manage.
float	maxAgentRadius_
	The maximum radius of any agent that will be added to the crowd.
unsigned	numQueryFilterTypes_
	Number of query filter types configured in the crowd. Limit to DT_CROWD_MAX_QUERY_FILTER_TYPE.
PODVector< unsigned >	numAreas_
	Number of configured area in each filter type. Limit to DT_MAX_AREAS.
unsigned	numObstacleAvoidanceTypes_
	Number of obstacle avoidance types configured in the crowd. Limit to DT_CROWD_MAX_OBSTAVOIDANCE_PARAMS.

Friends
class	CrowdAgent

Additional Inherited Members
Protected Attributes inherited from Urho3D::Component
Node *	node_
	Scene node.
unsigned	id_
	Unique ID within the scene.
bool	networkUpdate_
	Network update queued flag.
bool	enabled_
	Enabled flag.

Detailed Description

Crowd manager scene component. Should be added only to the root scene node.

---

The documentation for this class was generated from the following files:

• Source/Urho3D/Navigation/CrowdManager.h
• Source/Urho3D/Navigation/CrowdManager.cpp