svs_simulation.agents.basic_agents.MovingAgent

Package svs_simulation :: Package agents :: Module basic_agents :: Class MovingAgent

[show private | hide private]

Class MovingAgent

        Entity --+                
                 |                
BasicSpatialEntity --+            
                     |            
         SpatialEntity --+        
                         |        
         SimAgentBaseClass --+    
                             |    
                      SimAgent --+
                                 |
                                MovingAgent

Agents moveemnt capabilities.

Method Summary
	`__init__(self)`
	`endPath(self)` Called when end of path is reached.
	`enterPathNode(self, node)` Called when the entity enters a new path node.
	`exitPathNode(self, node)` Called when the entity leaves a path node.
	`followPath(self, path, name, start, destination, reverse)` Sets path for entity to follow.
	`halt(self)` Stops movement.
	`move(self)` Starts movement.
	`moveToNextPathNode(self, node)` Starts agent moving towards specifed node on path.
	`setSteeringBehaviour(self, steeringClass)` Receives a class providing steering behaviour which is instantiated and applied to agent.
	`setTargetPoint(self, x, y)` Sets a target point for agent to move towards.
	`updateLocation(self, timeElapsed)` Updates agent location.
	`updateWorld(self, simTime)` Forwards `update` call from world.
Inherited from SimAgent
	`changeState(self, newState)` Changes current state in stateManager.
	`encode(self)` Returns encoded representation of self.
	`handleSimEvent(self, event)` Handles event from simulation.
	`setTask(self, taskClass)` Sets new task for agent.
	`startWorld(self, simTime)` Forwards `start` call from world.
	`stopWorld(self, simTime)` Forwards `stop` call from world.
Inherited from SimAgentBaseClass
	`__str__(self)` Returns string representation of object.
	`containsPoint(self, x, y)` Tests if coordinates are contaiend within structure bounds.
	`decode(self, data)` Applies encoded data to self.
	`getBoundsMaxX(self)` Returns maximum x coordinate from bounds.
	`getBoundsMaxY(self)` Returns maximum y coordinate from bounds.
	`getBoundsMinX(self)` Returns minimum x coordinate from bounds.
	`getBoundsMinY(self)` Returns minimum y coordinate from bounds.
	`getName(self)` Returns name for structure.
	`getWorldbounds(self)` Returns the bounds of the structure as mapped to the world coordinates.
	`setup(self, name)`
Inherited from SpatialEntity
	`enterStructure(self, structure)` Called when entity enters a new structure.
	`enterWorld(self, world)` Called when entity is added to world.
	`exitStructure(self, structure)` Called when entity leaves an existing structure.
	`isOverPoint(self, x, y)` Tests if the given coordinates lie within the world bounds of the entity.
	`locateInWorld(self)`
	`setDimensions(self, dimX, dimY)`
	`setLocation(self, x, y)`
Inherited from Entity
	`enterPartition(self, partition)` Called when entity enters a partition.
	`exitPartition(self, partition)` Called when entity is leaves a structure.
	`exitWorld(self, simTime)` Called when structure is removed world.
boolean	`isTagged(self)` Returns tag state.
	`placeInWorld(self)` Sets the structure and partition that the entity is within.
	`reportChange(self, data)` Forwards data representing change in entity to process handler.

Method Details

endPath(self)

Called when end of path is reached.

enterPathNode(self, node)

Called when the entity enters a new path node.

exitPathNode(self, node)

Called when the entity leaves a path node.

followPath(self, path=None, name=None, start=None, destination=None, reverse=False)

Sets path for entity to follow.

halt(self)

Stops movement.

move(self)

Starts movement.

moveToNextPathNode(self, node)

Starts agent moving towards specifed node on path.

setSteeringBehaviour(self, steeringClass)

Receives a class providing steering behaviour which is instantiated and applied to agent.

setTargetPoint(self, x, y)

Sets a target point for agent to move towards.

updateLocation(self, timeElapsed)

Updates agent location.

updateWorld(self, simTime)

Forwards update call from world.

Overrides:: svs_simulation.agents.basic_agents.SimAgent.updateWorld

Generated by Epydoc 2.1 on Thu Oct 20 15:30:26 2005

http://epydoc.sf.net