DEKI/ENGINE ドキュメント
deki-tween 0.19.0
Deki パッケージリファレンス
deki-tween

30 種類以上のイージング関数を備えたトゥイーン。インスペクターでは TweenComponent、コードでは TweenManager を使います。

リポジトリ: github.com/dekiengine/deki-tween · 最新リリース: 0.19.0 · エンジン 0.19.0 以降が必要

DekiEditor --packages-add deki-tween <project> か、パッケージマネージャーからインストールします。エンジン自身のコンポーネントと C++ API は Deki のドキュメントにあります。

エディターでは Tween と表示されます。

コンポーネント

コンポーネント カテゴリ 説明
TweenComponent アニメーション イージングカーブに沿って、オブジェクトの位置、スケール、回転をアニメーションさせます。

機能フラグ

ビルドから外せる部分です。define を持つ機能はその define で切り替わり、それ以外はコンポーネントと一緒に取り除かれます。

機能 define デフォルト
Tween DEKI_FEATURE_TWEEN オン

コンポーネントリファレンス

TweenComponent

イージングカーブに沿って、オブジェクトの位置、スケール、回転をアニメーションさせます。

インスペクターでの名前: トゥイーンコンポーネント · カテゴリ: アニメーション · 型: DekiTween::TweenComponent

プロパティ 型 デフォルト 制約 説明
targetType enum "Position" Position, Scale, Rotation オブジェクトのどのプロパティをアニメーションさせるかです。位置、スケール、回転、色から選びます。
endValue Vector3 [0.0, 0.0, 0.0] 到達する値です。どの成分を使うかは、上の対象によって決まります。
duration float 1 0.1 から 10 (スライダー) 1 回の再生にかかる時間 (秒) です。
delay float 0 0 から 5 (スライダー) 開始する前に待つ時間 (秒) です。
easeType enum "Linear" Linear, SineIn, SineOut, SineInOut, QuadIn, QuadOut, QuadInOut, CubicIn, CubicOut, CubicInOut, QuartIn, QuartOut, QuartInOut, QuintIn, QuintOut, QuintInOut, ExpoIn, ExpoOut, ExpoInOut, CircIn, CircOut, CircInOut, BackIn, BackOut, BackInOut, ElasticIn, ElasticOut, ElasticInOut, BounceIn, BounceOut, BounceInOut 動きのカーブです。リニアは機械的な動きになります。イーズインアウトは始まりと終わりがゆるやかで、ほとんどのものに自然に見えます。
loops int32 0 -1 から 100 再生する回数です。0 は 1 回だけ、-1 は無限に繰り返します。
pingPong bool false 最初に戻る代わりに、1 回おきにトゥイーンを逆向きに再生します。
autoPlay bool true オブジェクトが動き始めるとすぐに開始します。オフにすると、ほかの何かが開始させる必要があります。
relative bool false 終了値を絶対的な目的地ではなく、オブジェクトの現在位置からのオフセットとして扱います。

変更履歴

変更履歴は英語です。

0.19.0

Changed

  • minEngine 0.19.0: built against engine 0.19.0, whose component metadata records the package each class is in. A build of this package from before does not load and is rebuilt.

Added

  • Japanese, Simplified Chinese and Korean: editor/lang/ja.json, zh.json and ko.json translate the names, tooltips and enum values this package's components show in the Inspector.
  • The package's editor text goes through the editor's translation (Tr), so it shows in the editor's language. Needs the editor release that adds Localization.h; raise minEngine to it when releasing.

0.18.0

Changed

  • minEngine 0.18.0. Reflection ABI 21: the package must be rebuilt.
  • Names follow the code style (deki-engine/docs/codestyle): types, functions and enum values are PascalCase, constants kPascalCase, members m_PascalCase, locals and parameters camelCase. The code is formatted with clang-format 22.
  • The functions the editor finds by name are PascalCase: DekiTweenRegisterComponents, DekiTweenGetAutoComponentCount, DekiTweenEnsureRegistered and the rest. Built against engine ABI 21; a build of this package from before does not load and is rebuilt.
  • Renamed: on_complete and on_update are onComplete and onUpdate; EaseType::COUNT is Count.

Removed

  • The former names from before 0.16.0 (bare class names, and deki-gpio's DekiEsp32::ESP32PinSetup). A scene that old is upgraded with 0.17 first.

それ以前のリリース: CHANGELOG.md


パッケージのリフレクションデータから生成しています (エンジン 0.19.0)。プロパティ名はシーンファイルで使われるキーです。名前を変えても別名が残ります (互換性)。