ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
fl.ik 

IKEvent  - AS3 Flash
Packagefl.ik
Classpublic class IKEvent
InheritanceIKEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The IKEvent class defines events related to objects that contain inverse kinematics (IK) armatures.


Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
  distance : Number
[read-only] The distance in pixels from the original position of the joint.
IKEvent
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  iterationCount : int
[read-only] Number of iterations of IK moves performed.
IKEvent
  joint : IKJoint
[read-only] The joint related to the event.
IKEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
  time : int
[read-only] The time elapsed in milliseconds since the previous dispatch of the IKEvent.
IKEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
IKEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
Creates an event object that contains information about IK events.
IKEvent
 Inherited
clone():Event
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  DISTANCE_LIMIT : String = "distanceLimit"
[static] Defines the value of the type property of a distanceLimit event object.
IKEvent
  ITERATION_LIMIT : String = "iterationLimit"
[static] Defines the value of the type property of an iterationLimit event object.
IKEvent
  SINGLE_STEP : String = "singleStep"
[static] Defines the value of the type property of a singleStep event object.
IKEvent
  TIME_LIMIT : String = "timeLimit"
[static] Defines the value of the type property of a timeLimit event object.
IKEvent
Property Detail

distance

property
distance:Number  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The distance in pixels from the original position of the joint.



Implementation
    public function get distance():Number

Related API Elements

IKMover.distanceLimit
IKJoint.position

iterationCount

property 
iterationCount:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Number of iterations of IK moves performed.



Implementation
    public function get iterationCount():int

Related API Elements

IKMover.iterationLimit

joint

property 
joint:IKJoint  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The joint related to the event.



Implementation
    public function get joint():IKJoint

Related API Elements

IKJoint class

time

property 
time:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The time elapsed in milliseconds since the previous dispatch of the IKEvent.



Implementation
    public function get time():int

Related API Elements

IKMover.timeLimit
Constructor Detail

IKEvent

()Constructor
public function IKEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Creates an event object that contains information about IK events. Event objects are passed as parameters to event listeners.

Parameters
type:String — The type of event. Event listeners can access this information through the inherited type property.
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling phase of the event flow. Event listeners can access this information through the inherited bubbles property.
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property.
Constant Detail

DISTANCE_LIMIT

Constant
public static const DISTANCE_LIMIT:String = "distanceLimit"

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Defines the value of the type property of a distanceLimit event object. Set limitByDistance and distanceLimit to trigger this event.

Related API Elements

fl.ik.IKMover.limitByDistance
fl.ik.IKMover.distanceLimit

ITERATION_LIMIT

Constant 
public static const ITERATION_LIMIT:String = "iterationLimit"

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Defines the value of the type property of an iterationLimit event object. Set limitByIteration and iterationLimit to trigger this event.

Related API Elements

fl.ik.IKMover.limitByIteration
fl.ik.IKMover.iterationLimit

SINGLE_STEP

Constant 
public static const SINGLE_STEP:String = "singleStep"

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Defines the value of the type property of a singleStep event object. This event is dispatched after each iteration of the IK movement, and can be used to track the progression of IK moves.

TIME_LIMIT

Constant 
public static const TIME_LIMIT:String = "timeLimit"

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Defines the value of the type property of a timeLimit event object. Set limitByTime and timeLimit to dispatch this event.

Related API Elements

fl.ik.IKMover.limitByTime
fl.ik.IKMover.timeLimit



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy