すべてのプロパティ

spring_boot_starter_flutter_scene が spring.flutter.scene の下で読むすべてのプロパティです。ほとんどはアプリの起動時に読まれます。enabled と debug.enabled はビルド時に spring_core_dart_generator も読み、それらによってアプリがどのコードを含むかを決めます。

使う理由

シーンが何フレーム描画するか、動くかどうか、エンジンがいつ起動するか、どのモデルがあるかは、プラットフォームごと、ビルドごとに異なります。そのため、これらはコードではなく設定です。プロファイルのファイルが、Android、Web、デバッグ実行のためにそれらを変えます。このページはそれらを一か所に列挙します。スターターのメタデータは、エディターのために同じキーを記述しています。

例

# lib/resources/application.yml
spring:
  flutter:
    scene:
      enabled: true          # false: シーンの Bean なし、プレースホルダー、モジュールのコードなし
      render: animated       # animated | still | off
      max-frame-rate: 30     # すべてのシーンの上限。0: 画面の値 (60、120、144)
      pixel-ratio: 1.5       # シーン独自の値。未設定: デバイスの値
      canvas: page           # ブラウザーで: page | layer | engine
      light-clustering: true # false: メッシュごとに、そこへ届く光源で陰影付けする
      when:
        touch: still         # タッチスクリーン: 静止した一つのフレーム
        slow: still          # このデバイスでは遅すぎる
      slow:
        frame-time: 16ms     # シーンのビートがその半分を超えたら遅い
        probe: 24            # シーンが表示される前に計測するフレーム数
        after: 3s            # 表示された後、遅いビートがこれだけ続いたら
      pause-off-screen: true
      preload: lazy          # eager: エンジンはスプラッシュとともに起動する
      engine-log: true       # アプリのログの中のエンジンのメッセージ
      models:
        hero:
          source: asset:assets/models/hero.glb
          preload: eager     # 未設定: 上の `preload` と同じ
      materials:
        glass:
          source: assets/materials/glass.fmat
          preload: eager     # 未設定: 上の `preload` と同じ
      app:
        enabled: false       # true: アプリケーションのシーン
        placement: background  # background | none
        camera:
          position: 0, 1.5, -4
          target: 0, 1, 0
          fov: 45
      debug:
        enabled: true        # シーンのタブ。未設定: デバッグビルドとプロファイルビルド
# lib/resources/application.properties: 同じ内容
spring.flutter.scene.enabled=true
spring.flutter.scene.render=animated
spring.flutter.scene.max-frame-rate=30
spring.flutter.scene.pixel-ratio=1.5
spring.flutter.scene.canvas=page
spring.flutter.scene.light-clustering=true
spring.flutter.scene.when.touch=still
spring.flutter.scene.when.slow=still
spring.flutter.scene.slow.frame-time=16ms
spring.flutter.scene.slow.probe=24
spring.flutter.scene.slow.after=3s
spring.flutter.scene.pause-off-screen=true
spring.flutter.scene.preload=lazy
spring.flutter.scene.engine-log=true
spring.flutter.scene.models.hero.source=asset:assets/models/hero.glb
spring.flutter.scene.models.hero.preload=eager
spring.flutter.scene.materials.glass.source=assets/materials/glass.fmat
spring.flutter.scene.materials.glass.preload=eager
spring.flutter.scene.app.enabled=false
spring.flutter.scene.app.placement=background
spring.flutter.scene.app.camera.position=0,1.5,-4
spring.flutter.scene.app.camera.target=0,1,0
spring.flutter.scene.app.camera.fov=45
spring.flutter.scene.debug.enabled=true

一つのプラットフォームのための値は、他と同じく、そのプロファイルのファイルに置きます。application-android.yml の render: still や、デバッグ実行が使うプロファイルです。デバッグ実行では、一つのフレームにリリースの数倍のコストがかかります。

spring.flutter.scene

キー 型 デフォルト 読まれる時 意味 ページ
spring.flutter.scene.enabled bool true 起動時とジェネレーターが アプリがシーンを持つかどうか。false なら、シーンの Bean は一つも存在せず、エンジンは起動されず、すべてのシーンのウィジェットがプレースホルダーを表示する シーンが描画されない場所
spring.flutter.scene.render animated、still、off animated 起動時 シーンの描画方法。一秒あたり max-frame-rate フレームまで、静止した一つのフレーム (表示するものが変わったときだけ描画し直される)、またはまったく描画しない (ウィジェットはプレースホルダーを表示する) ウィジェットとしてのシーン
spring.flutter.scene.max-frame-rate 数値 30 起動時 シーンが一秒あたりに描画する最大のフレーム数。ウィジェットはそれより少ないフレームを求められる。0 は画面が表示するだけのフレーム (ブラウザーではそのすべてのフレームで、モニターによって 60、120、144。それ以外ではディスプレイのリフレッシュレートで、システムが値を返さなければ 60) スマートフォンでの速さ
spring.flutter.scene.pixel-ratio 数値 デバイスの値 起動時 シーン独自のピクセル比。デバイスの値以下。3 の画面で 1 にすると、ピクセルの 9 分の 1 を描画する シーンのコスト
spring.flutter.scene.canvas page、layer、engine page 起動時。engine はエンジンの起動時 ブラウザーでシーンが描かれるキャンバス。page (Flutter がシーンのフレームをページの中に描き、その周りのページも描き直す)、layer (ページの下にあるシーンごとのキャンバス。フレームはブラウザーが受け渡し、Firefox と WebKit ではコピーされる)、engine (ページの下にあるエンジン自身のキャンバス。すべてのシーンがその場所に描かれ、受け渡しもコピーもない)。ビューは layer か page を求められる (SpringSceneView.canvas)。engine はアプリ全体の設定。ブラウザー以外では Flutter がシーンを描く スマートフォンでの速さ
spring.flutter.scene.light-clustering bool true 起動時。すべてのビューのシーンに適用される シーンの光源 (ポイント、スポット、エリアライト) を、エンジンのクラスタリング (Scene.punctualLightClustering) を通して陰影付けするかどうか。false なら、メッシュはそれぞれ自分に届く光源で陰影付けし、光源が少なければこちらが軽い。クラスタリングは、光源がビューに入ったり出たりするたびに光源のテクスチャーを作り直し、iPhone では約 30 ms のフレームになる スマートフォンでの速さ
spring.flutter.scene.pause-off-screen bool true 起動時 スクロールで画面の外に出たシーンが描画を止めるかどうか ウィジェットとしてのシーン
spring.flutter.scene.preload eager、lazy lazy 起動時 エンジンが起動する時。eager はスプラッシュとともに、lazy は最初のシーンが表示されるとき。モデルは独自の値を持つ 起動
spring.flutter.scene.engine-log bool true 起動時 エンジン自身のメッセージ (Flutter の debugPrint で書き出される) を、ロガー flutter_scene のもとでアプリケーションのログのレコードにするかどうか。時刻とレベルを持ち、logging.level.flutter_scene で設定する エンジンのログ

spring.flutter.scene.when

キー 型 デフォルト 読まれる時 意味
spring.flutter.scene.when.<condition> still、off なし 起動時 条件が成り立つ間、すべてのシーンが取るモード。静止した一つのフレーム、またはプレースホルダー。render と、成り立っている条件のモードのうち、最も控えめなものが使われる。スターターの条件は touch (デバイスの主なポインターが指。ブラウザーでは粗いポインター、それ以外では Android と iOS) と slow (後述)。アプリ独自の条件は SceneCondition Bean で、その name で指定する。ここに書かれていない条件は何も変えず、slow は何も計測しない

ここに書かれた条件がまだ調べている間 (SceneCondition.settled が false)、動くシーンはすべてプレースホルダーの後ろで待ちます。スマートフォンでの速さ を参照してください。

spring.flutter.scene.slow

spring.flutter.scene.when の条件 slow のための設定です。判定は、最初のシーンが読み込まれる間、プレースホルダーを表示したまま、シーン自身のフレームで行われます。そのため、シーンは最初から最後まで同じモードで表示され、ユーザーの目の前で消されることはありません。

キー 型 デフォルト 読まれる時 意味
spring.flutter.scene.slow.frame-time 時間 16ms 起動時 一フレームの時間。シーンのビート (動いているすべてのシーンを一度ずつ描くのにページのスレッドで使った時間の、計測した中の中央値) がその半分を超えたら遅い
spring.flutter.scene.slow.probe 数値 24 起動時 シーンが表示される前に計測する、最初のシーンのフレーム数。エンジンがプログラムをビルドする最初の 6 フレームの後から数える
spring.flutter.scene.slow.after 時間 3s 起動時 シーンが表示された後、遅いビートがどれだけ続いたら条件が成り立つか。成り立つのは次に何も動いていない瞬間で、その後は実行が終わるまで成り立ったまま。ここで数えるのは Flutter が描かないフレームだけ (ブラウザーでの canvas: layer または engine)

slow を参照してください。

spring.flutter.scene.models

キー 型 デフォルト 読まれる時 意味
spring.flutter.scene.models.<name>.source アセットまたはアドレス なし。必須 起動時 モデルの .glb ファイルの場所。アプリのアセット (asset:assets/models/hero.glb。flutter: assets: の下に列挙する) またはアドレス (https://cdn.example.com/hero.glb。ブラウザーでは、そのサーバーがページのオリジンを許可する必要がある)。lib/resources/ のファイルではない
spring.flutter.scene.models.<name>.preload eager、lazy spring.flutter.scene.preload と同じ 起動時 読み込まれる時。eager はスプラッシュとともに、lazy はシーンが最初にそれを表示するとき

モデル を参照してください。

spring.flutter.scene.materials

キー 型 既定 読まれる時 意味
spring.flutter.scene.materials.<name>.source パス なし。必須 起動時と、ビルドフック マテリアルの .fmat ファイルを、アプリのルートからのパスで (assets/materials/glass.fmat)。asset: は付けない。フックがコンパイルしたファイルの中にないとき、ビルドは失敗する
spring.flutter.scene.materials.<name>.preload eager、lazy spring.flutter.scene.preload と同じ 起動時 読み込まれる時。eager はスプラッシュとともに、lazy はシーンが最初にそれを表示するとき

マテリアル を参照してください。

spring.flutter.scene.app

キー 型 デフォルト 読まれる時 意味
spring.flutter.scene.app.enabled bool false 起動時 アプリが独自のシーンを一つ持つかどうか (applicationScene Bean)。スプラッシュとともに作られる
spring.flutter.scene.app.placement background、none background 起動時 表示される場所。background はすべての画面の下、none はアプリが SpringSceneView を置く場所だけ
spring.flutter.scene.app.camera.position x, y, z 0, 0, -5 起動時 カメラの位置
spring.flutter.scene.app.camera.target x, y, z 0, 0, 0 起動時 カメラが見る点
spring.flutter.scene.app.camera.fov 度 45 起動時 垂直方向の視野角

アプリケーションのシーン を参照してください。

spring.flutter.scene.debug

キー 型 デフォルト 読まれる時 意味
spring.flutter.scene.debug.enabled true、false 未設定 起動時とジェネレーターが アプリがデバッグパネルのシーンのタブを持つかどうか。true はすべてのビルド、false はどのビルドにもない (ビルドがそのコードを外す)、未設定はデバッグビルドとプロファイルビルドだけ

デバッグタブ を参照してください。

シーンが従う他のスターターのキー

キー スターター 意味
spring.flutter.debug.enabled Flutter シーンのタブが入るデバッグパネルを、ビルドが持つかどうか (デバッグパネル を参照)
spring.flutter.frame-meter.enabled Flutter フレームメーター。Flutter が描かないシーンのフレームを、専用の行に表示する: 3D 60 fps · 0.9 ms (フレームメーター を参照)
spring.flutter.splash.tasks.* Flutter スプラッシュがタスクを待つ時間。シーンのタスクもその一つ (スプラッシュのタスク を参照)
spring.remote.allow-insecure Spring Boot モデルのファイルに http:// のアドレスを許可する。なければ https:// だけが読まれる (モデル を参照)
spring.flutter.web.dev-server.headers.<Name> Flutter flutter run のヘッダー。クロスオリジン分離されたページのため (シーンのコスト を参照)

関連項目