GTween

Supported platforms:
Available since: Gideros 2010-2011

Description

GTween is a light-weight instance oriented tween engine. This means that you instantiate tweens for specific purposes, and then reuse, update or discard them.

This is different than centralized tween engines where you "register" tweens with a global object. This provides a more familiar and useful interface for object oriented programmers.

GTween boasts a number of advanced features:

• frame and time based durations/positions which can be set per tween
• simple sequenced tweens using .nextTween
• pause and resume individual tweens or all tweens
• jump directly to the end or beginning of a tween with :toEnd() or :toBeginning()
• jump to any arbitrary point in the tween with :setPosition()
• complete, init, and change callbacks
• smart garbage collector interactions (prevents collection while active, allows collection if target is collected)
• easy to set up in a single line of code
• can repeat or reflect a tween a specified number of times
• deterministic, so setting a position on a tween will (almost) always result in predictable results

GTween (Gideros Tween) is more a Class than a plugin per se

To use the GTween library, add the following file to your project:

• Gtween.lua tip: right click and "Save Link As"

Note: GTween uses the Easing plugin so make sure to add it to your project Plugins

Example

--[[
Demonstration of GTween class

This code is MIT licensed, see http://www.opensource.org/licenses/mit-license.php
(C) 2010 - 2011 Gideros Mobile 
]]

require "easing"

application:setBackgroundColor(0x626262)

local sprite = Bitmap.new(Texture.new("box.png"))
stage:addChild(sprite)

GTween.new(
	sprite, 2,
	{
		x = 240,
	},
	{
		delay = 0.2,
		ease = easing.outBounce,
		repeatCount = 2,
		reflect = true,
	}
)

See also

Ftf_libs#GFX
Easing

Methods GTween.new creates a new GTween object GTween.stopAll stops all tweens GTween:deleteValue removes an end value from the tween GTween:getDelay gets the length of the delay in frames or seconds GTween:getInitValue returns the initial value for the specified property GTween:getPosition gets the position of the tween in frames or seconds GTween:getValue returns the end value for the specified property if one exists GTween:getValues returns the table of all end properties and their values GTween:init2 reads all of the initial values from target and calls the "onInit" callback GTween:isPaused returns the pause state of the tween GTween:resetValues clears all previous end values before setting the new ones GTween:setDelay sets the length of the delay in frames or seconds GTween:setPaused plays or pauses a tween GTween:setPosition sets the position of the tween in frames or seconds GTween:setValue sets the numeric end value for a property GTween:setValues shorthand method for making multiple setProperty calls GTween:swapValues swaps the init and end values for the tween GTween:toBeginning jumps the tween to its beginning and pauses it GTween:toEnd jumps the tween to its end and pauses it

Events Constants

---

• Main Page
• Lua API
• Main API
• Plugins