Package svs_simulation :: Package terrain :: Module special_areas :: Class GenericArea
[show private | hide private]
[frames | no frames]

Class GenericArea

        Entity --+        
                 |        
BasicSpatialEntity --+    
                     |    
         SpatialEntity --+
                         |
                        GenericArea

Known Subclasses:
AudioArea, SimDataArea

Base class for all specialised areas.
Method Summary
  __init__(self)
  __str__(self)
Returns string representation of structure.
  containsPoint(self, x, y)
Tests if coordinates are contaiend within structure bounds.
  decode(self, data)
Decodes data and applies it to self.
dict encode(self)
Returns encoded representation of self.
  enter(self, agent)
Responds to agent entering area.
  enterPartition(self, partition)
Called when structure is added to a partition.
  exit(self, agent)
Responds to agent leaving area.
  exitPartition(self, partition)
Called when structure is removed from a partition.
  getName(self)
Returns name for structure.
  setFloorplane(self, floorplane)
Sets floorplane and adjust bounds to contain it.
  setup(self, idtag, 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
  exitWorld(self, simTime)
Called when structure is removed world.
  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

__str__(self)
(Informal representation operator)

Returns string representation of structure.

containsPoint(self, x, y)

Tests if coordinates are contaiend within structure bounds.

decode(self, data)

Decodes data and applies it to self.
Overrides:
svs_simulation.entities.base_entities.BasicSpatialEntity.decode

encode(self)

Returns encoded representation of self.
Returns:
dict
Overrides:
svs_simulation.entities.base_entities.BasicSpatialEntity.encode

enter(self, agent)

Responds to agent entering area.

enterPartition(self, partition)

Called when structure is added to a partition.
Overrides:
svs_simulation.entities.base_entities.Entity.enterPartition

exit(self, agent)

Responds to agent leaving area.

exitPartition(self, partition)

Called when structure is removed from a partition.
Overrides:
svs_simulation.entities.base_entities.Entity.exitPartition

getName(self)

Returns name for structure. If the structure has no name retuens its idtag.
Overrides:
svs_simulation.entities.base_entities.Entity.getName

setFloorplane(self, floorplane)

Sets floorplane and adjust bounds to contain it.

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