spyre.spyre.BasicInterface

Package spyre :: Module spyre :: Class BasicInterface

Type BasicInterface

    object --+        
             |        
     Interface --+    
                 |    
BareBonesInterface --+
                     |
                    BasicInterface

Known Subclasses:: PedestrianInterface, PivotingInterface

A basic interface supports quitting, pausing, stepping, zooming, and resizing.

Method Summary
	`__init__(self, engine)` Initialize new instance.
	`step(self, empty)` Advance engine one step only.
	`toggle(self, empty)` Toggle engine progress on/off.
	`zoomIn(self, empty)` Zoom in on principle camera.
	`zoomOut(self, empty)` Zoom out on principle camera.
Inherited from BareBonesInterface
	`entryChange(self, entered)` The mouse moved into or out of the window.
	`event(self, ev)` Handle all interface events (from Pygame events)
	`mouseDrag(self, button, loc)` The mouse was dragged to the specified location while the given mouse button was held down.
	`mouseMove(self, loc)` The mouse moved with no buttons pressed.
	`quit(self, empty)`
	`reset(self, empty)` Resets all cameras.
	`sizeDown(self, empty)` Decrease window size.
	`sizeUp(self, empty)` Increase window size.
	`visibilityChange(self, visible)` The window had a visibility chnage.
Inherited from Interface
	`keyPressed(self, key)` A key was pressed.
	`mouseDown(self, button, loc)` The specified mouse button was clicked while the mouse was at the given location.
	`mouseUp(self, button, loc)` The specified mouse button was released while the mouse was at the given location.
	`setup(self)` Setup interface after components all exist.
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)

Class Variable Summary
Inherited from Interface
`tuple`	`defaultCamera`: preferred camera class and default __init__ params

Method Details

init(self, engine)
(Constructor)

Initialize new instance.

Parameters:: engine - the engine

Overrides:: spyre.spyre.BareBonesInterface.__init__ (inherited documentation)

step(self, empty)

Advance engine one step only.

toggle(self, empty)

Toggle engine progress on/off.

zoomIn(self, empty)

Zoom in on principle camera.

zoomOut(self, empty)

Zoom out on principle camera.

Generated by Epydoc 2.1 on Sat Jan 07 17:58:16 2006