Motel JavaScript

概要

XMLファイルに記述した動作定義ファイルを、HTML/XHTMLのエレメントに適用するJavaScriptライブラリ。



Table of Contents


スクリプト

スクリプト仕様


Motel.load(xml)

引数
xml (string) 動作定義を記述したファイル名
戻り値
(undefined) 戻り値はありません
(JavaScriptの仕様により、undefinedを返す)

解説

動作定義を記述したXMLファイルを読み込みます。
絶対パス、相対パス、絶対URIのいずれかを指定出来ますが、
XMLHttpRequestの仕様により、HTMLファイル名のあるドメイン以外のドメインを指定することは出来ません。
このメソッドはドキュメント(window)のロード後に行って下さい。

Sample

<body onload="Motel.load('motions.xml');">

↑TOC


Motel.set(args[])

引数
args[0](string) Motion ID
args[1](string|object) (string) エレメントID
(object) エレメントへの参照
args[2](object) オプション
args[3](string) コールバック関数またはMotion終了時に続けて呼び出すMotion ID
戻り値
(number) 成功時 0以上
失敗時 -1

解説

モーションとエレメントを関連づけます。
関連づけるだけでアニメーションは行いません。
第3、第4引数は現在対応していません。

Sample

Motel.set('mot1', 'div1', null, 'funcnext()');
Motel.set('mot1', 'div2', null, 'mot2');

↑TOC


Motel.start(args[])

引数
args[0](string|number) (string)Motion ID
(number) set()の戻り値
args[1](string) エレメントID
args[2](object) オプション
args[3](string) コールバック関数またはMotion終了時に続けて呼び出すMotion ID
戻り値
(number) 成功時 0以上
失敗時 -1

解説

第1引数が数値(数字)の場合、set()により準備されたアニメーションを開始します。
第1引数に数字以外の文字が含まれている場合はMotionIDと見なし、XMLファイルの<Motion>のIDと、第2引数のエレメントを割り当て、アニメーションを開始します。
第3、第4引数は現在対応していません。

Sample

Motel.start(5);
Motel.start('mot1', 'div1', null, 'funcnext()');
Motel.start('mot2', 'div2', null, 'mot2');
var id=Motel.set('mot3', 'div3'); Motel.start(id);

↑TOC


Motel.stop(id)

引数
id(number) 動作ID
戻り値
(number) 成功時 -1
失敗時 動作ID

解説

引数に指定された動作を停止します。
set()またはstart()で生成されたIDを引数に指定します。
停止した位置からの再開は出来ません。

停止に成功すると-1を返し、失敗すると引数のIDをそのまま返します。

Sample

id=Motel.stop(id);

↑TOC


Motel.stopall()

引数
- 引数はありません
戻り値
(number) 成功時 0
失敗時 1以上

解説

動作を停止します。
一旦停止すると、すべてのモーションが止まり、途中からの再開は出来ません
start()を呼ぶことで個々のモーションを再開できます。
start()の戻り値やset()の戻り値を保存していれば、それらを再利用することが出来ます。

Sample

Motel.stopall();

↑TOC


Motel.prop(id, tn, en, opt)

引数
id(number)動作 ID
tn(number|string)トーン番号、またはトーンID
en(number)エレメント番号
opt(object)上書きするトーンの内容
戻り値
(number)成功時 0以上
失敗時 -1

解説

XMLファイルに記述した<toon>エレメントを動的に変更します。
動作IDにはset()の戻り値を指定します。

Sample

Motel.prop(id, toon, 0, {start:{top:40}});

実装状況

このメソッドは未実装です

↑TOC


© Wings-Winds 2006