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:

Public Member Functions
	CrowdManager (Context *context)
	Construct.
	~CrowdManager () override
	Destruct.
void	ApplyAttributes () override
	Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override
	Draw the agents' pathing debug data.
void	DrawDebugGeometry (bool depthTest)
	Add debug geometry to the debug renderer.
void	SetVelocityCallback (const CrowdAgentVelocityCallback &callback)
	Set velocity callback.
void	SetPositionCallback (const CrowdAgentPositionCallback &callback)
	Set height callback.
void	UpdateAgentVelocity (CrowdAgent *agent, float timeStep, Vector3 &desiredVelocity, float &desiredSpeed) const
	Update agent velocity using velocity callback.
void	UpdateAgentPosition (CrowdAgent *agent, float timeStep, Vector3 &position) const
	Update agent Y position using height callback.
void	SetCrowdTarget (const Vector3 &position, Node *node=nullptr)
	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=nullptr)
	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=nullptr)
	Reset any crowd target for all crowd agents found in the specified node. Defaulted to scene node.
void	SetMaxAgents (unsigned maxAgents)
void	SetMaxAgentRadius (float maxAgentRadius)
void	SetNavigationMesh (NavigationMesh *navMesh)
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.
ea::vector< CrowdAgent * >	GetAgents (Node *node=nullptr, 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=nullptr)
	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 (ea::vector< 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=nullptr)
	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=nullptr)
	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=nullptr, Vector3 *hitNormal=nullptr)
	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=nullptr)
	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
float	GetMaxAgentRadius () const
NavigationMesh *	GetNavigationMesh () const
unsigned	GetNumQueryFilterTypes () const
unsigned	GetNumAreas (unsigned queryFilterType) const
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
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.
	~Component () override
	Destruct.
virtual void	OnSetEnabled ()
	Handle enabled/disabled state change.
AttributeScopeHint	GetEffectiveScopeHint () const
bool	Save (Serializer &dest) const override
	Save as binary data. Return true if successful.
bool	SaveXML (XMLElement &dest) const override
	Save as XML data. Return true if successful.
bool	SaveJSON (JSONValue &dest) const override
	Save as JSON data. Return true if successful.
virtual void	GetDependencyNodes (ea::vector< Node * > &dest)
	Return the depended on nodes to order network updates.
virtual bool	HasAuxiliaryData () const
virtual void	SerializeAuxiliaryData (Archive &archive)
	Serialize auxiliary data from/to the current block of the archive. May throw ArchiveException.
void	SetEnabled (bool enable)
void	Remove ()
	Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
unsigned	GetID () const
Node *	GetNode () const
Scene *	GetScene () const
	Return the scene the node belongs to.
bool	IsEnabled () const
bool	IsEnabledEffective () const
ea::string	GetFullNameDebug () const
	Return full component name for debugging. Unique for each component in the scene. Slow!
Component *	GetComponent (StringHash type) const
	Return component in the same scene node by type. If there are several, returns the first.
template<class T >
T *	GetComponent () const
	Template version of returning a component in the same scene node by type.
unsigned	GetIndexInParent () const
	Return index of this component in the node.
Public Member Functions inherited from Urho3D::Serializable
	Serializable (Context *context)
	Construct.
	~Serializable () override
	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 ObjectReflection *	GetReflection () const
	Return reflection used for serialization.
virtual const ea::vector< AttributeInfo > *	GetAttributes () const
	Return attribute descriptions, or null if none defined.
void	SerializeInBlock (Archive &archive) override
	Serialize content from/to archive. May throw ArchiveException.
void	SerializeInBlock (Archive &archive, bool serializeTemporary)
virtual bool	Load (Deserializer &source)
	Load from binary data. Return true if successful.
virtual bool	LoadXML (const XMLElement &source)
	Load from XML data. Return true if successful.
virtual bool	LoadJSON (const JSONValue &source)
	Load from JSON data. Return true if successful.
virtual bool	Load (const ea::string &resourceName)
	Load from binary resource.
virtual bool	LoadXML (const ea::string &resourceName)
	Load from XML resource.
virtual bool	LoadJSON (const ea::string &resourceName)
	Load from JSON resource.
virtual bool	LoadFile (const ea::string &resourceName)
	Load from resource of automatically detected type.
virtual bool	SaveDefaultAttributes (const AttributeInfo &attr) const
	Return whether should save default-valued attributes into XML. Default false.
bool	SetAttribute (unsigned index, const Variant &value)
bool	SetAttribute (const ea::string &name, const Variant &value)
	Set attribute by name. Return true if successfully set.
void	SetInstanceDefault (bool enable)
	(Internal use) Set instance-level default flag.
void	SetInstanceDefault (const ea::string &name, const Variant &defaultValue)
	(Internal use) Set instance-level default value. Allocate the internal data structure as necessary.
virtual Variant	GetInstanceDefault (const ea::string &name) const
	(Internal use) Get instance-level default value.
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)
Variant	GetAttribute (unsigned index) const
Variant	GetAttribute (const ea::string &name) const
	Return attribute value by name. Return empty if not found.
Variant	GetAttributeDefault (unsigned index) const
Variant	GetAttributeDefault (const ea::string &name) const
	Return attribute default value by name. Return empty if not found.
unsigned	GetNumAttributes () const
void	CopyAttributes (const Serializable *source, bool resetToDefault=true)
	Copy all attributes from another serializable.
SharedPtr< Serializable >	Clone (bool resetToDefault=true) const
	Clone this serializable.
bool	IsTemporary () const
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~Object () override
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
virtual const ea::string &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.
template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.
void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.
template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T 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 ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.
void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &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 ea::string &	GetCategory () const
void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.
void	SetBlockEvents (bool block)
	Block object from sending and receiving events.
bool	GetBlockEvents () const
	Return sending and receiving events blocking status.
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.
	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
int	AddRef ()
int	ReleaseRef ()
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.
bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.
bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Static Public Member Functions
static void	RegisterObject (Context *context)
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

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.
void	OnSceneSet (Scene *previousScene, Scene *scene) override
	Handle scene being assigned.
void	Update (float delta)
	Update the crowd simulation.
const dtCrowdAgent *	GetDetourCrowdAgent (int agent) const
	Get the detour crowd agent.
dtCrowdAgent *	GetEditableDetourCrowdAgent (int agent)
	Get editable 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	OnNodeSet (Node *previousNode, Node *currentNode)
	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)
void	SetNode (Node *node)
	Set scene node. Called by Node when creating the component.
Component *	GetFixedUpdateSource ()
	Return a component from the scene root that sends out fixed update events (either PhysicsWorld or PhysicsWorld2D). Return null if neither exists.
void	DoAutoRemove (AutoRemoveMode mode)
	Perform autoremove. Called by subclasses. Caller should keep a weak pointer to itself to check whether was actually removed, and return immediately without further member operations in that case.

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.
void	HandleComponentAdded (StringHash eventType, VariantMap &eventData)
	Handle component added in the scene to check for late addition of the navmesh.

Private Attributes
dtCrowd *	crowd_ {}
	Internal Detour crowd object.
CrowdAgentVelocityCallback	velocityCallback_
	Velocity callback.
CrowdAgentPositionCallback	positionCallback_
	Position callback.
WeakPtr< 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.
ea::vector< 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
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}
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.
Protected Attributes inherited from Urho3D::Serializable
ea::unique_ptr< VariantMap >	instanceDefaultValues_
	Attribute default value at each instance level.
bool	setInstanceDefault_
	When true, store the attribute value as instance's default value (internal use only).
bool	temporary_
	Temporary flag.
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

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

Member Function Documentation

GetMaxAgentRadius()

float Urho3D::CrowdManager::GetMaxAgentRadius ( ) const

inline

Get the maximum radius of any agent.

GetMaxAgents()

unsigned Urho3D::CrowdManager::GetMaxAgents ( ) const

inline

Get the maximum number of agents.

GetNavigationMesh()

NavigationMesh* Urho3D::CrowdManager::GetNavigationMesh ( ) const

inline

Get the Navigation mesh assigned to the crowd.

GetNumAreas()

unsigned Urho3D::CrowdManager::GetNumAreas

(

unsigned

queryFilterType

)

const

Get the number of configured area in the specified query filter type.

GetNumObstacleAvoidanceTypes()

unsigned Urho3D::CrowdManager::GetNumObstacleAvoidanceTypes ( ) const

inline

Get the number of configured obstacle avoidance types.

GetNumQueryFilterTypes()

unsigned Urho3D::CrowdManager::GetNumQueryFilterTypes ( ) const

inline

Get the number of configured query filter types.

RegisterObject()

void Urho3D::CrowdManager::RegisterObject ( Context *  context )

static

Register object factory.

SetMaxAgentRadius()

void Urho3D::CrowdManager::SetMaxAgentRadius

(

float

maxAgentRadius

)

Set the maximum radius of any agent.

SetMaxAgents()

void Urho3D::CrowdManager::SetMaxAgents

(

unsigned

maxAgents

)

Set the maximum number of agents.

SetNavigationMesh()

void Urho3D::CrowdManager::SetNavigationMesh

(

NavigationMesh *

navMesh

)

Assigns the navigation mesh for the crowd.

---

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

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