Package svs_simulation :: Package terrain :: Module structures :: Class Plane
[show private | hide private]
[frames | no frames]

Class Plane

Known Subclasses:
FloorPlane, OutlinePlane, WallPlane

Generic component part of a structure.

Planes may be polygonal in form.
Method Summary
  __init__(self)
  containsPoint(self, x, y)
Tests if specified coordinates are present in plane.
  decode(self, data)
Applies encoded representation to self.
  encode(self)
Returns encoded representation of self.
  getVertices(self)
Returns a list of vertices for the outline of the plane.
  setOutline(self, vertices)
Defines outline of plane.
  setup(self)
  withinBounds(self, x, y)
Tests if specified coordinates are within the bounds of the plane.

Method Details

containsPoint(self, x, y)

Tests if specified coordinates are present in plane.

decode(self, data)

Applies encoded representation to self.

encode(self)

Returns encoded representation of self.

getVertices(self)

Returns a list of vertices for the outline of the plane.

setOutline(self, vertices)

Defines outline of plane.
Parameters:
vertices
           (type=array)

withinBounds(self, x, y)

Tests if specified coordinates are within the bounds of the plane.

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