[packages/awesome-plugin-effect.git] / README

Effects

With the Effect "class", you can "tween" properties of objects or functions with different transitions
Its a port of the Mootools Fx classes.

Usage

Simple use (for tweening the opacity): 
see example-tweening-opacity.lua.

When using a function instead of an object it is important 
that the function can set and return your properties via a table.

Example (asuming you want to tween x and y of a client instance c):

	fx = Effect.create(function (geom) {
	  return c:geometry(geom)
	end
	fx:start({x = 10, y = 10})


My currently use

You can find a video of it on vimeo (http://vimeo.com/13056382)
See example-using.lua.
Commit	Line	Data
122ccd5d ZU	1	Effects
	2
	3	With the Effect "class", you can "tween" properties of objects or functions with different transitions
	4	Its a port of the Mootools Fx classes.
	5
	6	Usage
	7
	8	Simple use (for tweening the opacity):
	9	see example-tweening-opacity.lua.
	10
	11	When using a function instead of an object it is important
	12	that the function can set and return your properties via a table.
	13
	14	Example (asuming you want to tween x and y of a client instance c):
	15
	16	fx = Effect.create(function (geom) {
	17	return c:geometry(geom)
	18	end
	19	fx:start({x = 10, y = 10})
	20
	21
	22
	23
	24	My currently use
	25
	26	You can find a video of it on vimeo (http://vimeo.com/13056382)
	27	See example-using.lua.
	28