シーンが描画されない場所

シーンはどこでも描画されるわけではありません。アプリがオフにすることもあれば、ブラウザーに WebGL2 がないことも、エンジンの起動が失敗することもあります。そこでは、シーンのウィジェットはプレースホルダーを表示する素のウィジェットになり、アプリは動き続けます。

使う理由

これがなければ、シーンを表示するすべての場所が「このデバイスは描画できるか」を調べ、別のものを組み立てることになります。スターターは一度だけ調べます。ウィジェットにチェックは不要で、アプリのコードに、そのための分岐はありません。

三つの場合

いつ ウィジェットが行うこと Bean
spring.flutter.scene.enabled: false プレースホルダー 一つも存在しない。アプリケーション自身の設定にあれば、ビルドがモジュールを外す
render: off プレースホルダー 存在する。エンジンは起動されない
エンジンが起動しなかった (WebGL2 がない、Flutter GPU がない、WebGL のフレームをページに渡さないブラウザー) プレースホルダー 存在する。SceneUnavailableEvent が理由を一度だけ伝える

spring.flutter.scene.when の条件が off を求めているときは、それが成り立つ間、render: off と同じことが起きます (コストがかかりすぎる場所で描画を減らす を参照)。

SpringSceneView は placeholder を組み立て、エンジンのものは何も組み立てません。SceneBackdrop は placeholder と child を組み立てます。プレースホルダーのないビューは空です。

オフにしたシーン

# lib/resources/application.yml
spring:
  flutter:
    scene:
      enabled: false

このプロパティは二度読まれます。

シーンのウィジェットはアプリのコードに残り、エンジンの名前を使い続けるため、エンジンのコードはビルドに残ります。

render: off は、より軽いスイッチです。Bean は存在し、エンジンは起動されず、ウィジェットはプレースホルダーを表示します。一つのプラットフォームのための値は、そのプロファイルのファイルに置きます (プラットフォームのプロファイル を参照)。

# lib/resources/application-android.yml
spring:
  flutter:
    scene:
      render: off

エンジンが起動しなかった

エンジンは、アプリのために一度だけ起動します (イベントと言葉で表す起動 を参照)。描画できない場所 (WebGL2 のないブラウザー、Flutter GPU がオンになっていないネイティブプラットフォーム) では、起動は失敗します。ブラウザー以外では、プラットフォーム自身のファイルの中の一行で Flutter GPU をオンにします。ネイティブプラットフォーム を参照してください。起動の失敗は、アプリの失敗ではありません。

存在しないかもしれないシーンの Bean

シーンをオフにすると、シーンの Bean は一つも存在しません。それを必要とするアプリ自身のコードは、存在しないかもしれない Bean として受け取ります。

@Component()
class Showroom {
  Showroom(this.models);

  final ObjectProvider<SceneModels> models;

  Future<void> open() async => models.getIfAvailable()?['hero'].load();
}

ウィジェットも、同じ方法でコンテキストに問い合わせます。

final status = context.springContext
    .getBeanProvider<SceneStatus>()
    .getIfAvailable();

ObjectProvider を参照してください。

SceneAvailability

SceneAvailability (sceneAvailability) は、ここでシーンが描画されるかどうかを知っている唯一の場所です。スターターのすべてのシーンのウィジェットがこれを読みます。これは ChangeNotifier で、エンジンの起動が進んだとき、そして spring.flutter.scene.when の条件が成り立ち始めたときや成り立たなくなったときに、リスナーに通知します。

メンバー 意味
draws シーンが描画されるかどうか。いま、またはエンジンが起動した後に
isReady この瞬間にシーンを描画できるかどうか
reason シーンが描画されない理由: SceneUnavailable.off (render: off、または off を求める when の条件) または SceneUnavailable.engine (エンジンが起動しなかった)。描画されるなら null
render いまのシーンの描画方法。render の値、または when の条件が成り立つ間はそれより控えめなもの
animates シーンが動くかどうか。静止した一つのフレームなら false
frameRate([asked]) asked を求めるシーンの一秒あたりのフレーム数。max-frame-rate を超えることはない。max-frame-rate: 0 なら画面のフレーム数
conditions シーンが従う条件 (SceneCondition Bean)
held いま成り立っていてモードを変えている条件と、それぞれが求めるモード
deciding when に書かれた条件が、まだ調べているかどうか。その間、動くシーンはプレースホルダーの後ろにとどまる
engine SceneEngine: その state (idle、starting、ready、failed)、failure、took

spring.flutter.scene.enabled: false なら、この Bean も存在しません。それを必要とするコードは ObjectProvider<SceneAvailability> を受け取ります。

関連項目