Package svs_simulation :: Package entities :: Module base_entities :: Class BasicSpatialEntity
[show private | hide private]
[frames | no frames]

Class BasicSpatialEntity

Entity --+
         |
        BasicSpatialEntity

Known Subclasses:
SpatialEntity, Structure

A spatial entity is one which has spatial location and size.
Method Summary
  __init__(self, _uid)
  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.
  enterStructure(self, structure)
Called when entity enters a structure.
  enterWorld(self, world)
Called when entity is added to world.
  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

decode(self, data)

Applies encoded data to self.
Overrides:
svs_simulation.entities.base_entities.Entity.decode

encode(self)

Returns encoded representation of self.

@rtype:dict
Overrides:
svs_simulation.entities.base_entities.Entity.encode

Generated by Epydoc 2.1 on Thu Oct 20 15:30:27 2005 http://epydoc.sf.net