Package spyre :: Module spyre :: Class Interface
[frames | no frames]

Type Interface

object --+
         |
        Interface

Known Subclasses:
BareBonesInterface

The interface encapsulates all the user interface behavior that an engine can exhibit.
Method Summary
  __init__(self, engine)
Initialize new instance.
  entryChange(self, entered)
The mouse moved into or out of the window.
  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.
  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.
  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.
  visibilityChange(self, visible)
The window had a visibility chnage.
    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
tuple defaultCamera: preferred camera class and default __init__ params

Method Details

__init__(self, engine)
(Constructor)

Initialize new instance.
Parameters:
engine - the engine
Overrides:
__builtin__.object.__init__

entryChange(self, entered)

The mouse moved into or out of the window.

keyPressed(self, key)

A key was pressed.
Parameters:
key - ascii value.

mouseDown(self, button, loc)

The specified mouse button was clicked while the mouse was at the given location.
Parameters:
button - which button was pressed
loc - x,y tuple with mouse position

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.

mouseUp(self, button, loc)

The specified mouse button was released while the mouse was at the given location.
Parameters:
button - which button was pressed
loc - x,y tuple with mouse position

setup(self)

Setup interface after components all exist.

visibilityChange(self, visible)

The window had a visibility chnage.

Class Variable Details

defaultCamera

preferred camera class and default __init__ params
Type:
tuple
Value:
(<class 'spyre.spyre.BasicCameraOrtho'>, ((5, 5, 5),))                 

Generated by Epydoc 2.1 on Sat Jan 07 17:58:16 2006 http://epydoc.sf.net