Package | sekati.display |
Class | public class ForceSprite |
Inheritance | ForceSprite InteractiveSprite CoreSprite flash.display.Sprite |
InteractiveSprite
which have quasi-physics forces applied to it.
Property | Defined 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 | ||
enabled : 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 : BooleanBoolean value which determines whether the force (frameHandler ) is currently being applied. | ForceSprite | ||
interactiveMode : Boolean
Specifies the mouse cursors modal state in the object as an interactive
target via:
buttonMode, mouseChildren & tabChildren . | CoreSprite | ||
isDraggable : BooleanBoolean 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 | ||
scale : Number
The
scale value. | CoreSprite |
Method | Defined 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 | ||
addChildren(... args):void
Add multiple child
DisplayObject 's. | CoreSprite | ||
collide():void
Handle a collision
| ForceSprite | ||
destroy():void
Clean up after thy self.
| InteractiveSprite | ||
toString():String
Return reflective output.
| CoreSprite |
Method | Defined by | ||
---|---|---|---|
click(e:MouseEvent = null):void
Stub: click event handler.
| InteractiveSprite | ||
configListeners(isAdd:Boolean = false):void
Event listener management.
| InteractiveSprite | ||
frameHandler(e:Event):void
Handle force logic.
| ForceSprite | ||
invalidate():void
Request a redraw, use for deferred rendering.
| CoreSprite | ||
offStage(e:Event = null):void
Remove the listeners when removed from the stage.
| InteractiveSprite | ||
onStage(e:Event = null):void
Add listeners when added to stage.
| InteractiveSprite | ||
out(e:MouseEvent = null):void
Stub: mouse out event handler.
| InteractiveSprite | ||
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 |
ax | property |
ax:Number
[read-write]X-axis acceleration.
Implementation public function get ax():Number
public function set ax(value:Number):void
ay | property |
ay:Number
[read-write]Y-axis acceleration.
Implementation public function get ay():Number
public function set ay(value:Number):void
boundBottom | property |
boundBottom:Number
[read-only]
Bottom bounds (DisplayObject
registration 0, 0
).
public function get boundBottom():Number
boundLeft | property |
boundLeft:Number
[read-only]
Left bounds (DisplayObject
registration 0,0
).
public function get boundLeft():Number
boundRight | property |
boundRight:Number
[read-only]
Right bounds (DisplayObject
registration 0,0
).
public function get boundRight():Number
bounds | property |
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.
public function get bounds():Rectangle
public function set bounds(value:Rectangle):void
boundTop | property |
boundTop:Number
[read-only]
Top bounds (DisplayObject
registration 0,0
).
public function get boundTop():Number
friction | property |
friction:Number
[read-write]Frictional force being applied.
Implementation public function get friction():Number
public function set friction(value:Number):void
gravityX | property |
gravityX:Number
[read-write]X-axis gravitational force being applied.
Implementation public function get gravityX():Number
public function set gravityX(value:Number):void
gravityY | property |
gravityY:Number
[read-write]X-axis gravitational force being applied.
Implementation public function get gravityY():Number
public function set gravityY(value:Number):void
hasForce | property |
hasForce:Boolean
[read-write]
Boolean
value which determines whether the force (frameHandler
) is currently being applied.
public function get hasForce():Boolean
public function set hasForce(value:Boolean):void
isDraggable | property |
isDraggable:Boolean
[read-write]
Boolean
value which determines whether the object is able to be dragged/thrown.
public function get isDraggable():Boolean
public function set isDraggable(value:Boolean):void
mass | property |
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
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
Parametersvx: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 ).
|
collide | () | method |
public function collide():void
Handle a collision
frameHandler | () | method |
protected function frameHandler(e:Event):void
Handle force logic.
Parameterse: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
.
e:MouseEvent (default = null )
|
release | () | method |
protected override function release(e:MouseEvent = null):void
Stub: release event handler.
Parameterse:MouseEvent (default = null )
|
releaseOutside | () | method |
protected override function releaseOutside(e:Event = null):void
Stub: release outside event handler.
Parameterse:Event (default = null )
|