esys.pyvisi.renderers.vtk.box.Box

Package esys :: Package pyvisi :: Package renderers :: Package vtk :: Module box :: Class Box

[show private | hide private]

Type Box

object --+        
         |        
      Item --+    
             |    
          Item --+
                 |
                Box

Known Subclasses:: ClipBox

Generic class for Box objects

To define a box one specify one of three groups of things:

The bounds of the box: xmin, xmax, ymin, ymax, zmin, zmax
The dimensions and origin: width, height, depth and origin
The bottom left front and top right back corners: blf, trb

Method Summary
	`__init__(self)` Initialisation of the Box object
	`getBLF(self)` Get the current position of the bottom, left, front corner
	`getBounds(self)` Get the current bounds of the box
	`getDepth(self)` Get the current box depth
	`getHeight(self)` Get the current box height
	`getOrigin(self)` Get the current origin of the box
	`getTRB(self)` Get the current position of the top, right, back corner
	`getWidth(self)` Get the current box width
	`render(self)` Perform Box object specific (pre)rendering tasks
	`setBLF(self, bottom, left, front)` Set the position of the bottom, left, front corner
	`setBounds(self, xmin, xmax, ymin, ymax, zmin, zmax)` Set the bounds of the box
	`setDepth(self, depth)` Set the box depth
	`setHeight(self, height)` Set the box height
	`setOrigin(self, xo, yo, zo)` Set the origin of the box
	`setTRB(self, top, right, back)` Set the position of the top, right, back corner
	`setWidth(self, width)` Set the width of the box
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Method Details

init(self)
(Constructor)

Initialisation of the Box object

Overrides:: esys.pyvisi.renderers.vtk.item.Item.__init__

getBLF(self)

Get the current position of the bottom, left, front corner

getBounds(self)

Get the current bounds of the box

getDepth(self)

Get the current box depth

getHeight(self)

Get the current box height

getOrigin(self)

Get the current origin of the box

getTRB(self)

Get the current position of the top, right, back corner

getWidth(self)

Get the current box width

render(self)

Perform Box object specific (pre)rendering tasks

Overrides:: esys.pyvisi.item.Item.render

setBLF(self, bottom, left, front)

Set the position of the bottom, left, front corner

setBounds(self, xmin, xmax, ymin, ymax, zmin, zmax)

Set the bounds of the box

setDepth(self, depth)

Set the box depth

setHeight(self, height)

Set the box height

setOrigin(self, xo, yo, zo)

Set the origin of the box

setTRB(self, top, right, back)

Set the position of the top, right, back corner

setWidth(self, width)

Set the width of the box

Generated by Epydoc 2.1 on Thu Apr 27 11:16:12 2006

http://epydoc.sf.net