AQFollowMouse

Kind of class: public class
Package:
Inherits from:
  • none
Classpath: org.asaplibrary.util.actionqueue.AQFollowMouse
File last modified: Wednesday, 11 May 2011, 18:52:10
Action method to let a DisplayObject follow the mouse pointer.

Summary

Instance methods
  • followMouse (inDO:DisplayObject, inDuration:Number = Number.NaN, inTimeDiv:Number = Number.NaN, inLocDiv:Number = Number.NaN, inOffsetX:Number = Number.NaN, inOffsetY:Number = Number.NaN, inCallBackFunction:Function = null) : Function
    • Lets a DisplayObject follow mouse movements.

Instance methods

followMouse

function followMouse(inDO:DisplayObject, inDuration:Number = Number.NaN, inTimeDiv:Number = Number.NaN, inLocDiv:Number = Number.NaN, inOffsetX:Number = Number.NaN, inOffsetY:Number = Number.NaN, inCallBackFunction:Function = null) : Function

Lets a DisplayObject follow mouse movements. Control parameters:

  • a time variable for delay effect
  • location variable for multiply effect
  • offset variable for setting a fixed distance to the mouse
  • callback function to get location feedback

Parameters
inDO :DisplayObject to move
inDuration :(optional) the number of seconds that the DisplayObject should move; default is 0 (infinite); use -1 for instant change
inTimeDiv :(optional) the reaction speed to mouse changes. Use 1.0 to set the inDO at the mouse location without delay. Use anything between 1.0 and 0 for a slowed down effect; default is 1.0.
inLocDiv :(optional) the translation factor of the mouse movements, relative to its parent's center point; an inLocDiv of 2 multiplies all x and y (difference) locations by 2. The visual effect works best if the parent has its (0,0) location at its center. The value should not be smaller than inTimeDiv (and is set automatically to the value of inTimeDiv if it is smaller); default (when nothing is set) is 1.0.
inOffsetX :(optional) the number of pixels to offset the clip horizontally from the mouse
inOffsetY :(optional) the number of pixels to offset the clip vertically from the mouse
inCallBackFunction:(optional) function reference to which the calculated value will be returned; this callback function passes 3 arguments: (DO, x, y )
Returns