| Package | fl.ik |
| Class | public class IKMover |
| Inheritance | IKMover  EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
timeLimit, iterationLimit or distanceLimit values.
More examples
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| distanceLimit : Number
The maximum distance (in pixels) the IK engine should move for each iteration. | IKMover | ||
| iterationLimit : int
Specifies the maximum number of iterations the IK engine performs for each movement. | IKMover | ||
| limitByDistance : Boolean
Specifies whether the IK engine ends a movement after the
distanceLimit value is exceeded. | IKMover | ||
| limitByIteration : Boolean
Specifies whether the IK engine ends a movement after the
iterationLimit value is exceeded. | IKMover | ||
| limitByTime : Boolean
Specifies whether the IK engine ends a movement after a specified
timeLimit is exceeded. | IKMover | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| stepCount : int [read-only]
The number of iterations of the IK movement. | IKMover | ||
| timeLimit : int
Specifies the maximum time (in milliseconds) the IK engine performs the movement. | IKMover | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor for an IKMover object. | IKMover | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
Moves the associated IKJoint object to the target point,
updating all the related IKJoint objectss based on their IK constraints. | IKMover | ||
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
distanceLimit | property |
distanceLimit:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The maximum distance (in pixels) the IK engine should move for each iteration. This is calculated as the Euclidean distance:
sqrt(dx*dx + dy*dy)
Implementation
public function get distanceLimit():Number public function set distanceLimit(value:Number):voidRelated API Elements
iterationLimit | property |
iterationLimit:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the maximum number of iterations the IK engine performs for each movement.
The limitByIteration property must be set to true to use
the iterationLimit value.
If the limitByIteration property is true, the IK engine
runs through the specified number of iterations or until the IKJoint object reaches
the target point. If all of the "limitBy..." properties of this class are false,
the IK engine takes one step. If any of the "limitBy" properties are true, the
IK engine continues processing until the limits of that condition are reached or the end-effector is at the target.
Implementation
public function get iterationLimit():int public function set iterationLimit(value:int):voidRelated API Elements
limitByDistance | property |
limitByDistance:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies whether the IK engine ends a movement after the
distanceLimit value is exceeded.
Implementation
public function get limitByDistance():Boolean public function set limitByDistance(value:Boolean):voidRelated API Elements
limitByIteration | property |
limitByIteration:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies whether the IK engine ends a movement after the
iterationLimit value is exceeded.
Implementation
public function get limitByIteration():Boolean public function set limitByIteration(value:Boolean):voidRelated API Elements
limitByTime | property |
limitByTime:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies whether the IK engine ends a movement after a specified
timeLimit is exceeded.
Implementation
public function get limitByTime():Boolean public function set limitByTime(value:Boolean):voidRelated API Elements
stepCount | property |
timeLimit | property |
timeLimit:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the maximum time (in milliseconds) the IK engine performs the movement.
The limitByTime property must be set to true to use the
timeLimit value.
If the limitByTime property is true, the IK engine
runs for the specified number of milliseconds or until the IKJoint object reaches
the target point. If all of the "limitBy..." properties of this class are false,
the IK engine takes one step. If any of the "limitBy" properties are true, the
IK engine continues processing until the limits of that condition are reached or the end-effector is at the target.
Implementation
public function get timeLimit():int public function set timeLimit(value:int):voidRelated API Elements
IKMover | () | Constructor |
public function IKMover(endEffector:IKJoint, targetIn:Point)| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor for an IKMover object. For shape IKArmature objects, the targetIn point parameter is ignored by the constructor function.
endEffector:IKJoint — The IKJoint object to move.
| |
targetIn:Point — The starting coordinates for the movement. This point is similar
to a point on the stage of the Flash authoring tool where you can click on a symbol
that is part of an IKArmature object (not necessarily on a joint), move the
symbol, and consequently move the IKArmature object according to the constraints
established for the IKArmature object.
For example, you have a leg and a foot, and you want to move the foot from the
toe. If you specify a |
moveTo | () | method |
public function moveTo(targetIn:Point):*| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Moves the associated IKJoint object to the target point,
updating all the related IKJoint objectss based on their IK constraints.
The IKMover object moves the IKJoint object to the target point unless
the IKMover object determines that the point can't be reached because of
the established IKArmature constraints; or if the movement exceeds established
timeLimit, iterationLimit, or distanceLimit
values.
Parameters
targetIn:Point — The coordinate of the destination point
|
* |
Mon Nov 28 2011, 06:48 AM -08:00