svs_simulation.entities.base_entities.SpatialEntity

Package svs_simulation :: Package entities :: Module base_entities :: Class SpatialEntity

[show private | hide private]

Class SpatialEntity

        Entity --+    
                 |    
BasicSpatialEntity --+
                     |
                    SpatialEntity

Known Subclasses:: SimAgentBaseClass, SimObject, GenericArea

A spatial entity is one which has spatial location and size.

Method Summary
	`__init__(self, _uid)`
	`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 BasicSpatialEntity
	`decode(self, data)` Applies encoded data to self.
	`encode(self)` Returns encoded representation of self.
	`setup(self, _uid)`
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.
	`getName(self)` If the entity has a name, return this, otherwise returns a name created from its class name and unique id.
	`handleSimEvent(self, event)` Handles event form simulation.
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.
	`startWorld(self, simTime)` Called when the simulation world starts running, or if an entity has been added to a world after it has started.
	`stopWorld(self, simTime)` Called when the simulation world stops running, or if an entity has been removed from a world after it has started.
	`updateWorld(self, simTime)` Called when the simulation world updates.

Method Details

enterStructure(self, structure)

Called when entity enters a new structure.

Overrides:: svs_simulation.entities.base_entities.Entity.enterStructure

enterWorld(self, world)

Called when entity is added to world.

Overrides:: svs_simulation.entities.base_entities.Entity.enterWorld

exitStructure(self, structure=None)

Called when entity leaves an existing structure.

isOverPoint(self, x, y)

Tests if the given coordinates lie within the world bounds of the entity.

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

http://epydoc.sf.net