Package svs_simulation :: Package network :: Module terrainproxies :: Class TerrainProxy
[show private | hide private]
[frames | no frames]

Class TerrainProxy

GenericTerrainObject --+    
                       |    
                 Terrain --+
                           |
                          TerrainProxy


Client-side proxy for terrain.
Method Summary
  __init__(self)
  decode(self, data, lod)
Creates terrain from encoded data.
  decodePartition(self, data)
Creates partition from encoded data.
dict encode(self)
Returns encoded model of self.
    Inherited from Terrain
  addLinkPath(self, linkPath)
Adds linkpath to terrain, if the path has not been mapped to specific structures it attempts to do this.
  addPartition(self, partition)
Adds a new partition to the terrain.
  addPath(self, path)
Adds a path to the terrain.
  addSimObjectToStructure(self, simObject, structureName)
Adds sim object to partition with specified name.
  addStructure(self, structure, partitionName)
Adds structure to partition with specified name.
  addTerrainNavigationNode(self, x, y)
Adds and returns new node to high-level navigation graph.
  createPartitionFromName(self, partitionName, bounds)
Create a new partition to the terrain with the speficied name.
  createSimObjectFromName(self, objectName, objectClass, structureName, vertices)
Creates structure to partition with specified name and eother wall or floorplane components.
  createStructureFromName(self, structureName, partitionName)
Creates structure in specified partition with specified name and either wall or floorplane components.
  decodePartitions(self, data)
Creates partitions from encoded data.
  decodePaths(self, data)
Creates paths from encoded data.
  encodeForProxy(self)
Returns simplified encoding of self, suitable for use by proxies.
dict encodePartitions(self, structures, objects, agents)
Returns encoded model of partitions.
dict encodePaths(self)
Returns encoded model of paths.
  getAllLinkPaths(self)
Returns a list of all resolved linkpaths for terrain.
  getAllPaths(self)
Returns a list of all paths for terrain.
  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.
  getPartition(self, partitionName)
Returns partition mathcing specified name.
  getPartitionAtPoint(self, x, y)
Returns partition containing specified coordinates.
  getPath(self, name, start, destination)
Retrieves path from path store.
  getStructureContainingPoint(self, x, y)
Returns the structure within which the specified coordinates are located.
  linkTerrainNavigationNodes(self, nodeList)
Creates edges between list of navigation nodes.
  prepareToRun(self)
Ensures that all necessary data is setup for terrain, makes sure linkpaths are resilved, etc.
  removeTerrainNavigationNode(self, node)
Removes node from high-level navigation graph.
  resolveBounds(self)
Checks the bounds of the terrain match its contents.
  setBoundsMaxX(self, newvalue)
Returns maximum x coordinate from bounds.
  setBoundsMaxY(self, newvalue)
Returns maximum y coordinate from bounds.
  setBoundsMinX(self, newvalue)
Sets minimum x coordinate from bounds.
  setBoundsMinY(self, newvalue)
Returns minimum y coordinate from bounds.
  setup(self, name, bounds, spaceX, spaceY, margin)
    Inherited from GenericTerrainObject
  addEntity(self, entity)
Adds entity to terrain object.
  addGraph(self, graphName, graph)
Adds new graph to object.
  containsPoint(self, x, y)
Tests if specified coordinates are present in area.
  getGraph(self, graphName)
Returns named graph.
  removeEntity(self, entity)
Adds entity to terrain object.
  update(self, simTime)
Updates self in response to simulation time.

Method Details

decode(self, data, lod=0)

Creates terrain from encoded data.

@type data:dict
Overrides:
svs_simulation.terrain.base_classes.Terrain.decode

decodePartition(self, data)

Creates partition from encoded data.

@type data:dict

encode(self)

Returns encoded model of self.
Returns:
dict
Overrides:
svs_simulation.terrain.base_classes.Terrain.encode

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