Welcome to PyMT’s documentation!

PyMT is a Python library for developing NUI (new user interfaces, including multi-touch) enabled media rich applications.

The goal of PyMT is to provide a framework for quick and easy interaction design with a focus on rapid prototype development.

There is also a focus on logging tasks and sessions of user interaction to quantify data and allow the analysis and visualization of such data.

For more general information on PyMT, be sure to visit our website at http://pymt.txzone.net/.

Programming Guide of PyMT

In order to understand PyMT, you must first understand the underlying libraries that have been used to create it. The programming guide contains a basic introduction to each of these libraries, in addition to a few unique systems created specifically for PyMT.

You can access to the Programming Guide on the Wiki :

http://pymt.txzone.net/wiki/index.php/DevGuide/Index

API Documentation of PyMT

Release:0.4 Date:February 06, 2010

• API documentation for PyMT
  • PyMT: multitouch toolkit
    • Base: Main event loop, provider creation, window management...
    • 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
    • Geometric: module provide some class to handle 3D Mesh.
    • Gesture: Base for gesture recognition.
    • Loader: asynchronous loader, easily extensible.
    • Logger: the PyMT logger
    • Matrix: matrix implementation, used for scatter
    • Obj: handle 3D mesh
    • Plugins: basic plugins management, used for desktop examples
    • Texture: abstraction to handle GL texture, and region
    • Utils: generic toolbox
    • Vector: class to handle Vector operation.
  • Core: providers for image, text, video, audio, camera...
    • Audio: Load and play sound
    • Camera: Backend for acquiring camera image
    • Image: handle loading of images
    • Text: Handle drawing of text
    • VideoBase: base for implementing a video reader
  • 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...)
      • Double Tap: search touch for a double tap
      • Fix CCV: Work around the odd behaviour in CCV where every touch outside of the
      • Ignore list: ignore touch in some part on screen
      • Retain Touch: reuse touch to counter finger lost behavior
    • Providers: list of all input providers
      • MacTouch: Native support of MultitouchSupport framework for MacBook (MaxOSX platform)
      • Mouse: Mouse provider implementation
      • Tuio: TUIO input provider implementation
      • 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
  • 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
        • File browser: a filebrowser view + a popup file browser
        • 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)
        • TextInput: a text input who instance vkeyboard if needed
        • Video widget: provide a video container
        • VKeyboard: Virtual keyboard with custom layout support
      • Form package: label, button input, checkbox, slider...
        • Abstract form widget: base for every form widget
        • Form button: button for Form
        • Form checkbox: a simple checkbox
        • Form: a form container
        • Form input: one-line text input
        • Form label: A text-label with align support
        • Form slider: a slider based on MTSlider + MTLabel
      • Layout: arrange widget in a layout
        • Abstract layout: layout base for implementation
        • Box layout: arrange widget in horizontal or vertical
        • Grid layout: arrange widget in a grid
      • Button package: implement different type of button
      • Button matrix: a lightweight and optimized grid of buttons
      • Circular Slider: Using this you can make circularly shaped sliders
      • Container: easy way to convert a simple BaseObject into a widget
      • Coverflow: a coverflow widget
      • Dragable widget: a moveable widget over the window
      • Flippable Widget: A widget with 2 sides who can flip between the sides.
      • Gesture widget: a widget with on_gesture event implementation
      • Kinetic: kinetic abstraction
      • Label: a simple text label
      • Modal window: stop all interaction with background widget
      • ObjectDisplay: widget that handle fiducial object, and draw them
      • Vector slider: a radial slider that provide vector manipulation
      • Rectangle widget: draw a rectangle of his pos/size
      • Scatter package: provide lot of widgets based on scatter (base, svg, plane, image...)
      • Side panel: a panel widget that attach to a side of the screen
      • Slider package: provide multiple slider implementation (simple, xy, boundary...)
      • 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
    • Window package: provide a window + a touch display
    • Animation package: handle animation with ease in PyMT
      • Animation
        • Simple Animation
        • Complex Animations
    • Colors: css & themes
    • Factory: all widgets are registered through this factory
    • Parser: default parser from string to special type

Indices and tables

• Index
• Module Index
• Search Page