Jump to content
GreenSock

Search In
  • More options...
Find results that contain...
Find results in...

Tween

.from()

.from( target:Object, vars:Object ) : Tween

[static] Static method for creating a Tween instance that tweens backwards - you define the BEGINNING values and the current values are used as the destination values which is great for doing things like animating objects onto the screen because you can set them up initially the way you want them to look at the end of the tween and then animate in from elsewhere.

Parameters

target: Object

Target object (or array of objects) whose properties should be affected. When animating DOM elements, the target can be: a single element, an array of elements, a jQuery object (or similar), or a CSS selector string like “#feature” or “h2.author”. GSAP will pass selector strings to a selector engine like jQuery or Sizzle, falling back to document.querySelectorAll().

vars: Object

An object defining the starting value for each property that should be tweened as well as any special properties like onCompleteease, etc. For example, to tween mc.x from 100 and mc.y from 200 and then call myFunction, do this:TweenMax.from(mc, 1, {x:100, y:200, onComplete:myFunction});

Returns : Tween

Returns a Tween that tweens from the given values to their current ones.

Details

gsap.from() is a shortcut for creating a new Tween() (although you would never explicitly create a tween by using Tween() since it is an internal class) and calling its from() method.

Static method for creating a Tween instance that tweens backwards - you define the beginning values and the current values are used as the destination values which is great for doing things like animating objects onto the screen because you can set them up initially the way you want them to look at the end of the tween and then animate in from elsewhere.

NOTE: By default, immediateRender is true in from() tweens, meaning that they immediately render their starting state regardless of any delay that is specified. You can override this behavior by passing immediateRender: false in the vars parameter so that it will wait to render until the tween actually begins (often the desired behavior when inserting into TimelineLite or TimelineMax instances). To illustrate the default behavior, the following code will immediately set the opacity of obj to 0 and then wait 2 seconds before tweening the opacity back to 1 over the course of 1.5 seconds:

  1. gsap.from(obj, {duration: 1.5, opacity: 0, delay: 2});

Since the target parameter can also be an array of objects, the following code will tween the opacity property of obj1, obj2, and obj3 from a value of 0 simultaneously:

  1. gsap.from([obj1, obj2, obj3], {duration: 1.5, opacity: 0});

Even though 3 objects are animating, there is still only one tween that is created. In order to stagger or offset the start times of each object animating, just use the stagger property:

  1. gsap.from([obj1, obj2, obj3], {
  2. duration: 1.5,
  3. opacity: 0,
  4. stagger: 0.5 //simple stagger of 0.5 seconds
  5. });
  6. //or get advanced:
  7. gsap.from([obj1, obj2, obj3], {
  8. duration: 1.5,
  9. opacity: 0,
  10. stagger: {
  11. amount: 2,
  12. from: "center",
  13. grid: "auto",
  14. onComplete: myFunction //define callbacks inside the stagger to make them apply to each sub-tween
  15. }
  16. });

For simple sequencing, you can use the delay special property (like gsap.from(obj, {duration: 1, opacity: 0, delay: 0.5})), but it is highly recommended that you consider using timeline for all but the simplest sequencing tasks. It allows you to append tweens one-after-the-other and then control the entire sequence as a whole. You can even have the tweens overlap as much as you want.

Copyright 2017, GreenSock. All rights reserved. This work is subject to theterms of useor for Club GreenSock members, the software agreement that was issued with the membership.
×