PluginFrameBufferのキー（３）
Category = PluginFrameBufferで、
SampleAnimationFaceプラグインを使用する場合のフィールドのキー一覧です。
- キー名が赤字と青字のキーは必須のキーです。
（青字のキーは他のキーの設定状況などによっては省略することも可能です）
- キー名が緑字のキーは、作成するアイテムの種類によっては必須になるキーです。
（該当するアイテム以外を作成する場合は省略してもかまいません）
- キー名の左の欄に*があるキーは、
ModifyItemコマンドで後から設定を変更することができます。
- このプラグインでのみ設定できるキーの項目は項目の見出しが青字になっています。
カテゴリの設定
| |
キー名 |
値 |
内容 |
|
Category |
PluginFrameBuffer |
カテゴリをPluginFrameBufferに指定 |
サブカテゴリの設定
| |
キー名 |
値 |
内容 |
|
SubCategory |
Animation |
サブカテゴリをAnimationに指定 |
アイテムを表示するタイミング・アイテムの機能の設定
| |
キー名 |
値 |
内容 |
初期値 |
|
Type |
【※1】 |
１：uLilithの再生モードなどの状態に応じた
アイテムを表示するタイミング
２：アイテムの機能
（スライダアイテムかWindowResizerアイテム）
のどちらか１つ |
|
|
ViewType |
【※2】 |
ファイルの再生状態に応じた
アイテムを表示するタイミング |
AlwaysVisible |
| * |
ActiveType |
【※2】 |
uLilithのアクティブ状態に応じた
アイテムを表示するタイミング |
ActiveAndInactive |
アイテムの表示サイズの指定
| |
キー名 |
値 |
内容 |
初期値 |
| * |
Width |
数値 |
アイテムの表示サイズ（幅） |
|
| * |
Height |
数値 |
アイテムの表示サイズ（高さ） |
|
☆アイテムの表示サイズより小さいサイズのアニメーション画像を表示する場合、
アニメーション画像はアイテム表示領域の中央に等倍サイズで表示されます。
逆に、アイテムの表示サイズより大きいサイズのアニメーション画像を表示する場合は
アニメーション画像はアスペクト比を維持したまま、アイテムの表示領域に縮小表示されます。
アイテムの画像表示サイズの指定
☆スライダアイテムを作成する場合、
これらのキーでつまみ部分の幅・高さを決めるのでこの２つのキーは必須になります。
| |
キー名 |
値 |
内容 |
初期値 |
| * |
FrameBufferWidth |
数値 |
プラグインが実際に生成する画像の幅
スライダアイテムの場合はつまみ部分の幅 |
Widthの数値 |
| * |
FrameBufferHeight |
数値 |
プラグインが実際に生成する画像の高さ
スライダアイテムの場合はつまみ部分の高さ |
Heightの数値 |
アニメーション表示する画像ファイルの設定
| |
キー名 |
値 |
内容 |
初期値 |
|
AnimationImageFile |
ファイル名 |
アニメーション表示に使用する画像のファイル名【※】 |
|
※このキーには画像ファイルを１つしか指定できません。
『表示する全てのコマを並べて描いた１枚の画像ファイル（uLilithで使用可能な画像形式）』か
アニメーションGIFやマルチページTIFFなど、
『ファイル内に複数の画像を格納しているファイル』を指定します。
アニメーションに使用するコマの設定
☆「表示する全てのコマを並べた１枚の画像」を使用する場合は必須キーになります。
| |
キー名 |
値 |
内容 |
初期値 |
|
AnimationFrameWidth |
数値（整数） |
アニメーションで表示するコマの幅【※】 |
|
|
AnimationFrameHeight |
数値（整数） |
アニメーションで表示するコマの高さ【※】 |
|
|
AnimationTotalCount |
数値（整数） |
アニメーションで表示するコマの数【※】 |
|
※AnimationImageFileに指定した画像ファイルの左上から、
AnimationFrameWidth・AnimationFrameHeightで指定したコマのサイズの大きさずつ、
右・下方向にコマを作成していきます。
（横１列に並べた画像なら左→右へ、縦１列なら上→下へ、
２列以上並べた画像なら、まず左上端から右方向にコマを切り出していき、
右端まで行ったら左端に戻り、コマの高さ分下がってそこからまた右端までコマを切り出して
また左端へ戻ってコマの高さ分下がって……というパターンを繰り返す）
AnimationTotalCountの数の分だけコマが作られ、
この数値以上は画像の領域が余っていてもコマは作られません。
逆に、AnimationImageFileに指定した画像が小さすぎて
作成しようとしているコマ数の分コマが作れない場合はエラーとなり、アニメーションは表示されません。
アニメーションの動作設定
☆各コマをコマ順で一定の間隔で表示させる場合は『AnimationIntervalキー』が、
コマの順番・表示時間を自由に設定する「カスタムシーケンス」を使用する場合は
『UseCustomSequence・CustomSequenceキー』が必須キーになります。
アニメーションGIFの場合は設定する必要はありませんが、
キーを設定した場合はアニメーションGIFに埋め込まれた設定を無視して
キーで設定したとおりの動作でアニメーション表示されます。
キーを省略すると、アニメーションGIFに埋め込まれた設定のままでアニメーション表示されます。
| |
キー名 |
値 |
内容 |
初期値 |
|
AnimationInterval |
数値（整数） |
各コマを表示する時間（ミリ秒単位） |
|
|
AnimationLoopCount |
数値（整数） |
0：無限ループする
1：１周だけアニメーションが表示された後、
最後のコマが表示されつづける
2以上：設定した回数分繰り返し表示 |
0 |
|
UseCustomSequence |
TrueかFalse |
True：表示されるコマの順番・表示時間を
自由に設定できる
「カスタムシーケンス」で表示する
False：一定時間おきに
コマ順のとおりに表示する |
False |
|
CustomSequence |
【※】 |
カスタムシーケンスの内容を指定する |
|
※カスタムシーケンスに指定する内容は、以下のように
〔コマ番号〕: 〔表示時間〕, 〔コマ番号〕: 〔表示時間〕, 〔コマ番号〕: 〔表示時間〕, …
と、表示されるコマと表示時間、表示順をまとめて指定します。
コマ番号と表示時間を半角コロンで繋げて、それを半角カンマ・スペースで区切って複数指定します。
コマ番号は、アニメーションGIF・マルチページTIFFならファイル内の画像の順番で、
コマを全て並べた１枚の画像から作成したコマなら左上から（コマを作成した）順番に、
0から始まる番号がつけられているので、その番号で指定します。
（1を指定すると2番目の画像になってしまうので気をつけてください。）
表示時間はミリ秒単位です。
コマ番号・表示時間ともに、半角ハイフンで区切った２つの値を入れることで
その範囲内でランダムな値を使用することもできます。
ランダム範囲はコマ番号・表示時間どちらか一方のみで使用することも可能です。
もちろん、通常のコマ表示と組み合わせることもできます。
CustomSequence = 0:100, 4:200, 3:100, 1:50, 2,50
「0番目のコマを100ミリ秒」→「4番目のコマを200ミリ秒」→「3番目のコマを100ミリ秒」
→「1番目のコマを50ミリ秒」→「2番目のコマを50ミリ秒」の順で表示
CustomSequence = 2-5:700, 1:900, 0,400, 7:200-500
「2番目～5番目のコマのどれかを700ミリ秒」
→「1番目のコマを900ミリ秒」→「0番目のコマを400ミリ秒」
→「7番目のコマを200ミリ秒～500ミリ秒の間のランダムな時間」の順で表示
アニメーションの再表示の設定
| |
キー名 |
値 |
内容 |
初期値 |
|
ResetOnRedraw |
TrueかFalse |
非表示状態から復帰したときに
アニメーションを巻き戻すかどうか【※】
True：先頭に巻き戻す
False：非表示になった時点のコマから再開する |
False |
※アイテムが非表示になるとアニメーションの動きがいったん停止されます。
（Type・ViewType・ActiveTypeキーで表示タイミングを指定しているときなど）
その停止したアニメーションを、アイテムが再表示されたときに再開するかどうかの設定です。
アイテムの表示位置指定
☆通常は『PosX・PosYキー両方とも』
ウィンドウの特定位置（四隅・四辺の中央など）からの相対位置にする場合は
『TopLeftAnchorキー』が、それぞれ必須キーになります。
（PosX・PosYは省略してもエラーにはなりませんが
TopLeftAnchorキーが未設定のときにPosX・PosYも省略すると
PosX・PosYがどちらも0扱いとなり、アイテムがフェイス左上端に配置されてしまうので
基本的にはPosX・PosYを省略せずに記述するようにしてください。
なお、OriginItemキー設定時で
基準アイテムと同じ位置に配置する場合は省略してもかまいません。）
| |
キー名 |
値 |
内容 |
初期値 |
| * |
PosX |
数値 |
アイテムの左上端位置のX座標 |
0 |
| * |
PosY |
数値 |
アイテムの左上端位置のY座標 |
0 |
|
OriginItem |
基準になるアイテムの
フィールド名【※1】 |
アイテムの表示位置が
キーの値に指定した
フィールド名のアイテムの表示位置からの
相対位置になる【※2】 |
|
| * |
TopLeftAnchor |
【※3】 |
アイテムの表示領域の左上座標を
指定した原点からの相対座標に固定する
【※4】 |
None |
| * |
BottomRightAnchor |
【※3】 |
アイテムの表示領域の右下座標を
指定した原点からの相対座標に固定し、
ウィンドウサイズの大きさに応じて
表示サイズを自動調整する【※5】 |
None |
|
Priority |
数値 |
アイテムの表示の優先度 |
0 |
※1 iniファイル（定義ファイル）内で、
このキーを記述するフィールドの前に記述されているフィールド名のみが対象。
（このキーを記述するフィールドの後にあるフィールド名や
iniファイル内に存在しないフィールド名はエラーになります。）
※2 OriginItemキーを記述した場合、
アイテムの左上端位置のX座標は、
「OriginItemで指定したアイテムのPosX＋このアイテムのPosX」に、
Y座標は「OriginItemで指定したアイテムのPosY＋このアイテムのPosY」になります。
PosX・PosYキーの数値にマイナスの数値を指定することで、
OriginItemで指定したアイテムよりも上や左に配置することもできます。
PosX・PosYキーの数値がどちらも0の場合（または、キーを省略した場合）は
OriginItemで指定したアイテムと同じ位置に配置されます。
※3 〔原点〕, 〔相対X座標〕, 〔相対Y座標〕の３つを半角スペースとカンマで区切って指定します。
原点はTopLeft（左上端）・TopCenter（上端中央）・TopRight（右上端）・
CenterLeft（左端中央）・Center（中央）・CenterRight（右端中央）・
BottomLeft（左下端）・BottomCenter（下端中央）・BottomRight（右下端）・
None（自動補正を行わない）のうちどれか１つ。
相対X座標と相対Y座標はピクセル単位だけでなく、
ウィンドウの幅や高さに対する割合でも設定が可能です。
割合で指定する場合は数値の後に半角で%を記述してください。
（%表記の場合、10.0%というふうに小数表記も可能です）
※4 このキーはPosX・PosYキーの代わりに設定します。
また、OriginItemキーの設定は無視されます。
※5 このキーはTopLeftAnchorキーとともに設定します。
アイテムの表示サイズはウィンドウサイズに応じて自動的に調整されますが、
初期サイズとしてのWidth・Heightキーは設定しておいてください。
マウスオーバー／クリックへの反応の設定
| |
キー名 |
値 |
内容 |
初期値 |
| * |
TipHint |
文字列 |
マウスカーソルがアイテムの表示位置に
一定時間置かれたときに表示されるチップヒントの内容 |
|
| * |
Enable |
TrueかFalse |
True：クリックに反応するようになる
Commandキーが設定されている
アイテムの場合、
クリック時にそのコマンドが実行される |
False |
アイテムの初期表示状態の設定
| |
キー名 |
値 |
内容 |
初期値 |
| * |
IsHided |
TrueかFalse |
True：初期状態でアイテムを非表示にする【※】 |
False |
※HideItemコマンドで非表示にしたのと同じ状態です。
後からShowItem・SwitchShowItemコマンドで表示させることはできます。
アイテムの透明度・表示範囲の設定
| |
キー名 |
値 |
内容 |
初期値 |
| * |
ConstAlpha |
数値（整数）
（0～255か-1） |
アイテムの定数α(不透明度)を指定【※】 |
-1 |
※「0」で完全透明、「255」で不透明になります。
ただし、不透明扱いにするのならキーを省略（-1に設定）するほうが高速に描画されるので
透明度を調整する必要が無い場合は、キーを省略してください。
ボタンとして動作する場合の各状態での定数アルファ値
☆ConstAlphaキーが同時に設定されている場合は
ConstAlphaキーでの透明度設定を置き換えずに、乗算した形で表示されます。
| |
キー名 |
値 |
内容 |
初期値 |
|
NormalAlpha |
数値（整数）
（0～255） |
通常時の定数アルファ値
（255で完全不透明） |
255 |
|
PushedAlpha |
数値（整数）
（0～255） |
クリック時の定数アルファ値
（255で完全不透明） |
255 |
|
MouseOverAlpha |
数値（整数）
（0～255） |
マウスオーバー時の定数アルファ値
（255で完全不透明） |
255 |
アイテムの表示エリアの差分描画の設定
| |
キー名 |
値 |
内容 |
初期値 |
|
DisablePartialUpdate |
TrueかFalse |
True：差分描画が行われなくなる |
False |
コマンドの設定
☆Typeキーの設定でスライダアイテム・WindowResizerアイテムにした場合は
コマンドの設定は無効になります。
| |
キー名 |
値 |
内容 |
初期値 |
| * |
Command |
コマンド名 |
クリック時に実行するコマンド名 |
|
| * |
CommandParamType |
【※1】 |
コマンドのパラメータの種類
（パラメータが必要なコマンドのみ） |
|
| * |
CommandParam |
【※2】 |
コマンドのパラメータの内容
（パラメータが必要なコマンドのみ） |
|
|
CommandTargetWindow |
ウィンドウ名【※3】 |
コマンドを実行する対象のウィンドウ
（別のウィンドウに対して実行する場合のみ。
省略した場合は
Commandキーを記述したウィンドウ自身が
対象になる） |
|
|
CommandTargetPlugin |
プラグイン名 |
コマンドを実行する対象のプラグイン名
（プラグインに対して実行する場合のみ） |
|
| * |
CommandCount |
数値 |
実行するコマンドの数
（複数のコマンドを設定する場合のみ【※4】） |
|
|
UseAsyncCommand |
TrueかFalse |
True：コマンドを非同期実行するようにする |
False |
※1 Int・String・Double・Bool・RandomInt・RandomString のうちどれか１つ
（コマンドによって使用できる種類が異なる）
※2 文字列や数値など、コマンドによって異なる
※3 CreateSubFace・ToggleSubFaceコマンドで開くときにパラメータで指定した「ウィンドウ名」。
サブウィンドウに記述したコマンドで、メインウィンドウを対象とする場合は
「uLilith::MainWindow」と指定する。
※4 １つのアイテムに複数のコマンドを設定する場合、
CommandCountキーを設定した上で
Command・CommandParamType・CommandParam・
CommandTargetWindow・CommandTargetPluginの全てのキーの末尾に
（スペースは入れずに）連番をつける必要があります。
例：「Command2」「CommandParamType2」など
コマンドはキー末尾につけた連番の番号の順に実行されます。
最終更新：2013年02月18日 23:07
