API documentation for PyMT

• PyMT: Python Multitouch Toolkit
  • Accelerate: wrapper around _accelerate module, written in cython.
  • Base: Main event loop, provider creation, window management...
    • Examples
  • Base object: object with position and size attributes, with helpers
  • Cache Manager: cache object and delete them automaticly
  • Clock: a clock with scheduled events
  • Config: base for PyMT configuration file
  • Event: Event dispatch framework.
    • Event types
    • Attaching event handlers
    • Event handler stack
    • Dispatching events
  • Exception Manager: add/remove handler for exception in application
    • Examples
  • Geometry: facilities functions for geometry calculations
  • Gesture: Base for gesture recognition.
  • Loader: asynchronous loader, easily extensible.
    • Examples
  • Logger: the PyMT logger
  • Obj: handle 3D mesh from the OBJ format file.
  • Parser: default parser from string to special type
  • Plugins: basic plugins management, used for desktop examples
  • Resources: Search a file inside a list of paths
  • Texture: abstraction to handle GL texture, and region
  • Utils: generic toolbox
  • Vector: class to handle Vector operation.
  • WeakMethod: implementation of weakref for function and bounded method.
• C Extensions: All Cython module.
  • Accelerate: provide acceleration for some critical function of PyMT
  • Graphics: Lower level functions to draw in OpenGL.
    • User mode
    • Expert mode
  • Graphx: acceleration module
• Core: providers for image, text, video, audio, camera...
  • Audio: Load and play sound
  • Camera: Backend for acquiring camera image
  • Image: handle loading of images
  • Spelling: Provide abstracted access to a range of spellchecking backends.
  • SVG: handle loading of svg data
  • Text: Handle drawing of text
    • MarkupLabel: Handle drawing of text with markup
  • VideoBase: base for implementing a video reader
• Graphics: all low level function to draw object in OpenGL.
• Graphx: package to simplify drawing in OpenGL
  • Bezier: handle curve based on bezier path
  • Colors: manipulate colors
  • CSS: Draw shapes with css attributes !
  • Draw: primitive drawing
  • Fbo: abstraction to use hardware/software FrameBuffer object
  • Paint: brush, texturing...
  • Shader: abstract compilation and usage
  • Statements: OpenGL statement for the “with” keyword
  • Stencil: use stencil for mask drawing
• Input: All input providers (TUIO, WiiMote, Pen...)
  • Input Postproc: analyse and process input (double tap, ignore list...)
    • Dejitter: Prevent blob jittering.
    • Double Tap: search touch for a double tap
    • Ignore list: ignore touch in some part on screen
    • Retain Touch: reuse touch to counter finger lost behavior
  • Providers: list of all input providers
    • HIDInput: Native support of HID input from linux kernel
    • MacTouch: Native support of MultitouchSupport framework for MacBook (MaxOSX platform)
    • Mouse: Mouse provider implementation
    • MTDev: Native support of Multitouch device on Linux, using libmtdev.
    • Probe sysfs: Create input entry for each Multitouch hardware found (linux only).
    • Tuio: TUIO input provider implementation
    • WM_Touch/WM_Pen: common definitions for both input providers
    • WM_PEN: Support of WM_PEN message (Window platform)
    • WM_TOUCH: Support of WM_TOUCH message (Window platform)
  • Touch Factory: Factory of touch providers.
  • Touch Provider: Abstract class for a provider
  • Touch Shape: Represent the shape of the touch
  • Touch: Base for all touch objects
• Lib: some libraries used by PyMT
  • Homogeneous Transformation Matrices and Quaternions.
    • Requirements
    • Notes
    • References
    • Examples
• Modules: UI module you can plug on any running PyMT apps.
• UI package: base for all ui things
  • Widgets: all the pymt widgets
    • Composed: widgets composed by assembling core widgets
      • Color picker: a simple color picker with 3 slider
        • Examples
      • File browser: a filebrowser view + a popup file browser
        • Examples
      • Inner window: a lightweight window with fullscreen and resize ability
      • Kinetic List: Custom list with kinetic interaction
      • ModalPopup: a simple popup that use modal window
      • Popup: tiny popup with customizable content
      • Tabs widget: widget that provide tabs (like tabbed notebook)
      • TextArea: a multiline text input, based on TextInput
        • Examples
      • TextInput: a text input who instance vkeyboard if needed
        • Examples
      • Video widget: provide a video container
      • VKeyboard: Virtual keyboard with custom layout support
        • Examples
      • SpellVKeyboard: Virtual keyboard that provides spelling
        • Examples
    • Layout: arrange widget in a layout
      • Abstract layout: layout base for implementation
      • Anchor layout: Align child widget to a border or center.
      • Box layout: arrange widget in horizontal or vertical
      • Grid layout: arrange widget in a grid
      • ScreenLayout: display only one widget in fullscreen at time
    • Button package: implement different type of button
      • Examples
    • Button matrix: a lightweight and optimized grid of buttons
      • Examples
    • Circular Slider: Using this you can make circularly shaped sliders
    • Container: easy way to convert a simple BaseObject into a widget
      • Examples
    • Coverflow: a coverflow widget
      • Examples
    • Dragable widget: a moveable widget over the window
    • Flippable Widget: A widget with 2 sides who can flip between the sides.
      • Examples
    • Gesture widget: a widget with on_gesture event implementation
    • MTImage: MTImage displays an image on the screen that can be repositioned.
    • Kinetic: kinetic abstraction
    • List: a list with kinetic effect
    • Label: a simple text label
      • Examples
    • Modal window: stop all interaction with background widget
    • ObjectDisplay: widget that handle fiducial object, and draw them
      • Examples
    • Vector slider: a radial slider that provide vector manipulation
      • Examples
    • Rectangle widget: draw a rectangle of his pos/size
    • Scatter package: provide lot of widgets based on scatter (base, svg, plane, image...)
      • Examples
    • Side panel: a panel widget that attach to a side of the screen
    • Slider package: provide multiple slider implementation (simple, xy, boundary...)
      • Examples
    • Speech Bubble: a little speech bubble !
    • Stencil container: clip drawing of children to his container
    • SVG widget: widget that display an svg image
    • Widget: Base of every widget implementation.
    • XML widget: parse xml and create his children
      • Examples
  • Window package: provide a window + a touch display
  • Animation package: handle animation with ease in PyMT
    • Animation
      • Simple Animation
      • Complex Animations
  • Colors: css & themes
    • Examples
  • Factory: all widgets are registered through this factory