Urho3D::CrowdAgent Class Reference

DetourCrowd Agent, requires a DetourCrowdManager in the scene. Agent's radius and height is set through the navigation mesh. More...

#include <CrowdAgent.h>

Inheritance diagram for Urho3D::CrowdAgent:

Collaboration diagram for Urho3D::CrowdAgent:

Public Member Functions
	CrowdAgent (Context *context)
	Construct.
virtual	~CrowdAgent ()
	Destruct.
virtual void	OnSetEnabled ()
	Handle enabled/disabled state change.
void	DrawDebugGeometry (bool)
	Draw debug geometry.
virtual void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
	Draw debug feelers.
void	SetNavigationFilterType (unsigned filterTypeID)
	Set the navigation filter type the agent will use.
bool	SetMoveTarget (const Vector3 &position)
	Submit a new move request for this agent.
bool	SetMoveVelocity (const Vector3 &velocity)
	Submit a new move velocity request for this agent.
void	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.
void	SetMaxAccel (float val)
	Set the agent's max acceleration.
void	SetMaxSpeed (float val)
	Set the agent's max velocity.
void	SetRadius (float val)
	Set the agent's radius.
void	SetHeight (float val)
	Set the agent's height.
void	SetNavigationQuality (NavigationQuality val)
	Set the agent's navigation quality.
void	SetNavigationPushiness (NavigationPushiness val)
	Set the agent's navigation pushiness.
unsigned	GetNavigationFilterType () const
	Get the navigation filter type this agent is using.
Vector3	GetPosition () const
	Return the agent's position.
Vector3	GetDesiredVelocity () const
	Return the agent's desired velocity.
Vector3	GetActualVelocity () const
	Return the agent's actual velocity.
const Vector3 &	GetTargetPosition () const
	Return the agent's target position.
CrowdAgentState	GetAgentState () const
	Return the agent's state.
CrowdTargetState	GetTargetState () const
	Return the agent's target state.
bool	GetUpdateNodePosition () const
	Return true when the node's position should be updated by the CrowdManager.
int	GetAgentCrowdId () const
	Return the agent id.
float	GetMaxSpeed () const
	Get the agent's max velocity.
float	GetMaxAccel () const
	Get the agent's max acceleration.
float	GetRadius () const
	Get the agent's radius.
float	GetHeight () const
	Get the agent's height.
NavigationQuality	GetNavigationQuality () const
	Get the agent's navigation quality.
NavigationPushiness	GetNavigationPushiness () const
	Get the agent's navigation pushiness.
PODVector< unsigned char >	GetAgentDataAttr () const
	Get serialized data of internal state.
void	SetAgentDataAttr (const PODVector< unsigned char > &value)
	Set serialized data of internal state.
Public Member Functions inherited from Urho3D::Component
	Component (Context *context)
	Construct.
virtual	~Component ()
	Destruct.
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 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.
void	SetAnimationEnabled (bool enable)
	Set animation enabled.
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.
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.
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 void	ApplyAttributes ()
	Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
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 Urho3D::StringHash	GetType () const =0
	Return type hash.
virtual Urho3D::StringHash	GetBaseType () const =0
	Return base class type hash.
virtual const Urho3D::String &	GetTypeName () const =0
	Return type name.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
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.
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
virtual void	OnCrowdAgentReposition (const Vector3 &newPos, const Vector3 &newDirection)
	Update the nodes position if updateNodePosition is set. Is called in DetourCrowdManager::Update().
virtual void	OnNodeSet (Node *node)
	Handle node being assigned.
virtual void	OnMarkedDirty (Node *node)
Protected Member Functions inherited from Urho3D::Component
virtual void	OnAttributeAnimationAdded ()
	Handle attribute animation added.
virtual void	OnAttributeAnimationRemoved ()
	Handle attribute animation removed.
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.
Protected Member Functions inherited from Urho3D::Animatable
virtual 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
	OBJECT (CrowdAgent)
void	AddAgentToCrowd ()
	Create or re-add.
void	RemoveAgentFromCrowd ()
	Remove.

Private Attributes
WeakPtr< DetourCrowdManager >	crowdManager_
	Detour crowd manager.
bool	inCrowd_
	Flag indicating agent is in DetourCrowd.
int	agentCrowdId_
	DetourCrowd reference to this agent.
unsigned int	targetRef_
	Reference to poly closest to requested target position.
Vector3	targetPosition_
	Actual target position, closest to that requested.
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	filterType_
	Agent's assigned navigation filter type, the actual filter is owned by the DetourCrowdManager the agent belongs to.
NavigationQuality	navQuality_
	Agent's NavigationAvoidanceQuality.
NavigationPushiness	navPushiness_
	Agent's Navigation Pushiness.
CrowdTargetState	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	DetourCrowdManager

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

DetourCrowd Agent, requires a DetourCrowdManager in the scene. Agent's radius and height is set through the navigation mesh.

Member Function Documentation

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

protectedvirtual

Todo:

Handle node transform being dirtied.

Reimplemented from Urho3D::Component.

Here is the call graph for this function:

---

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

• /home/travis/build/urho3d/Urho3D/Source/Urho3D/Navigation/CrowdAgent.h
• /home/travis/build/urho3d/Urho3D/Source/Urho3D/Navigation/CrowdAgent.cpp