Crowd agent component, requires a CrowdManager component in the scene. When not set explicitly, agent's radius and height are defaulted to navigation mesh's agent radius and height, respectively. More...

#include <Urho3D/Navigation/CrowdAgent.h>

Inheritance diagram for Urho3D::CrowdAgent:

Public Member Functions
	CrowdAgent (Context *context)
	Construct.

	~CrowdAgent () override
	Destruct.

void	ApplyAttributes () override
	Apply attribute changes that can not be applied immediately. Called after scene load or a network update.

void	OnSetEnabled () override
	Handle enabled/disabled state change.

void	DrawDebugGeometry (bool depthTest)
	Draw debug geometry.

void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override
	Draw debug feelers.

void	SetVelocityCallback (const CrowdAgentVelocityCallback &callback)
	Set velocity callback.

const CrowdAgentVelocityCallback &	GetVelocityCallback () const
	Return current velocity callback.

void	SetHeightCallback (const CrowdAgentHeightCallback &callback)
	Set height callback.

const CrowdAgentHeightCallback &	GetHeightCallback () const
	Return current height callback.

void	SetTargetPosition (const Vector3 &position)

void	SetTargetVelocity (const Vector3 &velocity)

void	SetActualVelocity (const Vector3 &velocity)
	Set actual immediate velocity. Target is not affected.

void	ResetTarget ()
	Reset any target request for the specified agent. Note that the agent will continue to move into the current direction; set a zero target velocity to actually stop.

void	SetUpdateNodePosition (bool unodepos)

void	SetMaxAccel (float maxAccel)

void	SetMaxSpeed (float maxSpeed)

void	SetRadius (float radius)

void	SetHeight (float height)

void	SetQueryFilterType (unsigned queryFilterType)

void	SetObstacleAvoidanceType (unsigned obstacleAvoidanceType)

void	SetNavigationQuality (NavigationQuality val)

void	SetNavigationPushiness (NavigationPushiness val)

Vector3	GetPosition () const

Vector3	GetDesiredVelocity () const

Vector3	GetActualVelocity () const

const Vector3 &	GetTargetPosition () const

const Vector3 &	GetTargetVelocity () const

CrowdAgentRequestedTarget	GetRequestedTargetType () const

CrowdAgentState	GetAgentState () const

CrowdAgentTargetState	GetTargetState () const

bool	GetUpdateNodePosition () const

int	GetAgentCrowdId () const
	Return the agent id.

float	GetMaxAccel () const

float	GetMaxSpeed () const

float	GetRadius () const

float	GetHeight () const

unsigned	GetQueryFilterType () const

unsigned	GetObstacleAvoidanceType () const

NavigationQuality	GetNavigationQuality () const

NavigationPushiness	GetNavigationPushiness () const

bool	HasRequestedTarget () const

bool	HasArrived () const

bool	IsInCrowd () const

Public Member Functions inherited from Urho3D::Component
	Component (Context *context)
	Construct.

	~Component () override
	Destruct.

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
virtual void	OnCrowdVelocityUpdate (dtCrowdAgent ag, float pos, float dt)
	Handle crowd agent pre-update.

virtual void	OnCrowdPositionUpdate (dtCrowdAgent ag, float pos, float dt)
	Handle crowd agent being updated. It is called by CrowdManager::Update() via callback.

void	OnNodeSet (Node previousNode, Node currentNode) override
	Handle node being assigned.

void	OnSceneSet (Scene *scene) override
	Handle node being assigned.

void	OnMarkedDirty (Node *node) override

const dtCrowdAgent *	GetDetourCrowdAgent () const
	Get internal Detour crowd agent.

dtCrowdAgent *	GetEditableDetourCrowdAgent ()
	Get editable internal Detour crowd agent.

void	HandleNavigationTileAdded (StringHash eventType, VariantMap &eventData)
	Handle navigation mesh tile added.

Protected Member Functions inherited from Urho3D::Component
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 (CrowdAgent, Component)

void	UpdateParameters (unsigned scope=M_MAX_UNSIGNED)
	Update Detour crowd agent parameter.

int	AddAgentToCrowd (bool force=false)
	Add agent into crowd.

void	RemoveAgentFromCrowd ()
	Remove agent from crowd.

Private Attributes
WeakPtr< CrowdManager >	crowdManager_
	Crowd manager.

CrowdAgentVelocityCallback	velocityCallback_
	Velocity callback.

CrowdAgentHeightCallback	heightCallback_
	Height callback.

int	agentCrowdId_
	Crowd manager reference to this agent.

Vector3	targetPosition_
	Requested target position.

Vector3	targetVelocity_
	Requested target velocity.

CrowdAgentRequestedTarget	requestedTargetType_
	Requested target type.

bool	updateNodePosition_
	Flag indicating the node's position should be updated by Detour crowd manager.

float	maxAccel_
	Agent's max acceleration.

float	maxSpeed_
	Agent's max Velocity.

float	radius_
	Agent's radius, if 0 the navigation mesh's setting will be used.

float	height_
	Agent's height, if 0 the navigation mesh's setting will be used.

unsigned	queryFilterType_
	Agent's query filter type, it is an index to the query filter buffer configured in Detour crowd manager.

unsigned	obstacleAvoidanceType_
	Agent's obstacle avoidance type, it is an index to the obstacle avoidance array configured in Detour crowd manager. It is ignored when agent's navigation quality is not set to "NAVIGATIONQUALITY_HIGH".

NavigationQuality	navQuality_
	Agent's navigation quality. The higher the setting, the higher the CPU usage during crowd simulation.

NavigationPushiness	navPushiness_
	Agent's navigation pushiness. The higher the setting, the stronger the agent pushes its colliding neighbours around.

Vector3	previousPosition_
	Agent's previous position used to check for position changes.

CrowdAgentTargetState	previousTargetState_
	Agent's previous target state used to check for state changes.

CrowdAgentState	previousAgentState_
	Agent's previous agent state used to check for state changes.

bool	ignoreTransformChanges_
	Internal flag to ignore transform changes because it came from us, used in OnCrowdAgentReposition().

Friends
class	CrowdManager

void	CrowdAgentUpdateCallback (bool positionUpdate, dtCrowdAgent ag, float pos, float dt)

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 agent component, requires a CrowdManager component in the scene. When not set explicitly, agent's radius and height are defaulted to navigation mesh's agent radius and height, respectively.

Member Function Documentation

◆ GetActualVelocity()

Vector3 Urho3D::CrowdAgent::GetActualVelocity ( ) const

Return the agent's actual velocity.

◆ GetAgentState()

CrowdAgentState Urho3D::CrowdAgent::GetAgentState ( ) const

Return the agent's state.

◆ GetDesiredVelocity()

Vector3 Urho3D::CrowdAgent::GetDesiredVelocity ( ) const

Return the agent's desired velocity.

◆ GetHeight()

float Urho3D::CrowdAgent::GetHeight ( ) const

inline

Get the agent's height.

◆ GetMaxAccel()

float Urho3D::CrowdAgent::GetMaxAccel ( ) const

inline

Get the agent's max acceleration.

◆ GetMaxSpeed()

float Urho3D::CrowdAgent::GetMaxSpeed ( ) const

inline

Get the agent's max velocity.

◆ GetNavigationPushiness()

NavigationPushiness Urho3D::CrowdAgent::GetNavigationPushiness ( ) const

inline

Get the agent's navigation pushiness.

◆ GetNavigationQuality()

NavigationQuality Urho3D::CrowdAgent::GetNavigationQuality ( ) const

inline

Get the agent's navigation quality.

◆ GetObstacleAvoidanceType()

unsigned Urho3D::CrowdAgent::GetObstacleAvoidanceType ( ) const

inline

Get the agent's obstacle avoidance type.

◆ GetPosition()

Vector3 Urho3D::CrowdAgent::GetPosition ( ) const

Return the agent's position.

◆ GetQueryFilterType()

unsigned Urho3D::CrowdAgent::GetQueryFilterType ( ) const

inline

Get the agent's query filter type.

◆ GetRadius()

float Urho3D::CrowdAgent::GetRadius ( ) const

inline

Get the agent's radius.

◆ GetRequestedTargetType()

CrowdAgentRequestedTarget Urho3D::CrowdAgent::GetRequestedTargetType ( ) const

inline

Return the agent's requested target type, if any.

◆ GetTargetPosition()

const Vector3& Urho3D::CrowdAgent::GetTargetPosition ( ) const

inline

Return the agent's requested target position.

◆ GetTargetState()

CrowdAgentTargetState Urho3D::CrowdAgent::GetTargetState ( ) const

Return the agent's target state.

◆ GetTargetVelocity()

const Vector3& Urho3D::CrowdAgent::GetTargetVelocity ( ) const

inline

Return the agent's requested target velocity.

◆ GetUpdateNodePosition()

bool Urho3D::CrowdAgent::GetUpdateNodePosition ( ) const

inline

Return true when the node's position should be updated by the CrowdManager.

◆ HasArrived()

bool Urho3D::CrowdAgent::HasArrived ( ) const

Return true when the agent has arrived at its target.

◆ HasRequestedTarget()

bool Urho3D::CrowdAgent::HasRequestedTarget ( ) const

inline

Return true when the agent has a target.

◆ IsInCrowd()

bool Urho3D::CrowdAgent::IsInCrowd ( ) const

Return true when the agent is in crowd (being managed by a crowd manager).

◆ OnMarkedDirty()

void Urho3D::CrowdAgent::OnMarkedDirty ( Node * node )

overrideprotectedvirtual

Reimplemented from Urho3D::Component.

◆ RegisterObject()

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

static

Register object factory.

◆ SetHeight()

void Urho3D::CrowdAgent::SetHeight ( float height )

Set the agent's height.

◆ SetMaxAccel()

void Urho3D::CrowdAgent::SetMaxAccel ( float maxAccel )

Set the agent's max acceleration.

◆ SetMaxSpeed()

void Urho3D::CrowdAgent::SetMaxSpeed ( float maxSpeed )

Set the agent's max velocity.

◆ SetNavigationPushiness()

void Urho3D::CrowdAgent::SetNavigationPushiness ( NavigationPushiness val )

Set the agent's navigation pushiness.

◆ SetNavigationQuality()

void Urho3D::CrowdAgent::SetNavigationQuality ( NavigationQuality val )

Set the agent's navigation quality.

◆ SetObstacleAvoidanceType()

void Urho3D::CrowdAgent::SetObstacleAvoidanceType ( unsigned obstacleAvoidanceType )

Set the agent's obstacle avoidance type.

◆ SetQueryFilterType()

void Urho3D::CrowdAgent::SetQueryFilterType ( unsigned queryFilterType )

Set the agent's query filter type.

◆ SetRadius()

void Urho3D::CrowdAgent::SetRadius ( float radius )

Set the agent's radius.

◆ SetTargetPosition()

void Urho3D::CrowdAgent::SetTargetPosition ( const Vector3 & position )

Submit a new target position request for this agent.

◆ SetTargetVelocity()

void Urho3D::CrowdAgent::SetTargetVelocity ( const Vector3 & velocity )

Submit a new target velocity request for this agent.

◆ SetUpdateNodePosition()

void Urho3D::CrowdAgent::SetUpdateNodePosition ( bool unodepos )

Update the node position. When set to false, the node position should be updated by other means (e.g. using Physics) in response to the E_CROWD_AGENT_REPOSITION event.

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

Urho3D/Navigation/CrowdAgent.h
Urho3D/Navigation/CrowdAgent.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetActualVelocity()

◆ GetAgentState()

◆ GetDesiredVelocity()

◆ GetHeight()

◆ GetMaxAccel()

◆ GetMaxSpeed()

◆ GetNavigationPushiness()

◆ GetNavigationQuality()

◆ GetObstacleAvoidanceType()

◆ GetPosition()

◆ GetQueryFilterType()

◆ GetRadius()

◆ GetRequestedTargetType()

◆ GetTargetPosition()

◆ GetTargetState()

◆ GetTargetVelocity()

◆ GetUpdateNodePosition()

◆ HasArrived()

◆ HasRequestedTarget()

◆ IsInCrowd()

◆ OnMarkedDirty()

◆ RegisterObject()

◆ SetHeight()

◆ SetMaxAccel()

◆ SetMaxSpeed()

◆ SetNavigationPushiness()

◆ SetNavigationQuality()

◆ SetObstacleAvoidanceType()

◆ SetQueryFilterType()

◆ SetRadius()

◆ SetTargetPosition()

◆ SetTargetVelocity()

◆ SetUpdateNodePosition()