feat(M01): add explicit streaming focus

Work-Package: M01-RND-STREAMING-FOCUS-001

Agent: sindo-main-codex
This commit is contained in:
2026-07-13 15:41:16 +04:00
parent fbef131bcb
commit 7815385b3b
12 changed files with 253 additions and 61 deletions
+17
View File
@@ -0,0 +1,17 @@
class_name StreamingFocus
extends RefCounted
## Immutable world-streaming point independent of cameras and the scene tree.
## Renderer adapters may obtain this position from a player, spectator, editor
## viewport or capture tool, but streaming consumers receive only this value.
var world_position: GodotWorldPosition:
get:
return _world_position
var _world_position: GodotWorldPosition
## Creates a focus at an explicit position in the Godot renderer basis.
func _init(world_position_value: GodotWorldPosition) -> void:
_world_position = world_position_value
@@ -0,0 +1 @@
uid://ehv78jvge0q2
@@ -53,6 +53,7 @@ fog_depth_end = 5200.0
[node name="StreamingWorld" type="Node3D" unique_id=1063159974]
script = ExtResource("1_stream")
streaming_focus_source_path = NodePath("ThirdPersonPlayer")
camera_path = NodePath("ThirdPersonPlayer/CameraPivot/Camera3D")
quality_preset = "High"
update_interval = 0.1
@@ -54,6 +54,7 @@ fog_depth_end = 5200.0
[node name="StreamingWorld" type="Node3D" unique_id=1063159974]
script = ExtResource("1_sisqv")
map_name = "Kalimdor"
streaming_focus_source_path = NodePath("ThirdPersonPlayer")
camera_path = NodePath("ThirdPersonPlayer/CameraPivot/Camera3D")
quality_preset = "High"
update_interval = 0.1
+66 -38
View File
@@ -1,5 +1,5 @@
@tool
## Streams Azeroth terrain around the active camera with chunk-based LODs.
## Streams Azeroth terrain around an explicit [StreamingFocus] with chunk-based LODs.
extends Node3D
const ADT_BUILDER_SCRIPT := preload("res://addons/mpq_extractor/loaders/adt_builder.gd")
@@ -12,6 +12,8 @@ const WMO_BUILDER_SCRIPT := preload("res://addons/mpq_extractor/loaders/wmo_buil
const M2_BUILDER_SCRIPT := preload("res://addons/mpq_extractor/loaders/m2_builder.gd")
const M2_NATIVE_ANIMATED_BUILDER_SCRIPT := preload("res://addons/mpq_extractor/loaders/m2_native_animated_builder.gd")
const M2_NATIVE_ANIMATOR_SCRIPT := preload("res://src/scenes/streaming/m2_native_animator.gd")
const STREAMING_FOCUS_SCRIPT := preload("res://src/domain/streaming/streaming_focus.gd")
const GODOT_WORLD_POSITION_SCRIPT := preload("res://src/domain/coordinates/godot_world_position.gd")
const REQUIRED_BAKED_TILE_FORMAT_VERSION := 5
const REQUIRED_SPLAT_TILE_FORMAT_VERSION := 1
const REQUIRED_CONTROL_SPLAT_TILE_FORMAT_VERSION := 3
@@ -29,6 +31,9 @@ const QUALITY_HIGH := "High"
@export var extracted_dir: String = "res://data/extracted"
@export var map_name: String = "Azeroth"
## Optional scene adapter source. Any Node3D may provide the runtime focus.
@export var streaming_focus_source_path: NodePath
## Camera used only by the optional automatic overview positioning feature.
@export var camera_path: NodePath
@export_enum("Custom", "Performance", "Balanced", "High") var quality_preset: String = QUALITY_CUSTOM
@@ -213,6 +218,8 @@ var _tile_min := Vector2i(63, 63)
var _tile_max := Vector2i(0, 0)
var _camera_initialized := false
var _editor_signature := ""
var _streaming_focus: StreamingFocus
var _missing_focus_source_reported := false
var _last_focus_pos := Vector3.ZERO
var _dbg_chunks_created := 0
var _dbg_chunks_null := 0
@@ -293,6 +300,8 @@ func _ready() -> void:
_tick_editor_streaming()
elif auto_position_camera:
_position_camera_over_world()
if not Engine.is_editor_hint():
_capture_streaming_focus_from_source()
set_process(true)
call_deferred("_refresh_streaming_targets_after_ready")
@@ -364,7 +373,7 @@ func _process(delta: float) -> void:
if Engine.is_editor_hint():
_tick_editor_streaming()
else:
_refresh_streaming_targets(false)
refresh_streaming_focus(false)
did_refresh = true
_profile_section(timings, "refresh", section_start, profile_enabled)
_log_hitch_profile(profile_start, timings, did_refresh, profile_enabled)
@@ -590,10 +599,11 @@ func _tick_editor_streaming() -> void:
var focus_world := _tile_center_to_world(editor_preview_center_x, editor_preview_center_y)
if editor_follow_view_camera:
var editor_camera := _get_stream_camera()
var editor_camera := _get_editor_view_camera()
if editor_camera:
focus_world += editor_camera.global_position
_refresh_editor_streaming_targets_at(focus_world, false)
_set_streaming_focus_from_vector3(focus_world)
_refresh_editor_streaming_targets_at(_streaming_focus_to_vector3(), false)
func _scan_available_tiles() -> void:
@@ -681,24 +691,28 @@ func _load_tiles_from_directory() -> void:
_tile_max.y = max(_tile_max.y, ty)
func _refresh_streaming_targets(force: bool) -> void:
var camera := _get_stream_camera()
if camera == null:
return
## Replaces the current streaming point without requiring a Node or Camera3D.
func set_streaming_focus(streaming_focus: StreamingFocus) -> void:
_streaming_focus = streaming_focus
## Samples the configured scene source, then refreshes streaming from the typed focus.
## Returns false when no valid focus is available; existing streamed content is retained.
func refresh_streaming_focus(force: bool = false) -> bool:
_capture_streaming_focus_from_source()
if _streaming_focus == null or _streaming_focus.world_position == null:
return false
_terrain_root.position = Vector3.ZERO
_refresh_streaming_targets_at(camera.global_position, force)
_refresh_streaming_targets_at(_streaming_focus_to_vector3(), force)
return true
func _refresh_streaming_targets_after_ready() -> void:
var camera := _get_stream_camera()
if camera == null:
return
_terrain_root.position = Vector3.ZERO
_has_refresh_focus = false
_refresh_streaming_targets_at(camera.global_position, false)
refresh_streaming_focus(false)
## Core streaming update — works for both game (camera pos) and editor (preview center pos).
## Core streaming update for runtime and editor focus positions.
func _refresh_editor_streaming_targets_at(focus_pos: Vector3, force: bool) -> void:
if not force and not _should_refresh_focus(focus_pos):
return
@@ -3048,32 +3062,46 @@ func _is_tile_queued(key: String) -> bool:
return false
func _get_stream_camera() -> Camera3D:
if Engine.is_editor_hint():
# The 3D editor viewport camera lives in EditorInterface, not get_viewport().
# get_viewport().get_camera_3d() from a @tool script returns whichever Camera3D
# belongs to the edited scene (often null), so editor-view movement is invisible
# unless we reach into EditorInterface.
var vp := EditorInterface.get_editor_viewport_3d(0)
if vp != null:
var cam := vp.get_camera_3d()
if cam:
return cam
func _capture_streaming_focus_from_source() -> void:
if streaming_focus_source_path == NodePath():
return
var focus_source := get_node_or_null(streaming_focus_source_path) as Node3D
if focus_source == null:
if not _missing_focus_source_reported:
push_warning("Streaming focus source is missing or is not Node3D: %s" % streaming_focus_source_path)
_missing_focus_source_reported = true
return
_missing_focus_source_reported = false
_set_streaming_focus_from_vector3(focus_source.global_position)
if camera_path != NodePath():
var from_path := get_node_or_null(camera_path)
if from_path is Camera3D:
return from_path
var viewport_camera := get_viewport().get_camera_3d()
if viewport_camera:
return viewport_camera
func _set_streaming_focus_from_vector3(world_position: Vector3) -> void:
var typed_world_position = GODOT_WORLD_POSITION_SCRIPT.new(
world_position.x,
world_position.y,
world_position.z
)
set_streaming_focus(STREAMING_FOCUS_SCRIPT.new(typed_world_position))
for child in get_children():
if child is Camera3D and child.current:
return child
return null
func _streaming_focus_to_vector3() -> Vector3:
var world_position: GodotWorldPosition = _streaming_focus.world_position
return Vector3(world_position.x_units, world_position.y_units, world_position.z_units)
func _get_editor_view_camera() -> Camera3D:
# EditorInterface owns this camera. This method is the explicit editor adapter;
# runtime streaming never discovers a viewport camera.
var editor_viewport := EditorInterface.get_editor_viewport_3d(0)
if editor_viewport == null:
return null
return editor_viewport.get_camera_3d()
func _get_auto_position_camera() -> Camera3D:
if camera_path == NodePath():
return null
return get_node_or_null(camera_path) as Camera3D
func _can_use_baked_tile_cache() -> bool:
@@ -5365,7 +5393,7 @@ func _position_camera_over_world() -> void:
if _camera_initialized:
return
var camera := _get_stream_camera()
var camera := _get_auto_position_camera()
if camera == null:
return
+3 -3
View File
@@ -64,7 +64,7 @@ func _capture_async() -> void:
camera.far = 50000.0
camera.position = _vector3(first.get("camera", [0.0, 0.0, 0.0]))
(world as Node3D).add_child(camera)
world.set("camera_path", NodePath("CheckpointCamera"))
world.set("streaming_focus_source_path", NodePath("CheckpointCamera"))
world.set("debug_streaming", true)
world.set("runtime_stats_enabled", true)
get_root().add_child(world)
@@ -126,8 +126,8 @@ func _capture_async() -> void:
if player != null:
player.global_position = _vector3(checkpoint.get("player", checkpoint.get("target", [0.0, 0.0, 0.0])))
_set_sky_time(world, float(checkpoint.get("time_hours", 13.0)))
if world.has_method("_refresh_streaming_targets_at"):
world.call("_refresh_streaming_targets_at", camera.global_position, true)
if world.has_method("refresh_streaming_focus"):
world.call("refresh_streaming_focus", true)
if dry_run:
print("RENDER_CHECKPOINT dry_run name=%s coverage=%s camera=%s target=%s yaw_offset=%.2f pitch_offset=%.2f time=%.2f" % [
+3 -3
View File
@@ -28,7 +28,7 @@ func _run_async() -> void:
camera.name = "OccluderProbeCamera"
camera.current = true
world.add_child(camera)
world.set("camera_path", NodePath(camera.name))
world.set("streaming_focus_source_path", NodePath(camera.name))
world.set("debug_streaming", false)
get_root().add_child(world)
await process_frame
@@ -47,8 +47,8 @@ func _run_async() -> void:
var camera_position := _vector3(checkpoint.get("camera", []))
var target_position := _vector3(checkpoint.get("target", []))
camera.global_position = camera_position
if world.has_method("_refresh_streaming_targets_at"):
world.call("_refresh_streaming_targets_at", camera_position, true)
if world.has_method("refresh_streaming_focus"):
world.call("refresh_streaming_focus", true)
await create_timer(maxf(0.1, wait_seconds)).timeout
var geometry_nodes: Array[Node3D] = []
_collect_geometry_nodes(world, geometry_nodes)
+3 -3
View File
@@ -36,7 +36,7 @@ func _run_async() -> void:
var camera := Camera3D.new()
camera.current = true
world.add_child(camera)
world.set("camera_path", NodePath(camera.name))
world.set("streaming_focus_source_path", NodePath(camera.name))
world.set("debug_streaming", false)
get_root().add_child(world)
await process_frame
@@ -53,8 +53,8 @@ func _run_async() -> void:
continue
var camera_position := _vector3(checkpoint.get("camera", []))
camera.global_position = camera_position
if world.has_method("_refresh_streaming_targets_at"):
world.call("_refresh_streaming_targets_at", camera_position, true)
if world.has_method("refresh_streaming_focus"):
world.call("refresh_streaming_focus", true)
await create_timer(maxf(0.1, wait_seconds)).timeout
var terrain_sample := _sample_terrain(world, camera_position)
terrain_sample["name"] = checkpoint.get("name", "checkpoint")
+101
View File
@@ -0,0 +1,101 @@
extends SceneTree
## Headless M01 contract and wiring regression for camera-independent streaming.
const StreamingFocusScript = preload("res://src/domain/streaming/streaming_focus.gd")
const GodotWorldPositionScript = preload("res://src/domain/coordinates/godot_world_position.gd")
const LOADER_PATH := "res://src/scenes/streaming/streaming_world_loader.gd"
const RUNTIME_SCENE_PATHS: Array[String] = [
"res://src/scenes/streaming/eastern_kingdoms_streaming.tscn",
"res://src/scenes/streaming/kalimdor_streaming.tscn",
]
const CAPTURE_TOOL_PATHS: Array[String] = [
"res://src/tools/capture_render_checkpoints.gd",
"res://src/tools/probe_render_camera_occluders.gd",
"res://src/tools/probe_render_terrain_height.gd",
]
func _initialize() -> void:
var failures: Array[String] = []
_verify_scene_free_focus_value(failures)
_verify_loader_boundary(failures)
_verify_runtime_scene_wiring(failures)
_verify_capture_tool_wiring(failures)
if not failures.is_empty():
for failure in failures:
push_error("STREAMING_FOCUS: %s" % failure)
quit(1)
return
print("STREAMING_FOCUS PASS contract=1 runtime_scenes=2 capture_tools=3")
quit(0)
func _verify_scene_free_focus_value(failures: Array[String]) -> void:
var position = GodotWorldPositionScript.new(17199.159666667, 83.5312, 26016.616666667)
var focus = StreamingFocusScript.new(position)
_expect_true(focus.world_position == position, "focus retains typed position", failures)
_expect_near(focus.world_position.x_units, 17199.159666667, "focus X", failures)
_expect_near(focus.world_position.y_units, 83.5312, "focus Y", failures)
_expect_near(focus.world_position.z_units, 26016.616666667, "focus Z", failures)
var focus_source := _read_text("res://src/domain/streaming/streaming_focus.gd", failures)
_expect_true(not focus_source.contains("extends Node"), "focus does not inherit Node", failures)
_expect_true(not focus_source.contains("extends Resource"), "focus does not inherit Resource", failures)
_expect_true(not focus_source.contains("Vector3"), "focus does not expose Vector3", failures)
func _verify_loader_boundary(failures: Array[String]) -> void:
var loader_source := _read_text(LOADER_PATH, failures)
for required_text in [
"@export var streaming_focus_source_path: NodePath",
"func set_streaming_focus(streaming_focus: StreamingFocus) -> void:",
"func refresh_streaming_focus(force: bool = false) -> bool:",
]:
_expect_true(loader_source.contains(required_text), "loader contains %s" % required_text, failures)
for forbidden_text in [
"get_viewport().get_camera_3d()",
"child is Camera3D and child.current",
"func _get_stream_camera()",
]:
_expect_true(not loader_source.contains(forbidden_text), "loader omits %s" % forbidden_text, failures)
func _verify_runtime_scene_wiring(failures: Array[String]) -> void:
for scene_path in RUNTIME_SCENE_PATHS:
var scene_source := _read_text(scene_path, failures)
_expect_true(
scene_source.contains('streaming_focus_source_path = NodePath("ThirdPersonPlayer")'),
"%s uses player focus" % scene_path,
failures
)
func _verify_capture_tool_wiring(failures: Array[String]) -> void:
for tool_path in CAPTURE_TOOL_PATHS:
var tool_source := _read_text(tool_path, failures)
_expect_true(tool_source.contains('world.set("streaming_focus_source_path"'), "%s sets explicit focus source" % tool_path, failures)
_expect_true(tool_source.contains('world.call("refresh_streaming_focus", true)'), "%s uses public refresh" % tool_path, failures)
_expect_true(not tool_source.contains('world.call("_refresh_streaming_targets_at"'), "%s avoids private refresh" % tool_path, failures)
func _read_text(path: String, failures: Array[String]) -> String:
var file := FileAccess.open(path, FileAccess.READ)
if file == null:
failures.append("cannot open %s" % path)
return ""
return file.get_as_text()
func _expect_near(actual_value: float, expected_value: float, label: String, failures: Array[String]) -> void:
if absf(actual_value - expected_value) > 0.000001:
failures.append("%s expected %.9f, got %.9f" % [label, expected_value, actual_value])
func _expect_true(actual_value: bool, label: String, failures: Array[String]) -> void:
if not actual_value:
failures.append("%s expected true" % label)
+1
View File
@@ -0,0 +1 @@
uid://b7ayw5a0bn1lq