Package libavg :: Module avg

Module avg

The main libavg module.

Class Hierarchy for Node

Class Hierarchy for Bitmap

Class Hierarchy for Tracker and TrackerCalibrator

Class Hierarchy for Logger

Class Hierarchy for ConradRelais and ParPort

Classes
	AVGNode Root node of any avg tree.
	Anim Base class for all animations.
	AnimState One state of a StateAnim.
	AreaNode Base class for elements in the avg tree that define an area on the screen.
	AttrAnim
	Bitmap Class representing a rectangular set of pixels.
	Camera A node that displays the image of a camera.
	CircleNode
	ConradRelais Interface to one or more conrad relais cards connected to a serial port.
	ConstPoint2D A point in 2D space.
	ContinuousAnim Class that animates an attribute of a libavg node continuously and linearly.
	CurveNode
	DivNode A div node is a node that groups other nodes logically and visually.
	EaseInOutAnim Class that animates an attribute of a libavg node.
	Event Base class for user input events.
	FilledVectorNode
	Image A static raster image on the screen.
	KeyEvent Raised when a key is pressed or released.
	LineNode
	LinearAnim Class that animates an attribute of a libavg node by interpolating linearly between start and end values.
	Logger Interface to the logger used by the avg player.
	MeshNode
	MouseEvent Raised when a mouse-related event occurs.
	Node Base class for all elements in the avg tree.
	PanoImage A panorama image displayed in cylindrical projection.
	ParPort Used for low-level control of the parallel port's data, status and control lines.
	ParallelAnim Animation that executes several child animations at the same time.
	Player The class used to load and play avg files.
	Point2D A point in 2D space.
	PolyLineNode
	PolygonNode
	RasterNode Base class for all nodes that have a direct 2d raster representation.
	RectNode
	SimpleAnim Base class for animations that change libavg node attributes by interpolating over a set amount of time.
	Sound A sound played from a file.
	StateAnim Animation that executes one of several child animations depending on it's current state.
	TestHelper Miscelaneous routines used by tests.
	TouchEvent Raised when a touch or other tracking event occurs.
	Tracker A class that uses a camera to track moving objects.
	TrackerCalibrator Used to map display points to camera points by mapping a set of reference points.
	VectorNode
	Video Video nodes display a video file.
	WaitAnim Animation that simply does nothing for a specified duration.
	Words A words node displays formatted text.

Functions

fadeIn(...)
Fades the opacity of a node.

source code

fadeOut(...)
Fades the opacity of a node to zero.

source code

getMemoryUsage(...)
Returns the amount of memory used by the application in bytes.

source code

getNumRunningAnims(...)
Returns the total number of running attribute-based animations (this includes LinearAnim, EaseInOutAnim and ContinuousAnim).

source code

Variables
	A8B8G8R8 = `libavg.avg.pixelformat.A8B8G8R8`
	A8R8G8B8 = `libavg.avg.pixelformat.A8R8G8B8`
	B5G6R5 = `libavg.avg.pixelformat.B5G6R5`
	B8G8R8 = `libavg.avg.pixelformat.B8G8R8`
	B8G8R8A8 = `libavg.avg.pixelformat.B8G8R8A8`
	B8G8R8X8 = `libavg.avg.pixelformat.B8G8R8X8`
	CONTROL_AUTOFD = `libavg.avg.controllines.CONTROL_AUTOFD`
	CONTROL_INIT = `libavg.avg.controllines.CONTROL_INIT`
	CONTROL_SELECT = `libavg.avg.controllines.CONTROL_SELECT`
	CONTROL_STROBE = `libavg.avg.controllines.CONTROL_STROBE`
	CURSORDOWN = `libavg.avg.Type.CURSORDOWN`
	CURSORMOTION = `libavg.avg.Type.CURSORMOTION`
	CURSOROUT = `libavg.avg.Type.CURSOROUT`
	CURSOROVER = `libavg.avg.Type.CURSOROVER`
	CURSORUP = `libavg.avg.Type.CURSORUP`
	I8 = `libavg.avg.pixelformat.I8`
	IMG_CAMERA = `libavg.avg.TrackerImageID.IMG_CAMERA`
	IMG_DISTORTED = `libavg.avg.TrackerImageID.IMG_DISTORTED`
	IMG_FINGERS = `libavg.avg.TrackerImageID.IMG_FINGERS`
	IMG_HIGHPASS = `libavg.avg.TrackerImageID.IMG_HIGHPASS`
	IMG_HISTOGRAM = `libavg.avg.TrackerImageID.IMG_HISTOGRAM`
	IMG_NOHISTORY = `libavg.avg.TrackerImageID.IMG_NOHISTORY`
	KEYDOWN = `libavg.avg.Type.KEYDOWN`
	KEYMOD_ALT = `libavg.avg.KeyModifier.KEYMOD_ALT`
	KEYMOD_CAPS = `libavg.avg.KeyModifier.KEYMOD_CAPS`
	KEYMOD_CTRL = `libavg.avg.KeyModifier.KEYMOD_CTRL`
	KEYMOD_LALT = `libavg.avg.KeyModifier.KEYMOD_LALT`
	KEYMOD_LCTRL = `libavg.avg.KeyModifier.KEYMOD_LCTRL`
	KEYMOD_LMETA = `libavg.avg.KeyModifier.KEYMOD_LMETA`
	KEYMOD_LSHIFT = `libavg.avg.KeyModifier.KEYMOD_LSHIFT`
	KEYMOD_META = `libavg.avg.KeyModifier.KEYMOD_META`
	KEYMOD_MODE = `libavg.avg.KeyModifier.KEYMOD_MODE`
	KEYMOD_NONE = `libavg.avg.KeyModifier.KEYMOD_NONE`
	KEYMOD_NUM = `libavg.avg.KeyModifier.KEYMOD_NUM`
	KEYMOD_RALT = `libavg.avg.KeyModifier.KEYMOD_RALT`
	KEYMOD_RCTRL = `libavg.avg.KeyModifier.KEYMOD_RCTRL`
	KEYMOD_RESERVED = `libavg.avg.KeyModifier.KEYMOD_RESERVED`
	KEYMOD_RMETA = `libavg.avg.KeyModifier.KEYMOD_RMETA`
	KEYMOD_RSHIFT = `libavg.avg.KeyModifier.KEYMOD_RSHIFT`
	KEYMOD_SHIFT = `libavg.avg.KeyModifier.KEYMOD_SHIFT`
	KEYUP = `libavg.avg.Type.KEYUP`
	MOUSE = `libavg.avg.Source.MOUSE`
	NONE = `libavg.avg.Source.NONE`
	PARPORTDATA0 = `libavg.avg.DataBits.PARPORTDATA0`
	PARPORTDATA1 = `libavg.avg.DataBits.PARPORTDATA1`
	PARPORTDATA2 = `libavg.avg.DataBits.PARPORTDATA2`
	PARPORTDATA3 = `libavg.avg.DataBits.PARPORTDATA3`
	PARPORTDATA4 = `libavg.avg.DataBits.PARPORTDATA4`
	PARPORTDATA5 = `libavg.avg.DataBits.PARPORTDATA5`
	PARPORTDATA6 = `libavg.avg.DataBits.PARPORTDATA6`
	PARPORTDATA7 = `libavg.avg.DataBits.PARPORTDATA7`
	QUIT = `libavg.avg.Type.QUIT`
	R5G6B5 = `libavg.avg.pixelformat.R5G6B5`
	R8G8B8 = `libavg.avg.pixelformat.R8G8B8`
	R8G8B8A8 = `libavg.avg.pixelformat.R8G8B8A8`
	R8G8B8X8 = `libavg.avg.pixelformat.R8G8B8X8`
	RESIZE = `libavg.avg.Type.RESIZE`
	STATUS_ACK = `libavg.avg.statuslines.STATUS_ACK`
	STATUS_BUSY = `libavg.avg.statuslines.STATUS_BUSY`
	STATUS_ERROR = `libavg.avg.statuslines.STATUS_ERROR`
	STATUS_PAPEROUT = `libavg.avg.statuslines.STATUS_PAPEROUT`
	STATUS_SELECT = `libavg.avg.statuslines.STATUS_SELECT`
	TOUCH = `libavg.avg.Source.TOUCH`
	TRACK = `libavg.avg.Source.TRACK`
	X8B8G8R8 = `libavg.avg.pixelformat.X8B8G8R8`
	X8R8G8B8 = `libavg.avg.pixelformat.X8R8G8B8`
	YCbCr422 = `libavg.avg.pixelformat.YCbCr422`

Function Details

fadeIn(...)

source code

Fades the opacity of a node.

Parameters:

node - The node to fade.
duration - Length of the fade in milliseconds.
max - The opacity of the node at the end of the fade.
stopCallback - Function to call when the fade is over.

fadeOut(...)

source code

Fades the opacity of a node to zero.

Parameters:

node - The node to fade.
duration - Length of the fade in milliseconds.
stopCallback - Function to call when the fade is over.

getMemoryUsage(...)

source code

Returns the amount of memory used by the application in bytes. More precisely, this function returns the resident set size of the process in bytes. This does not include shared libraries or memory paged out to disk.

getNumRunningAnims(...)

source code

Returns the total number of running attribute-based animations (this includes LinearAnim, EaseInOutAnim and ContinuousAnim). Useful for debugging memory leaks.