Files
krkr2doc/docs/kr2doc/contents/f_Layer_beginTransition.html
2016-09-08 17:50:19 +09:00

96 lines
6.1 KiB
HTML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja" lang="ja">
<!-- generated by to_html.pl from f_Layer.xml -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>beginTransition - トランジションの開始</title>
<meta name="author" content="W.Dee" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link href="funcref.css" type="text/css" rel="stylesheet" title="クラスリファレンス用標準スタイル" />
<link href="mailto:[email protected]" rev="Made" />
<link href="index.html" target="_top" rel="Start" title="トップページ" />
<link href="f_Layer.html" title="Layerクラス" rel="Parent" />
</head>
<body>
<h1><span class="fheader"><a name="top" id="top">Layer.beginTransition</a></span></h1><div class="para"><div>
<dl>
<dt>機能/意味</dt>
<dd>
トランジションの開始</dd>
<dt>タイプ</dt>
<dd>
<a class="jump" href="f_Layer.html">Layerクラス</a>のメソッド<br />
</dd>
<dt>構文</dt>
<dd>
<span class="funcdecl">beginTransition(<span class="arg">name</span>, <span class="arg">withchildren</span><span class="defarg">=<span class="defargval">true</span></span>, <span class="arg">transsrc</span><span class="defarg">=<span class="defargval">null</span></span>, <span class="arg">options</span><span class="defarg">=<span class="defargval">%[ ]</span></span>)</span><br />
</dd>
<dt>引数</dt>
<dd>
<table rules="all" frame="box" cellpadding="3" summary="beginTransition の引数">
<tr><td valign="top"><span class="argname">name</span></td>
<td>  トランジション名を指定します。<br />
 デフォルトでは 'crossfade' ( クロスフェード )、'universal' ( ユニバーサルトラン
ジション )、'scroll' ( スクロールトランジション ) が定義されています。<br />
</td></tr>
<tr><td valign="top"><span class="argname">withchildren</span></td>
<td>  子レイヤも一緒にトランジションを行うかどうかです。真を指定すると
子レイヤごとトランジションします。偽を指定するとメソッドを実行するレイヤのみ
がトランジションします。<br />
</td></tr>
<tr><td valign="top"><span class="argname">transsrc</span></td>
<td>  切り替わり先となるレイヤを指定します。トランジションによっては指定が必要ない
もの ( 単独でトランジションするものなど ) もあるかもしれません。<br />
</td></tr>
<tr><td valign="top"><span class="argname">options</span></td>
<td>  トランジションのオプションを辞書配列で指定します。<br />
 必要なオプションはトランジションの種類によって異なります。<br />
 トランジションの種類に関係なく、共通して指定できるオプションとして 'selfupdate' メンバと 'callback' メンバがあります。<br />
<br />
 'selfupdate' メンバが 真 の場合は、吉里吉里は自動での画面更新を行わなくなります。
この場合は、適宜プログラム側で <a class="jump" href="f_Layer_update.html">Layer.update</a> メソッドなどで画面を更新しなければなりません。この機能は、トランジションによる描画とプログラムによる描画を完全に同期させたい場合に便利です。<br />
<br />
 'callback' メンバにTJS2のメソッドを指定すると、
描画が実際に行われる度にそのメソッドが呼ばれます。
このメソッド(コールバックされるメソッド)では 'tick' 値を0以上の値で返してください。
多くのトランジションは、ミリ秒単位での実際の時間である'tick'
値を元にトランジションを行っていますが、
このコールバックされるメソッドで任意のtickを返すように実装することにより、
トランジションの効果を任意の時点で巻き戻したり、途中で早送りをしたりが可能になり、
実際の時間に関係なくトランジションを制御できるようになります。
多くのトランジションは、オプションの'time'
メンバで指定した値がトランジションの終端であると見なしています。
そのため、たとえばオプションの 'time' には 1000 等の適当な値を指定しておき、
このコールバックされるメソッドで 1000 未満の値を返すことにより、
任意の段階でのトランジションの表示などを行わせることができるようになります。
また、多くのトランジションの場合、オプションの 'time' で指定された値に 'tick'
値が達すると、トランジションが停止しますので、
トランジションを停止させたくない場合は、 'time' で指定した値未満の値を常に
指定するようにしてください。
</td></tr>
</table>
</dd>
<dt>戻り値</dt>
<dd>
なし (void)<br />
</dd>
<dt>説明</dt>
<dd>
 トランジションを開始します。<br />
 children=真 の場合のトランジションは、終了するときに、transsrc で指定した
トランジション元とそっくり親子関係のツリー構造が入れ替わります。<br />
 children=偽 の場合は、トランジション元のレイヤとメソッドを実行したレイヤ (
トランジション先のレイヤ ) のみが入れ替わります。<br />
 どちらの場合も、ツリー構造上での入れ替えが行われるため注意してください。<br />
 このメソッドはトランジションを開始させるだけですぐに戻ります。<br />
</dd>
</dl>
</div></div>
<script type="text/javascript" charset="UTF-8" src="documentid.js" ></script>
<script type="text/javascript" charset="UTF-8" src="postcontent.js" ></script>
</body>
</html>