Packagecom.fileitup.fisixengine.utils
Classpublic class MouseAttacher
ImplementsEngineObject

A class for quickly attaching an object to the mouse pointer.



Public Properties
 PropertyDefined by
  active : Boolean = true
MouseAttacher
  dynamicObject : Particle
MouseAttacher
  ease : Number
MouseAttacher
  mouseObject : DisplayObject
MouseAttacher
  parent : FisixEngine
MouseAttacher
Public Methods
 MethodDefined by
  
MouseAttacher(obj:Particle, mouse:DisplayObject, easing:Number)
Creates a MouseAttacher object
MouseAttacher
  
dispose():void
Disposes of the MouseAttacher.
MouseAttacher
  
unload():void
Removes the MouseAttacher from the simulation and disposes of it.
MouseAttacher
  
update():void
Updates the attached Particle.
MouseAttacher
Property detail
activeproperty
public var active:Boolean = true
dynamicObjectproperty 
public var dynamicObject:Particle
easeproperty 
public var ease:Number
mouseObjectproperty 
public var mouseObject:DisplayObject
parentproperty 
public var parent:FisixEngine
Constructor detail
MouseAttacher()constructor
public function MouseAttacher(obj:Particle, mouse:DisplayObject, easing:Number)

Creates a MouseAttacher object

Parameters
obj:Particle — The object you'd like to attach to the mouse (ie. Particle, Polygon)
 
mouse:DisplayObject — A Flash Particle to get the mouse coordinates from (ie. root)
 
easing:Number — A value 1 or greater which specifies the amount of easing to apply to the force added to the object. 1 means no easing at all, while higher values represent higher easing.
Method detail
dispose()method
public function dispose():void

Disposes of the MouseAttacher. Use this method only after you have removed the Attacher from the simulation. Or simply use unload()

See also

unload()method 
public function unload():void

Removes the MouseAttacher from the simulation and disposes of it. Use this function when you no longer need the Attacher.

update()method 
public function update():void

Updates the attached Particle. This function is automatically called by the engine.