API usable from Tcl/Tk

This page describes the classes and procedures defined by the core GML library which are usable from the GmlTcl Tcl/Tk package.

Any functionality available but not documented here should be considered deprecated and will possibly disappear in a future release.

Contents

Common class interface
Main classes
Other procedures and classes

Common class interface

The classes defined by GmlTcl share the syntactic conventions used in Tk:

classes are commands, which either create instances or call class (or "static") methods; e.g.

myClass myObject      ;# instantiation of myClass
myClass --myMethod    ;# call of class method myMethod

objects are commands; their first argument is a method name, the following arguments are the method's arguments, e.g.:
```
myObject doTheMath 1234 -foo 57.8
```

All classes share (inherit from) a common interface, described below.

class methods

className --objects

Return the list of current instances of class className.

className --bind
className --bind eventName
className --bind eventName script

In its first form, return the list of events generated by this class. In its second form, return the list of scripts currently bound to eventName. In its last form, arrange for script to be evaluated when eventName is triggered by this class.

All classes define the events newObject and deleteObject, which happen respectively when an instance is created and deleted.

className --unbind eventName script

Remove script from the list of scripts to be evaluated when eventName is triggered.

instance methods

objectName dispose

Destroy object objName.

objectName bind
objectName bind eventName
objectName bind eventName script

In its first form, return the list of events generated by object objName. In its second form, return the list of scripts currently bound to eventName. In its last form, arrange for script to be evaluated when eventName is triggered by this object.

All objects define the event dispose, which occurs when the object is destroyed.

objectName unbind eventName script

Remove script from the list of scripts to be evaluated when eventName is triggered.

objectName newName eventName script

Main classes

gmlBitmap	manipulation of images
gmlGrabber	access to cameras and framegrabbers
gmlHistogram	representation of N-dimensional dense histograms
gmlConnexer	facility to analyse connectivity in a bitmap
gmlScanner	image processing primitives

Other procedures and classes

These currently lack further documentation, are subject to API changes, or aren't available on all platforms.

gmlCanvas, gmlHandles, and gmlTexture: Extension of the Tk Canvas widget, and supporting classes.
gmlConvexHull: Used to compute the convex hull of a set of 2D points.
gmlFingerFinder: Used by the finger tracker service to locate fingertips in images.
gmlPDFDocument: Used to render PDF documents. Not available on all platforms.
gmlEstimator: Monodimensional time filters, e.g a low-pass filter and a differentiation filter.
gmlServiceDiscovery: Used to perform dynamic service discovery using the DNS-SD conventions.
gmlTracker: Used e.g. by the finger and face trackers to track 2D points in space and time.
gmlUIMode: Used on MacOS X to control system-level UI elements.
gmlZlib: Interface to zlib, a basic compression library.