API Documentation | All Packages | All Classes | Index | Frames No Frames |
Class PropTween

Package | com.greensock.core
Class | public final class PropTween

Stores information about an individual property tween. There is no reason to use this class directly - TweenLite, TweenMax, and some plugins use it internally.
Copyright 2011, GreenSock. All rights reserved. This work is subject to the terms in http://www.greensock.com/terms_of_use.html or for corporate Club GreenSock members, the software agreement that was issued with the corporate membership.

Public Properties

| Property | Defined by
--- | --- | ---
|  | change : Number Amount to change (basically, the difference between the starting value and ending value) | PropTween
|  | isPlugin : Boolean If the target of the PropTween is a TweenPlugin, isPlugin should be true. | PropTween
|  | name : String Alias to associate with the PropTween which is typically the same as the property, but can be different, particularly for plugins. | PropTween
|  | nextNode : PropTween Next PropTween in the linked list | PropTween
|  | prevNode : PropTween Previous PropTween in the linked list | PropTween
|  | priority : int Priority in the rendering queue. | PropTween
|  | property : String Name of the property that is being tweened | PropTween
|  | start : Number Starting value | PropTween
|  | target : Object Target object | PropTween

Public Methods

| Method | Defined by
--- | --- | ---
|  | PropTween(target:Object, property:String, start:Number, change:Number, name:String, isPlugin:Boolean, nextNode:PropTween = null, priority:int = 0) Constructor | PropTween

Property detail

change | property

`public var change:Number`

Amount to change (basically, the difference between the starting value and ending value)

isPlugin | property |

`public var isPlugin:Boolean`

If the target of the PropTween is a TweenPlugin, isPlugin should be true.

name | property |

`public var name:String`

Alias to associate with the PropTween which is typically the same as the property, but can be different, particularly for plugins.

nextNode | property |

`public var nextNode:PropTween`

Next PropTween in the linked list

prevNode | property |

`public var prevNode:PropTween`

Previous PropTween in the linked list

priority | property |

`public var priority:int`

Priority in the rendering queue. The lower the value the later it will be tweened. Typically all PropTweens get a priority of 0, but some plugins must be rendered later (or earlier)

property | property |

`public var property:String`

Name of the property that is being tweened

start | property |

`public var start:Number`

Starting value

target | property |

`public var target:Object`

Target object

Constructor detail

PropTween | () | constructor

`public function PropTween(target:Object, property:String, start:Number, change:Number, name:String, isPlugin:Boolean, nextNode:PropTween = null, priority:int = 0)`

Constructor

Parameters

| `target:Object` — Target object
| `property:String` — Name of the property that is being tweened
| `start:Number` — Starting value
| `change:Number` — Amount to change (basically, the difference between the starting value and ending value)
| `name:String` — Alias to associate with the PropTween which is typically the same as the property, but can be different, particularly for plugins.
| `isPlugin:Boolean` — If the target of the PropTween is a TweenPlugin, isPlugin should be true.
| `nextNode:PropTween` (default = `null`)`` — Next PropTween in the linked list
| `priority:int` (default = `0`)`` — Priority in the rendering queue. The lower the value the later it will be tweened. Typically all PropTweens get a priority of 0, but some plugins must be rendered later (or earlier)