Packagesekati.display
Classpublic class ForceSprite
InheritanceForceSprite Inheritance InteractiveSprite Inheritance CoreSprite Inheritance flash.display.Sprite

ForceSprite provides an InteractiveSprite which have quasi-physics forces applied to it.



Public Properties
 PropertyDefined by
  ax : Number
X-axis acceleration.
ForceSprite
  ay : Number
Y-axis acceleration.
ForceSprite
  boundBottom : Number
[read-only] Bottom bounds (DisplayObject registration 0, 0).
ForceSprite
  boundLeft : Number
[read-only] Left bounds (DisplayObject registration 0,0).
ForceSprite
  boundRight : Number
[read-only] Right bounds (DisplayObject registration 0,0).
ForceSprite
  bounds : Rectangle
Rectangle value relative to the coordinates of the Sprite's parent that specify a constraint area for the DraggableSprite.
ForceSprite
  boundTop : Number
[read-only] Top bounds (DisplayObject registration 0,0).
ForceSprite
 Inheritedenabled : Boolean
Enabled property defines whether interactive eventing is available or not.
InteractiveSprite
  friction : Number
Frictional force being applied.
ForceSprite
  gravityX : Number
X-axis gravitational force being applied.
ForceSprite
  gravityY : Number
X-axis gravitational force being applied.
ForceSprite
  hasForce : Boolean
Boolean value which determines whether the force (frameHandler) is currently being applied.
ForceSprite
 InheritedinteractiveMode : Boolean
Specifies the mouse cursors modal state in the object as an interactive target via: buttonMode, mouseChildren & tabChildren.
CoreSprite
  isDraggable : Boolean
Boolean value which determines whether the object is able to be dragged/thrown.
ForceSprite
  mass : Number
The general mass of the object (decreases acceleration, increases friction).
ForceSprite
 Inheritedscale : Number
The scale value.
CoreSprite
Public Methods
 MethodDefined by
  
ForceSprite(vx:Number = 0, vy:Number = 0, mass:Number = 0.5, friction:Number = 0.8, gravityY:Number = 20, gravityX:Number = 0, bounds:Rectangle = null, isDraggable:Boolean = true, hasForce:Boolean = true)
ForceSprite Constructor
ForceSprite
 Inherited
addChildren(... args):void
Add multiple child DisplayObject's.
CoreSprite
  
collide():void
Handle a collision
ForceSprite
 Inherited
destroy():void
Clean up after thy self.
InteractiveSprite
 Inherited
toString():String
Return reflective output.
CoreSprite
Protected Methods
 MethodDefined by
 Inherited
click(e:MouseEvent = null):void
Stub: click event handler.
InteractiveSprite
 Inherited
configListeners(isAdd:Boolean = false):void
Event listener management.
InteractiveSprite
  
frameHandler(e:Event):void
Handle force logic.
ForceSprite
 Inherited
invalidate():void
Request a redraw, use for deferred rendering.
CoreSprite
 Inherited
offStage(e:Event = null):void
Remove the listeners when removed from the stage.
InteractiveSprite
 Inherited
onStage(e:Event = null):void
Add listeners when added to stage.
InteractiveSprite
 Inherited
out(e:MouseEvent = null):void
Stub: mouse out event handler.
InteractiveSprite
 Inherited
over(e:MouseEvent = null):void
Stub: mouse over event handler.
InteractiveSprite
  
press(e:MouseEvent = null):void
Stub: press event handler.
ForceSprite
  
release(e:MouseEvent = null):void
Stub: release event handler.
ForceSprite
  
releaseOutside(e:Event = null):void
Stub: release outside event handler.
ForceSprite
Property detail
axproperty
ax:Number  [read-write]

X-axis acceleration.

Implementation
    public function get ax():Number
    public function set ax(value:Number):void
ayproperty 
ay:Number  [read-write]

Y-axis acceleration.

Implementation
    public function get ay():Number
    public function set ay(value:Number):void
boundBottomproperty 
boundBottom:Number  [read-only]

Bottom bounds (DisplayObject registration 0, 0).

Implementation
    public function get boundBottom():Number
boundLeftproperty 
boundLeft:Number  [read-only]

Left bounds (DisplayObject registration 0,0).

Implementation
    public function get boundLeft():Number
boundRightproperty 
boundRight:Number  [read-only]

Right bounds (DisplayObject registration 0,0).

Implementation
    public function get boundRight():Number
boundsproperty 
bounds:Rectangle  [read-write]

Rectangle value relative to the coordinates of the Sprite's parent that specify a constraint area for the DraggableSprite.

If bounds has not been set the Canvas.stage bounds are automatically implemented instead.

Implementation
    public function get bounds():Rectangle
    public function set bounds(value:Rectangle):void
boundTopproperty 
boundTop:Number  [read-only]

Top bounds (DisplayObject registration 0,0).

Implementation
    public function get boundTop():Number
frictionproperty 
friction:Number  [read-write]

Frictional force being applied.

Implementation
    public function get friction():Number
    public function set friction(value:Number):void
gravityXproperty 
gravityX:Number  [read-write]

X-axis gravitational force being applied.

Implementation
    public function get gravityX():Number
    public function set gravityX(value:Number):void
gravityYproperty 
gravityY:Number  [read-write]

X-axis gravitational force being applied.

Implementation
    public function get gravityY():Number
    public function set gravityY(value:Number):void
hasForceproperty 
hasForce:Boolean  [read-write]

Boolean value which determines whether the force (frameHandler) is currently being applied.

Implementation
    public function get hasForce():Boolean
    public function set hasForce(value:Boolean):void
isDraggableproperty 
isDraggable:Boolean  [read-write]

Boolean value which determines whether the object is able to be dragged/thrown.

Implementation
    public function get isDraggable():Boolean
    public function set isDraggable(value:Boolean):void
massproperty 
mass:Number  [read-write]

The general mass of the object (decreases acceleration, increases friction).

Implementation
    public function get mass():Number
    public function set mass(value:Number):void
Constructor detail
ForceSprite()constructor
public function ForceSprite(vx:Number = 0, vy:Number = 0, mass:Number = 0.5, friction:Number = 0.8, gravityY:Number = 20, gravityX:Number = 0, bounds:Rectangle = null, isDraggable:Boolean = true, hasForce:Boolean = true)

ForceSprite Constructor

Parameters
vx:Number (default = 0) — the starting velocity (speed) of the object on the x-axis.
 
vy:Number (default = 0) — the starting velocity (speed) of the object on the y-axis.
 
mass:Number (default = 0.5) — the mass (density) of the object; this value is clamped between 0.1 - 0.9 however a safer relational range is 0.2 - 0.8 (Default: 0.5).
 
friction:Number (default = 0.8) — the friction (resistance) the object experiences when touching a bounds surface (Default: 0.8).
 
gravityY:Number (default = 20) — the X gravity (constant horizontal) the object experiences (Default: 0).
 
gravityX:Number (default = 0) — the Y gravity (constant vertical force) the object experiences (Default: 20).
 
bounds:Rectangle (default = null) — the bounds (confines) of movement for the object (Default: Canvas.stage).
 
isDraggable:Boolean (default = true) — determines whether the object is draggable or not (Default: true).
 
hasForce:Boolean (default = true) — whether force (acceleration, mass, gravity) are currently being applied to the object or not (Default: true).
Method detail
collide()method
public function collide():void

Handle a collision

frameHandler()method 
protected function frameHandler(e:Event):void

Handle force logic.

Parameters
e:Event
press()method 
protected override function press(e:MouseEvent = null):void

Stub: press event handler. Starts release-outside simulation via stage.MOUSE_UP & StageEvent.LEAVE.

Parameters
e:MouseEvent (default = null)
release()method 
protected override function release(e:MouseEvent = null):void

Stub: release event handler.

Parameters
e:MouseEvent (default = null)
releaseOutside()method 
protected override function releaseOutside(e:Event = null):void

Stub: release outside event handler.

Parameters
e:Event (default = null)