Packagesketchbook.display
Classpublic class SpriteHelper

Sprite、MovieClipを効率よく操作する為の、ショートカット、Helper,Utilを集約したクラスです。

このクラスを用いることでインタラクティブ作品を作るときに要求される、雑務的処理を軽減することができまう。

このクラスを使う前に、SketchBook.initで、sketchbookの初期化を行う必要があります。


Example
    var mySprite:Sprite = new Sprite();
    var helper:SpriteHelper = new SpriteHelepr();
  
    helper.red = 100;
    helper.onEnterFrame = function():void{ trace("onEnterFrame"); }

See also

sketchbook.SketchBook


Public Properties
 PropertyDefined by
  alpha : Number
SpriteHelper
  blueMultiplier : Number
[read-only]
SpriteHelper
  blueOffset : Number
[read-only]
SpriteHelper
  colorTransform : ColorTransform
colorTransformへのショートカット
SpriteHelper
  concatenatedMatrix : Matrix
[read-only] matrixへのショートカット
SpriteHelper
  globalPoint : Point
Spriteのグローバル座標系での現在位置
SpriteHelper
  globalX : Number
Spriteのグローバル座標系でのX
SpriteHelper
  globalY : Number
Spriteのグローバル座標系でのY
SpriteHelper
  graphics : Graphics
[read-only] 対象のSpriteのgraphicsプロパティへのショートカット

SpriteHelperを通じて、Graphicsの全ての関数プロパティにアクセスすることができます

SpriteHelper
  graphicsHelpder : GraphicsHelper
[read-only] Spriteと関連付けられたGraphicsHelperへのショートカット
SpriteHelper
  greenMultiplier : Number
[read-only]
SpriteHelper
  greenOffset : Number
[read-only]
SpriteHelper
  height : Number
SpriteHelper
  matrix : Matrix
matrixへのショートカット
SpriteHelper
  onAdded : Function
Event.ADDEDに対応するコールバック。
SpriteHelper
  onClick : Function
MouseEvent.CLICKに対応するコールバック。
SpriteHelper
  onDoubleClick : Function
ダブルクリックにに呼ばれるイベントハンドラを定義できます。
SpriteHelper
  onEnterFrame : Function
毎フレーム呼ばれるイベントハンドラを定義できます。
SpriteHelper
  onKeyDown : Function
キーがプレスされたときに呼ばれるイベントハンドラを定義できます。

イベント発行時にハンドラにはkeyCode:Numberが渡されます。

SpriteHelper
  onKeyUp : Function
キーがリリースされたときに呼ばれるイベントハンドラを定義できます。

イベント発行時にハンドラにはkeyCode:Numberが渡されます。

SpriteHelper
  onMouseDown : Function
MouseEvent.MOUSE_DOWNに対応するコールバック。
SpriteHelper
  onMouseMove : Function
MouseEvent.MOUSE_MOVEに対応するコールバック。
SpriteHelper
  onMouseUp : Function
MouseEvent.MOUSE_UPに対応するコールバック。
SpriteHelper
  onMouseWheel : Function
MouseEvent.MOUSE_WHEELに対応するコールバック。

関数には回転量delta:Numberが渡される。

SpriteHelper
  onRemoved : Function
Event.REMOVEDに対応するコールバック。
SpriteHelper
  onRollOut : Function
MouseEvent.ROLL_OUTに対応するコールバック
SpriteHelper
  onRollOver : Function
MouseEvent.MOUSE_MOVEに対応するコールバック。
SpriteHelper
  redMultiplier : Number
[read-only]
SpriteHelper
  redOffset : Number
[read-only]
SpriteHelper
  rotation : Number
SpriteHelper
  scaleX : Number
SpriteHelper
  scaleY : Number
SpriteHelper
  target : Sprite
target display object that DisplayObjectHelper access
SpriteHelper
  width : Number
SpriteHelper
  x : Number
SpriteHelper
  y : Number
SpriteHelper
Protected Properties
 PropertyDefined by
  _graphicsHelper : GraphicsHelper
SpriteHelper
  _target : Sprite
SpriteHelper
Public Methods
 MethodDefined by
  
SpriteHelper(sprite:Sprite)
SpriteHelper
  
beginBitmapFill(bitmap:BitmapData, matrix:Matrix = null, repeat:Boolean = true, smooth:Boolean = false):void
SpriteHelper
  
beginFill(color:uint, alpha:Number = 1.0):void
graphics.beginFillへのショートカット
SpriteHelper
  
beginGradientFill(type:String, color:Array, alphas:Array, ratios:Array, matrix:Matrix = null, spreadMethod:String = "pad", interpolationMethod:String = "rgb", focalPointRation:Number = 0.0):void
SpriteHelper
  
clear():void
graphics.clearへのショートカット
SpriteHelper
  
curveTo(controlX:Number, controlY:Number, anchorX:Number, anchorY:Number):void
SpriteHelper
  
drawCircle(x:Number, y:Number, radius:Number):void
SpriteHelper
  
drawEllipse(x:Number, y:Number, width:Number, height:Number):void
SpriteHelper
  
drawLines(points:Array, closePath:Boolean = false):void
Pointの配列を繋げて線を描画します。

この関数はGraphicsHelper.drawLinesのショートカットです。

SpriteHelper
  
drawPolygon(x0:Number, y0:Number, x1:Number, y1:Number, x2:Number, y2:Number):void
3点から三角形を描画します。

この関数はGraphicsHelper.drawPolygonのショートカットです。

SpriteHelper
  
drawQuad(x0:Number, y0:Number, x1:Number, y1:Number, x2:Number, y2:Number, x3:Number, y3:Number):void
4点から矩形を描画します。

この関数はGraphicsHelper.drawQuadのショートカットです。

SpriteHelper
  
drawRect(x:Number, y:Number, width:Number, height:Number):void
SpriteHelper
  
drawRoundRect(x:Number, y:Number, width:Number, height:Number, ellipseWidth:Number, ellipseHeight:Number):void
SpriteHelper
  
drawRoundRectComplex(x:Number, y:Number, width:Number, height:Number, topLeftRadius:Number, topRightRadius:Number, bottomLeftRadius:Number, bottomRightRadius:Number):void
SpriteHelper
  
drawStar(x:Number, y:Number, outerRadius:Number, innerRadius:Number, num:Number):void
星や爆発などの凹凸のある多角形を描画します。
SpriteHelper
  
endFill():void
SpriteHelper
  
lineGradientStyle(type:String, colors:Array, alphas:Array, ratios:Array, matrix:Matrix = null, spreadMethod:String = "pad", interpolationMethod:String = "rgb", focalPointRatio:Number = 0.0):void
SpriteHelper
  
lineStyle(thickness:Number = 0, color:uint = 0, alpha:Number = 1, pixelHinting:Boolean = false, scaleMode:String = "normal", caps:String = null, joints:String = null, miterLimit:Number = 3):void
SpriteHelper
  
lineTo(x:Number, y:Number):void
SpriteHelper
  
localToLocal(pt:Point, fromCordinate:DisplayObject, toCordinate:DisplayObject):Point
[static] あるローカル座標系の位置を別のローカル座標系に変換します。

この関数は異なるスケールや階層関係のDisplayObject同士で、位置を調整・判定する場合に有効です。

SpriteHelper
  
moveTo(x:Number, y:Number):void
SpriteHelper
  
rotete(angle:Number):void
matrix.rotate へのショートカット
SpriteHelper
  
scale(sx:Number, sy:Number):void
matrix.scale へのショートカット
SpriteHelper
  
sort(fieldName:Object, options:Object = null):void
targetのChildrenを特定のプロパティの値でArray.sortを行います。
SpriteHelper
  
sortChildren(... args):void
Childrenに対してsortを行います。

この関数は未実装です

SpriteHelper
  
translate(dx:Number, dy:Number):void
matrix.translate へのショートカット
SpriteHelper
Property detail
alphaproperty
alpha:Number  [read-write]Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
blueMultiplierproperty 
blueMultiplier:Number  [read-only]Implementation
    public function get blueMultiplier():Number
blueOffsetproperty 
blueOffset:Number  [read-only]Implementation
    public function get blueOffset():Number
colorTransformproperty 
colorTransform:ColorTransform  [read-write]

colorTransformへのショートカット

Implementation
    public function get colorTransform():ColorTransform
    public function set colorTransform(value:ColorTransform):void
concatenatedMatrixproperty 
concatenatedMatrix:Matrix  [read-only]

matrixへのショートカット

Implementation
    public function get concatenatedMatrix():Matrix
globalPointproperty 
globalPoint:Point  [read-write]

Spriteのグローバル座標系での現在位置

Implementation
    public function get globalPoint():Point
    public function set globalPoint(value:Point):void
globalXproperty 
globalX:Number  [read-write]

Spriteのグローバル座標系でのX

Implementation
    public function get globalX():Number
    public function set globalX(value:Number):void
globalYproperty 
globalY:Number  [read-write]

Spriteのグローバル座標系でのY

Implementation
    public function get globalY():Number
    public function set globalY(value:Number):void
graphicsproperty 
graphics:Graphics  [read-only]

対象のSpriteのgraphicsプロパティへのショートカット

SpriteHelperを通じて、Graphicsの全ての関数プロパティにアクセスすることができます

Implementation
    public function get graphics():Graphics

See also

flash.display.Graphics
graphicsHelpderproperty 
graphicsHelpder:GraphicsHelper  [read-only]

Spriteと関連付けられたGraphicsHelperへのショートカット

Implementation
    public function get graphicsHelpder():GraphicsHelper

See also

_graphicsHelperproperty 
protected var _graphicsHelper:GraphicsHelper
greenMultiplierproperty 
greenMultiplier:Number  [read-only]Implementation
    public function get greenMultiplier():Number
greenOffsetproperty 
greenOffset:Number  [read-only]Implementation
    public function get greenOffset():Number
heightproperty 
height:Number  [read-write]Implementation
    public function get height():Number
    public function set height(value:Number):void
matrixproperty 
matrix:Matrix  [read-write]

matrixへのショートカット

Implementation
    public function get matrix():Matrix
    public function set matrix(value:Matrix):void
onAddedproperty 
public var onAdded:Function

Event.ADDEDに対応するコールバック。

onClickproperty 
public var onClick:Function

MouseEvent.CLICKに対応するコールバック。

onDoubleClickproperty 
onDoubleClick:Function  [read-write]

ダブルクリックにに呼ばれるイベントハンドラを定義できます。

Implementation
    public function get onDoubleClick():Function
    public function set onDoubleClick(value:Function):void
onEnterFrameproperty 
onEnterFrame:Function  [read-write]

毎フレーム呼ばれるイベントハンドラを定義できます。

Implementation
    public function get onEnterFrame():Function
    public function set onEnterFrame(value:Function):void
onKeyDownproperty 
onKeyDown:Function  [read-write]

キーがプレスされたときに呼ばれるイベントハンドラを定義できます。

イベント発行時にハンドラにはkeyCode:Numberが渡されます。

Implementation
    public function get onKeyDown():Function
    public function set onKeyDown(value:Function):void
onKeyUpproperty 
onKeyUp:Function  [read-write]

キーがリリースされたときに呼ばれるイベントハンドラを定義できます。

イベント発行時にハンドラにはkeyCode:Numberが渡されます。

Implementation
    public function get onKeyUp():Function
    public function set onKeyUp(value:Function):void
onMouseDownproperty 
public var onMouseDown:Function

MouseEvent.MOUSE_DOWNに対応するコールバック。

onMouseMoveproperty 
onMouseMove:Function  [read-write]

MouseEvent.MOUSE_MOVEに対応するコールバック。

Implementation
    public function get onMouseMove():Function
    public function set onMouseMove(value:Function):void
onMouseUpproperty 
public var onMouseUp:Function

MouseEvent.MOUSE_UPに対応するコールバック。

onMouseWheelproperty 
public var onMouseWheel:Function

MouseEvent.MOUSE_WHEELに対応するコールバック。

関数には回転量delta:Numberが渡される。

onRemovedproperty 
public var onRemoved:Function

Event.REMOVEDに対応するコールバック。

onRollOutproperty 
onRollOut:Function  [read-write]

MouseEvent.ROLL_OUTに対応するコールバック

Implementation
    public function get onRollOut():Function
    public function set onRollOut(value:Function):void
onRollOverproperty 
onRollOver:Function  [read-write]

MouseEvent.MOUSE_MOVEに対応するコールバック。

Implementation
    public function get onRollOver():Function
    public function set onRollOver(value:Function):void
redMultiplierproperty 
redMultiplier:Number  [read-only]Implementation
    public function get redMultiplier():Number
redOffsetproperty 
redOffset:Number  [read-only]Implementation
    public function get redOffset():Number
rotationproperty 
rotation:Number  [read-write]Implementation
    public function get rotation():Number
    public function set rotation(value:Number):void
scaleXproperty 
scaleX:Number  [read-write]Implementation
    public function get scaleX():Number
    public function set scaleX(value:Number):void
scaleYproperty 
scaleY:Number  [read-write]Implementation
    public function get scaleY():Number
    public function set scaleY(value:Number):void
_targetproperty 
protected var _target:Sprite
targetproperty 
target:Sprite  [read-write]

target display object that DisplayObjectHelper access

Implementation
    public function get target():Sprite
    public function set target(value:Sprite):void
widthproperty 
width:Number  [read-write]Implementation
    public function get width():Number
    public function set width(value:Number):void
xproperty 
x:Number  [read-write]Implementation
    public function get x():Number
    public function set x(value:Number):void
yproperty 
y:Number  [read-write]Implementation
    public function get y():Number
    public function set y(value:Number):void
Constructor detail
SpriteHelper()constructor
public function SpriteHelper(sprite:Sprite)

Parameters
sprite:Sprite — このクラスで制御するSpriteインスタンスの参照
Method detail
beginBitmapFill()method
public function beginBitmapFill(bitmap:BitmapData, matrix:Matrix = null, repeat:Boolean = true, smooth:Boolean = false):voidParameters
bitmap:BitmapData
 
matrix:Matrix (default = null)
 
repeat:Boolean (default = true)
 
smooth:Boolean (default = false)
beginFill()method 
public function beginFill(color:uint, alpha:Number = 1.0):void

graphics.beginFillへのショートカット

Parameters
color:uint
 
alpha:Number (default = 1.0)
beginGradientFill()method 
public function beginGradientFill(type:String, color:Array, alphas:Array, ratios:Array, matrix:Matrix = null, spreadMethod:String = "pad", interpolationMethod:String = "rgb", focalPointRation:Number = 0.0):voidParameters
type:String
 
color:Array
 
alphas:Array
 
ratios:Array
 
matrix:Matrix (default = null)
 
spreadMethod:String (default = "pad")
 
interpolationMethod:String (default = "rgb")
 
focalPointRation:Number (default = 0.0)
clear()method 
public function clear():void

graphics.clearへのショートカット

curveTo()method 
public function curveTo(controlX:Number, controlY:Number, anchorX:Number, anchorY:Number):voidParameters
controlX:Number
 
controlY:Number
 
anchorX:Number
 
anchorY:Number
drawCircle()method 
public function drawCircle(x:Number, y:Number, radius:Number):voidParameters
x:Number
 
y:Number
 
radius:Number
drawEllipse()method 
public function drawEllipse(x:Number, y:Number, width:Number, height:Number):voidParameters
x:Number
 
y:Number
 
width:Number
 
height:Number
drawLines()method 
public function drawLines(points:Array, closePath:Boolean = false):void

Pointの配列を繋げて線を描画します。

この関数はGraphicsHelper.drawLinesのショートカットです。

Parameters
points:Array — Point配列
 
closePath:Boolean (default = false) — パスを閉じるかどうかのフラグ

See also

drawPolygon()method 
public function drawPolygon(x0:Number, y0:Number, x1:Number, y1:Number, x2:Number, y2:Number):void

3点から三角形を描画します。

この関数はGraphicsHelper.drawPolygonのショートカットです。

Parameters
x0:Number
 
y0:Number
 
x1:Number
 
y1:Number
 
x2:Number
 
y2:Number

See also

drawQuad()method 
public function drawQuad(x0:Number, y0:Number, x1:Number, y1:Number, x2:Number, y2:Number, x3:Number, y3:Number):void

4点から矩形を描画します。

この関数はGraphicsHelper.drawQuadのショートカットです。

Parameters
x0:Number
 
y0:Number
 
x1:Number
 
y1:Number
 
x2:Number
 
y2:Number
 
x3:Number
 
y3:Number

See also

drawRect()method 
public function drawRect(x:Number, y:Number, width:Number, height:Number):voidParameters
x:Number
 
y:Number
 
width:Number
 
height:Number
drawRoundRect()method 
public function drawRoundRect(x:Number, y:Number, width:Number, height:Number, ellipseWidth:Number, ellipseHeight:Number):voidParameters
x:Number
 
y:Number
 
width:Number
 
height:Number
 
ellipseWidth:Number
 
ellipseHeight:Number
drawRoundRectComplex()method 
public function drawRoundRectComplex(x:Number, y:Number, width:Number, height:Number, topLeftRadius:Number, topRightRadius:Number, bottomLeftRadius:Number, bottomRightRadius:Number):voidParameters
x:Number
 
y:Number
 
width:Number
 
height:Number
 
topLeftRadius:Number
 
topRightRadius:Number
 
bottomLeftRadius:Number
 
bottomRightRadius:Number
drawStar()method 
public function drawStar(x:Number, y:Number, outerRadius:Number, innerRadius:Number, num:Number):void

星や爆発などの凹凸のある多角形を描画します。

Parameters
x:Number — 中心のX座標
 
y:Number — 中心のY座標
 
outerRadius:Number — 外周半径
 
innerRadius:Number — 内周半径
 
num:Number — 分割数

See also

sketchbook.graphics.graphicsHelper
endFill()method 
public function endFill():void
lineGradientStyle()method 
public function lineGradientStyle(type:String, colors:Array, alphas:Array, ratios:Array, matrix:Matrix = null, spreadMethod:String = "pad", interpolationMethod:String = "rgb", focalPointRatio:Number = 0.0):voidParameters
type:String
 
colors:Array
 
alphas:Array
 
ratios:Array
 
matrix:Matrix (default = null)
 
spreadMethod:String (default = "pad")
 
interpolationMethod:String (default = "rgb")
 
focalPointRatio:Number (default = 0.0)
lineStyle()method 
public function lineStyle(thickness:Number = 0, color:uint = 0, alpha:Number = 1, pixelHinting:Boolean = false, scaleMode:String = "normal", caps:String = null, joints:String = null, miterLimit:Number = 3):voidParameters
thickness:Number (default = 0)
 
color:uint (default = 0)
 
alpha:Number (default = 1)
 
pixelHinting:Boolean (default = false)
 
scaleMode:String (default = "normal")
 
caps:String (default = null)
 
joints:String (default = null)
 
miterLimit:Number (default = 3)
lineTo()method 
public function lineTo(x:Number, y:Number):voidParameters
x:Number
 
y:Number
localToLocal()method 
public static function localToLocal(pt:Point, fromCordinate:DisplayObject, toCordinate:DisplayObject):Point

あるローカル座標系の位置を別のローカル座標系に変換します。

この関数は異なるスケールや階層関係のDisplayObject同士で、位置を調整・判定する場合に有効です。

Parameters
pt:Point — 変換したい座標
 
fromCordinate:DisplayObject
 
toCordinate:DisplayObject

Returns
Point — 変換された座標
moveTo()method 
public function moveTo(x:Number, y:Number):voidParameters
x:Number
 
y:Number
rotete()method 
public function rotete(angle:Number):void

matrix.rotate へのショートカット

Parameters
angle:Number
scale()method 
public function scale(sx:Number, sy:Number):void

matrix.scale へのショートカット

Parameters
sx:Number
 
sy:Number
sort()method 
public function sort(fieldName:Object, options:Object = null):void

targetのChildrenを特定のプロパティの値でArray.sortを行います。

Parameters
fieldName:Object
 
options:Object (default = null)

See also

Array.sort
sortChildren()method 
public function sortChildren(... args):void

Childrenに対してsortを行います。

この関数は未実装です

Parameters
... args
translate()method 
public function translate(dx:Number, dy:Number):void

matrix.translate へのショートカット

Parameters
dx:Number
 
dy:Number