SparkSet APIリファレンス

Sparkクラス

重力によって落下する星を表現するクラス。星の実体としてはHTMLの要素を使用する。

星には寿命があり、寿命が尽きると自動的に非表示になる。これを死んだ状態という。死んだ状態の星は、初期位置、初期速度、寿命を与え、生き返らせることが出来る。この際、星はとなる。生きた状態の星は、doMove()メソッドを呼び、寿命を全うさせなければならない。

Spark(elem,weight)

コンストラクタ。elemで指定した要素は不可視にされる。生成した直後の星は死んだ状態である。

elem
星として動かす要素。この要素はpositon: absolueというスタイルの指定がなされていなければならない。
weight
星の重さ。星を動かす度に落下速度がweightピクセル分だけ速くなっていく。
birth(startX,startY,spX,spY,lifetime)

星を生きた状態にする。
星を初期位置に移動させ、可視状態にする。

startX
横方向の初期位置。単位はピクセル。
startY
縦方向の初期位置。単位はピクセル。
spX
横方向の移動速度。単位はピクセル。
spY
縦方向の移動速度。単位はピクセル。
lifetime
寿命。lifetime回数分だけdoMove()関数を呼ぶと死んだ状態に戻る。
die()

星を死んだ状態にする。星は不可視となる。

isLive doMove()

1回分の星の移動処理を行う。寿命が尽きたら星は死んだ状態に戻る。

返値として、星が生きていればtrue、死んでいればfalseを返す。

moveTo(x,y)

指定した位置に星を移動させる。

x
横方向の位置。単位はピクセル。
y
縦方向の位置。単位はピクセル。
setVisible(isVisible)

星の可視状態を変更する。

isVisible
trueだったら可視に、falseだったら不可視になる。

SparkSetクラス

Sparkクラスのインスタンスを管理するクラス。生きた星があると、自動的にsetTimeout()関数で星の動きを駆動する。

SparkSet(id,interval,weight)

コンストラクタ。

id
星の要素群を指定する為のID。実際のIDは末尾に0からの通し番号が付けられる。
interval
星を動かす時間間隔。単位はミリ秒。
weight
星の重さ。Sparkクラスのコンストラクタを参照のこと。
start(n)

星の管理を開始する。このメソッドを呼ぶ前に、既に0からn-1までの通し番号の付いた要素が存在していなければならない。

n
管理する星の個数。
startWithWriteElements(n,imgFile,imgWidth,imgHeight,spread)

星として動かす要素を書き出し、管理を開始する。

n
星の個数。
imgFile
星として動かす画像のURL。
imgWidth
画像の横方向の大きさ。
imgHeight
画像の縦方向の大きさ。
spread
画像の大きさ揺らぎ。(imgHeight,imgHeight)から(imgHeight - spread,imgHeight - spread)までのランダムな変化を付けて生成される。
WriteSparkElement(no,imgFile,imgWidth,imgHeight)

星として動かす要素をひとつ書き出す。

no
IDに付けられる通し番号
imgFile
星として動かす画像のURL。
imgWidth
画像の横方向の大きさ。
imgHeight
画像の縦方向の大きさ。
result birthSpark(x,y,spX,spY,lifetime)

星をひとつ誕生させる。

x
横方向の初期位置。単位はピクセル。
y
縦方向の初期位置。単位はピクセル。
spX
横方向の移動速度。単位はピクセル。
spY
縦方向の移動速度。単位はピクセル。
lifetime
寿命。

りゅう/rryu@t3.rim.or.jp