アプリケーションのシーン
spring.flutter.scene.app.enabled: true なら、アプリは独自のシーンを一つ持ちます。スプラッシュとともに作られる applicationScene Bean です。すべての画面の下と、すべての const SpringSceneView() に表示されます。
使う理由
画面が変わっても残る背景は、一つの画面のものにはできません。画面ごとに作り直されてしまうからです。アプリケーションのシーンは一度だけ作られ、アプリと同じ期間だけ存在し、Bean が中身を入れます。
例
# lib/resources/application.yml
spring:
flutter:
scene:
models:
stage:
source: asset:assets/models/stage.glb
app:
enabled: true # アプリケーションのシーン
placement: background # background | none
camera:
position: 0, 1.5, -4
target: 0, 1, 0
fov: 45
// エンジンには独自の Component クラスがある: ここで使うものだけを取り込む。
import 'package:flutter_scene/scene.dart' show Scene;
import 'package:spring_boot_starter_flutter_scene/spring_boot_starter_flutter_scene.dart';
@Component()
class Stage implements SceneCustomizer {
Stage(this.models);
final ObjectProvider<SceneModels> models;
@override
Future<void> customize(Scene scene) async {
scene.add((await models.getObject()['stage'].load()).clone());
}
}
モデルは ObjectProvider を通じて受け取ります。spring.flutter.scene.enabled: false ではシーンの Bean が一つも存在しませんが、この Bean は作られる必要があるからです。そのとき customize を呼ぶものはありません。
中に入るもの
すべての SceneCustomizer Bean が、@Order の順に、シーンを一度だけ受け取ります。エンジンが起動した後、シーンが最初に描画される前です。ノードを追加し、シーンのライト、フォグ、アンチエイリアスを設定します。
画面は、エンジンの SceneSubtree でシーンに追加し、去るときに自分の部分を取り除きます。SpringSceneView() の children は、そのビューが表示されている間、シーンに追加されます。
表示される場所
spring.flutter.scene.app.placement |
シーンが表示される場所 |
|---|---|
background (デフォルト) |
アプリのすべての画面の下と、すべての SpringSceneView() |
none |
アプリの SpringSceneView() ウィジェットの中だけ |
background では、画面は独自の不透明な背景を塗ってはいけません。画面の下のシーンは、デバッグタブ で application という名前の SpringSceneView で、FlutterAppCustomizer (applicationSceneBackground) がアプリの内容の下に置きます。ポインターイベントは受け取らず、シーンが描画されない場所では素のウィジェットです。
カメラ
ビューがカメラを与えない場所では、シーンはプロパティのカメラを通して見えます。
| キー | 型 | デフォルト | 意味 |
|---|---|---|---|
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 |
垂直方向の視野角 |
独自のビューは別のカメラを与えます: SpringSceneView(camera: ...) または cameraBuilder:。
Bean
applicationScene (ApplicationScene。ChangeNotifier) は、app.enabled: true のときだけ存在します。
| メンバー | 意味 |
|---|---|
scene |
エンジンの Scene。作られるまでは null。エンジンが起動しなかった場所ではずっと null |
camera |
spring.flutter.scene.app.camera のカメラ |
create() |
シーンを一度だけ作る。どの呼び出しも同じシーンを返す。エンジンが起動しなかったとき、またはカスタマイザーが失敗したときは null |
シーンはスプラッシュとともに作られ、スプラッシュはそれを待ちます (イベントと言葉で表す起動 を参照)。失敗したカスタマイザーは警告としてログに出て、SceneFailedEvent として発行されます。アプリはシーンなしで動き続けます。
コスト
シーンのコストが最も大きいのはここです。すべての画面の下のシーンは、そのフレームごとにページ全体を描画し直します。シーンのコスト を参照してください。
Spring (Java) との対応
Spring Boot は、自分が作るものを同じ方法でカスタマイズします。WebServerFactoryCustomizer Bean は、サーバーが作られる前に Web サーバーのファクトリーを受け取ります。
関連項目
- ウィジェットとしてのシーン
- モデル
- シーンのコスト
- アプリのウィジェット:
FlutterAppCustomizer