TextSprite   [w]


ワードラップの実装(20251103)
HTML5版テスト2(新)
HTML5版テスト(旧)

何度目かの作り直しでやっと納得の行く表示になったかと思います。


--------------------------------------------------------------------------------
-- TextSprite Extension 20261107
--------------------------------------------------------------------------------
動作までの配置
CF25\Extensions\Unicode\TextSprite.mfx
CF25\Data\Runtime\Unicode\TextSprite.mfx

-----------------------------
※新しい更新箇所

20261107	文字配置のアラインメント変更命令 SetAlignment の追加(一覧型バックログにも適用)
20261105	ルビ表示機能 [RUBY:対象文字,ルビ,scale,align] 及び RubyDefaultScale の追加
20261105	ルビ縮小時のアンチエイリアス処理改善
20261105	バックログ・ページロールバック機能群の追加

20261022	パラメーター定義数に不備があったのを修正(内部クラッシュの改善)
20261020	アンチエイリアス・アウトライン・シャドウの改善
20261020	キャッシュにより個別文字の変更が反映されない件の改善
20261020	新規命令の追加 [VIB:str,spd] *BOILでも動作
20260624	文字数が増えた際にパフォーマンスが下がるケースの改善
20260215	連続する複数のCALLBACKが呼び出されても実行されるように調整
20251203	getCharcterの追加、改行コードが再生中の文字位置情報へ干渉していた点を修正
20251120	TextSync時のウエイトが0に近い時に[P]タグが誤作動するケースの修正
20251117	文字を画像に変更するSetReplaceSpriteImageの追加
20251117	DX11乗算済みアルファの再調整
20251112	DX11乗算済みアルファの表示調整
20251110	再生中の文字の取得位置の調整・コールバック位置の調整(タグによるズレが生じていた)
20251106	再生中の文字位置/完了位置を取得できるように調整
20251105	再生中の文字位置を取得できるように調整
20251103	ワードラップの実装(英語圏向け) SetWordBreak

--------------------------------------------------------------------------------
■仕様など
標準のテキストオブジェクトとリンクさせる事で、色々な表現ができるようになります。

・文字の出現アニメーションとその管理
・文字のグラデーション、アウトライン、シャドウ、アンチエイリアス(文字・アウトライン)
・単一文字への座標管理、拡大、回転、着色、座標取得
・行間の設定、アラインメント(上下・左右)の動的変更
・縦書きへの対応と位置合わせ
・文字全体の回転・拡大・着色
・フォントの画像化とスプライトフォント化機能
・文字へ画像の合成
・ルビ(ふりがな・注釈)の配置と装飾
・ページ単位のロールバック及び一覧型バックログ表示

基本的に文字列オブジェクトの文字配置設定を互換します(SetAlignment指定時は命令側の設定が優先されます)。

□アンチエイリアスの設定について
それぞれ動作に特徴があり
・文字列オブジェクトのアンチエイリアス設定(文字の回りにアンチエイリアス)
・TextSprite Extensionでのアンチエイリアス設定(アウトラインやスケーリング時に有効)

RGB設定などのエフェクトはTextSprite側で利用されます。

□制限について
DX11でも動作しますが、乗算済みテクスチャがONになっていると正しく動作しないようです
32bitカラーのみ対応
PNGフィルタの追加を明示的に行わなくてもビルド時にPNGフィルタが内包されるようになりました


※FRGB,GRGB,ORGB,IMSKといった、フォント生成に関係する機能では
スプライトフォント化しての実行動作に対しての動作はしませんので注意。

--------------------------------------------------------------------------------
■簡易スクリプトについて
文中に下記の書式が混ざる場合、文字及びアニメーションへの効果が起こります
文字効果については設定以降の文字に対して影響されますので、戻す場合は再度上書きする形で再設定してください

[FRGB:255,0,0]	文字の色自体の変更
[GRGB:255,0,0]	グラデーションカラーの変更
[ORGB:255,0,0]	アウトラインカラーの変更
[RGB:255,0,0]	フィルタエフェクトとして色を変更します(この例では赤になります)
[WAIT:60]		ウエイトを掛けます(この例では60フレームのウエイト)
[SPD:5]			標準ウエイト値の変更 (TextSync時に設定するウエイトの変更)
[FADE:5]		フェードスピードの変更(TextSync時に設定するアニメーションフェードスピードの変更)
[SCALE:1.0,1.0]	スケール値の変更(widthとheightのスケールを変更します)
[P]				表示の一時停止を行います

[WAVE:1.0,0.1]	文字を揺らします。渡す値はfloat(幅,フレームあたりの速度)です
				※ドット幅をマイナスにすると横方向に揺らします

[IMSK:0,1]		画像マスク適用フラグを変更します (この例ではslot 0を Onにする)
				機能的に UseImageMask( slot , flg )と同じものです。

[CALL:あいう]	このスクリプトが表示されるタイミングでCallBackScriptが発生します
				getCallBackによってその内容を取り出せます。

[VIB:1.5,4]		文字そのものを揺らすエフェクトですfloat(強さ,何フレームで揺らすかの値です) *BOILでも動作

[RUBY:親文字,ルビ,scale,align]
				対象文字列にルビ(ふりがな・注釈)を振ります。第3・第4引数は省略可能です。
				記述例: [RUBY:漢字,かんじ] / [RUBY:漢字,かんじ,0.5,2]
				・第3引数(scale): 親文字に対するルビの相対サイズ(省略時はRubyDefaultScaleの値、初期値0.5)
				・第4引数(align): 配置モード(省略時は 0)
					0: 親文字幅を固定し、ルビを中央寄せ(ルビが長い場合は左右にはみ出す)
					1: 親文字幅を固定し、ルビが短い場合は親文字幅に合わせてルビを均等割り付け
					2: ルビが親文字より長い場合、親文字全体の前後余白を拡張して重なりを防止(中央寄せ)
					3: 親文字とルビの短い方を長い方の幅に合わせて均等割り付け(前後の重なりも防止)
				※親文字・ルビの内部には [FRGB:...] や [WAVE:...] 等の文字装飾タグを入れ子で記述可能です。
				※getCharcter$ 等の文字列取得ではルビは含まれず、親文字のみが取得されます。

--------------------------------------------------------------------------------
■プロパティ
アウトサインの幅やアウトラインの色
フォントシャドウの有無、シャドウの色などを設定できます

■Action

LinkTextObject
	標準のテキストオブジェクトの固定値を指定し、エクステンションとリンクさせます

TextSync( ウエイト , アニメーションフェードスピード)
	テキストオブジェクトに設定されている文字情報を元に、表示設定を行います

AnimationSkipToPauseTag
	次にある[P]タグまでアニメーションをスキップします

AnimationSkip
	アニメーション機能をスキップし、全部表示させます

AnimationPause
	アニメーションのウエイトを一時停止させます(それまでのフェードインは継続される)

AnimationResume
	アニメーションのウエイトを再開します

SetGradientMode
	文字のグラデーションモードを変更します(プロパティのチェックボックスにもあり)

SetOutline
	アウトラインの幅を指定します(プロパティのチェックボックスにもあり)

SetHotSpot
	テキストボックスを対象に、ホットスポットを設定します(回転拡縮向け)

SetScale
	テキストボックスを対象に、スケール値を設定します

SetAngle
	テキストボックスを対象に、回転角を設定します

SetPosition
	テキストボックスを対象に、位置を変更します


CharactersDefaultAngle
	表示される文字全体の回転角を設定します

CharactersDefaultScale
	表示される文字全体のスケールを設定します
	
CharactersDefaultRGB
	表示される文字全体のRGBを設定します

RubyDefaultScale
	[RUBY:...]タグの第3引数(サイズ倍率)を省略した際の初期スケール値を設定します(デフォルト: 0.5)
	

setCharacterPosition
	1文字あたりを対象に、位置を変更します

setCharacterHotspot
	1文字あたりを対象に、ホットスポットを変更します

setCharacterScale
	1文字あたりを対象に、スケールを変更します

setCharacterAngle
	1文字あたりを対象に、回転角を変更します

setCharacterRGB
	1文字あたりを対象に、RGB色を設定します

setCharacterAlpha
	1文字あたりを対象に、アルファ値を設定します
	
refreshCharacters
	文字情報(サイズなど)を変更している場合、変更後サイズを元にテキスト位置の再計算を行います

addCharacterWait
	1文字あたりを対象に、アニメーションウエイトを加算します(マイナスを指定すれば減算)

SetLineSpace
	行間を指定します

SetAlignment( horizontal , vertical )
	文字の配置アラインメントを変更します(命令で設定した場合は文字列オブジェクト側の設定より優先されます)
	・第1引数(horizontal / 左右): 0:左寄せ(縦書き時は右端開始) / 1:左右中央 / 2:右寄せ(縦書き時は左端寄せ) / -1:文字列オブジェクトの設定に準拠
	・第2引数(vertical / 上下):   0:上寄せ / 1:上下中央 / 2:下寄せ / -1:文字列オブジェクトの設定に準拠
	※通常表示中だけでなく、SetBacklogMode(1)による一覧型バックログの過去ログ表示位置にも反映されます。

SetVerticalWrite
	縦書き設定を指定できます(プロパティのチェックボックスにもあり)


imagefont_outfile
	現在のテキストを元にスプライトフォントを出力します

imagefont_infile
	スプライトフォントを読み込みます

imagefont_mode
	スプライトフォントの使用を設定します

ChangeTextBoxRect
	描画する位置やサイズを変更できます

SetOutLineMode
	アウトラインを使用する際の描画モードを設定します(0で囲み表示 1で描画をズラして表示)

SetAnimationType
	表示アニメーションのパターンを設定します

SetImageMask( slot , active_object_fixed )
	フォントに合成する画像を、アクティブオブジェクトを通して指定します

UseImageMask( slot , flg )
	登録したスロットに対して、使用フラグを設定します

SetWordBreak( flg )
	ワードラップの使用フラグを設定します

SetReplaceSpriteImage( TargetCharacter , active_object_fixed )
	画像に変更する文字を、アクティブオブジェクトを通して指定します
	active_object_fixedにゼロを指定すると解除


□Backlog (バックログ・ロールバック関連 Action)

Rollback( step )
	ページ単位で表示をロールバック(巻き戻し・送り)します(-1で1ページ前、+1で1ページ次へ移動)
	ロールバック中は進行中だったアニメーションはその場で一時凍結され、過去ページは即座に全文表示されます(CALL等の再発火は行われません)

ExitRollback
	ロールバック表示を終了し、最新のページ状態(凍結されていたアニメーション状態)へ即座に復帰します

SetHistoryMetadata( metadata_string )
	現在表示中のページ履歴に対して、話者名やボイス識別子などの任意のメタデータ文字列を記録します

SetHistoryRecordMode( flg )
	TextSync実行時に履歴へ自動記録するかどうかのフラグを設定します(0:記録しない 1:記録する)

SetMaxHistoryCount( max_pages )
	保持する最大履歴ページ数を設定します(デフォルト: 50)

ClearHistory
	記録されているすべての履歴データを消去します

SetBacklogMode( flg )
	一覧型のバックログ表示モードのON(1)/OFF(0)を切り替えます
	ONの間は通常のメッセージ進行を停止し、指定領域内に過去の履歴を一覧描画します(SetAlignmentによる配置変更にも対応)

SetBacklogRect( x , y , width , height , margin )
	一覧型バックログ表示時の描画領域(X, Y, 幅, 高さ)と、各履歴ブロック間の余白(margin)を設定します

SetBacklogScroll( scroll_offset )
	一覧型バックログ表示時のスクロール位置(ピクセル単位、0が最新位置)を設定します


※基本的な使い方は動作サンプルを見て頂ければ大体わかるかと思います。
--------------------------------------------------------------------------------
■Expressions

getcharcterPosition
	1文字あたりを対象に、配置位置を取得します(ボックスからの相対距離)
	0:x座標 1:y座標 2:計算後x座標 3:計算後y座標
	(setCharacterPosition等で変更した値は前者の値が取れ、後者の値は配置後の固定値)

getcharcterSize
	1文字あたりを対象に、幅情報を取得できます(行間含む)
	※文字のピクセルサイズも取得できるように拡張されました (PW PH)

getcharcterAnimationStep
	1文字あたりを対象に、アニメーションフェード値が取得できます

getcharcterAngle
	1文字あたりを対象に、角度が取得できます

getcharcterAlpha
	1文字あたりを対象に、アルファ値が取得できます

getStringSize
	スクリプト記述を除外した文字列の長さを取得できます

getCallBack$
	簡易スクリプト[CALL:]の中身を取得します

getCallBackPosition
	コールバック発生位置にある文字位置を取得できます

getCharcter$( num )
	指定した番号の文字を取得します ※簡易スクリプトのタグ及びルビは省かれた状態で取得

getAnimationStringPos
	フェードアニメーション中の文字の開始点と終了点を取得できます

getHistoryCount
	現在記録されているバックログ履歴のページ数を取得します

getRollbackOffset
	現在のロールバック位置オフセットを取得します(0:最新ページ、1:1つ前のページ…)

getHistoryText$( offset , mode )
	指定したオフセット位置(0:最新、1:1つ前…)の履歴テキストを取得します
	mode 0:タグ・ルビを除去したプレーンテキスト / 1:タグを含んだ生テキスト

getHistoryMetadata$( offset )
	指定したオフセット位置(0:最新、1:1つ前…)に紐付けられたメタデータ文字列を取得します

getBacklogScroll( mode )
	一覧型バックログ表示時のスクロール値を取得します(0:現在のスクロール位置、1:最大スクロール可能量)

--------------------------------------------------------------------------------
■Conditions

FinishAnimationDraw
	全ての表示が終了したら発生します

ScriptPause
	簡易スクリプトによる一時停止発生時に発生します

CallBackScript
	簡易スクリプト[CALL:]が呼び出されたタイミングで発生します
	getCallBackと連携し、中身を取り出せます

IsInRollback
	現在ページロールバック表示中である場合に発生(真)します

CanRollback( direction )
	指定した方向(-1:過去方向、1:最新方向)へさらにロールバック移動が可能である場合に真になります

IsBacklogMode
	現在一覧型バックログ表示モード中である場合に真になります


--------------------------------------------------------------------------------
□変更点

20261107	文字配置のアラインメント変更命令 SetAlignment の追加(一覧型バックログにも適用)
20261105	ルビ表示機能 [RUBY:対象文字,ルビ,scale,align] 及び RubyDefaultScale の追加
20261105	ルビ縮小時のアンチエイリアス処理改善
20261105	バックログ・ページロールバック機能群の追加

20261022	パラメーター定義数に不備があったのを修正(内部クラッシュの改善)
20261020	アンチエイリアス・アウトライン・シャドウの改善
20261020	キャッシュにより個別文字の変更が反映されない件の改善
20261020	新規命令の追加 [VIB:str,spd] *BOILでも動作
20260624	文字数が増えた際にパフォーマンスが下がるケースの改善
20260215	連続する複数のCALLBACKが呼び出されても実行されるように調整
20251203	getCharcterの追加、改行コードが再生中の文字位置情報へ干渉していた点を修正
20251120	TextSync時のウエイトが0に近い時に[P]タグが誤作動する点の修正
20251117	文字を画像に変更するSetReplaceSpriteImageの追加
20251117	DX11乗算済みアルファの再調整
20251112	DX11乗算済みアルファの表示調整
20251110	再生中の文字の取得位置の調整・コールバック位置の調整(タグによるズレが生じていた)
20251106	再生中の文字位置/完了位置を取得できるように調整
20251105	再生中の文字位置を取得できるように調整
20251103	ワードラップの実装(英語圏向け) 
20240707	DirectX11の乗算アルファでも表示されるように調整
20231222	画面外に移動しても自動的に削除されないように調整
20221114	外部ファイル読み込み起動に関する処理を修正
20220908	表示の再修正・コールバック位置を取得できる機能の追加
20220907	[CALL:abc]コールバック機能の追加と一部不具合の修正
20220905	[P]タグまでスキップする機能の追加と一部不具合の修正
20220903	文字に画像を合成する機能の追加
20220729	表示アニメーションのパターンを追加
20220725	文字を揺らす簡易スクリプトの追加[WAVE:vec,spd]
20220521	アクションから影の指定をできるようにするSetTextShadowの追加
			簡易スクリプト構文の追加
			テキストシャドウ生成の調整
20220520	少し綺麗に見えるアウトラインモードの追加 SetOutLineModeの拡張
20220513	ChangeTextBoxRectにより任意の位置とサイズにできるように拡張
			フォントによってはスペースにドットが出現していた点を調整
20220508	簡易スクリプトを除外した文字列の長さを取得できるように拡張
20220506	シャドウONの際に文字単体のα値を操作してもシャドウはそのままだった点の修正
20220505	簡易スクリプトのRGBが正しい値になっていなかった点の修正(CharactersDefaultRGBの追加)
20220504	文字のリアルサイズを取得できるように拡張
20220119	簡易スクリプトの実装
20220118	アニメーションの一時停止と再開の実装
20220127	ターゲット文字列側スクロールオプションに追随する拡張
20211126	連続する改行を認識していなかった点の改良
20211016	DX11において最速描画時に表示が1テンポ遅れていた点の修正
20211015	アウトライン設定アクション命令が抜けていたので調整
			サブアプリ実行時に描画が狂った部分の修正
20210922	ビルド後の実行ファイルでは
			スプライトフォントの読み込み利用時に
			自動でバイナリ内包ファイルを展開して読み込むようになりました

20210927	フォント画像生成時にフォントがテキストBOXより小さい場合に不正落ちする点の改良
20210927	複数のフォントがある場合、上手く動作しなかった点の改善
20210925	シャドウカラーに不備が見られたので改善

--------------------------------------------------------------------------------
■あとがき

	完成した。


基本的に無償で公開していますが
制作したエクステンションを使っての作品が大ヒットして
儲かって儲かって仕方がないというような方は
干し芋リストを公開していますので何かご支援下さると、とても喜びます。























DOWNLOAD(20261107)

OLDVER(20261105)
OLDVER(20261022)
OLDVER(20260624)
OLDVER(20260215)
OLDVER(20251203)
OLDVER(20251120)
OLDVER(20251112)
OLDVER(20251110)
OLDVER
OLDVER
OLDVER
OLDVER