From 5c08c929b5d52d0fcc986143b08209fbd093dbde Mon Sep 17 00:00:00 2001 From: Lefteris Notas Date: Fri, 22 May 2026 16:23:20 +0300 Subject: [PATCH] refactor: rename ASS_PlanarCaptureManager to USS_PlanarCaptureManager for consistency; update documentation across multiple files --- docs/architecture/planar-capture-system.md | 2 +- docs/blueprints/17-capture/138_SS_PlanarCaptureManager.md | 2 +- docs/blueprints/INDEX.md | 4 ++-- docs/checklists/cpp-blueprint-status.md | 4 ++-- docs/checklists/remaining-blueprint-build-order.md | 2 +- docs/developer/17-capture-systems.md | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/architecture/planar-capture-system.md b/docs/architecture/planar-capture-system.md index d67b3a9..8a8c623 100644 --- a/docs/architecture/planar-capture-system.md +++ b/docs/architecture/planar-capture-system.md @@ -17,7 +17,7 @@ This document specifies the architecture of the Planar Capture System — a unif │ C++ LAYER (Performance-Critical) │ │ UBPC_PlanarCapture — SceneCapture2D lifecycle, camera math │ │ ABP_PlanarCaptureActor — Surface mesh, MDI, overlap/proximity │ -│ ASS_PlanarCaptureManager — Global budget, RT pool, scoring │ +│ USS_PlanarCaptureManager — Global budget, RT pool, scoring (WorldSubsystem + FTickable) │ │ UPlanarCaptureCameraUtils — Mirror/Portal/Oblique math (static) │ ├─────────────────────────────────────────────────────────────────────────────┤ │ UE5 ENGINE │ diff --git a/docs/blueprints/17-capture/138_SS_PlanarCaptureManager.md b/docs/blueprints/17-capture/138_SS_PlanarCaptureManager.md index 876b271..4a2d046 100644 --- a/docs/blueprints/17-capture/138_SS_PlanarCaptureManager.md +++ b/docs/blueprints/17-capture/138_SS_PlanarCaptureManager.md @@ -11,7 +11,7 @@ Global budget manager for all planar capture surfaces in the world. One instance ## Class Info | Property | Value | |----------|-------| -| **Parent Class** | `WorldSubsystem` (C++ `ASS_PlanarCaptureManager`) | +| **Parent Class** | `WorldSubsystem` (C++ `USS_PlanarCaptureManager`, also implements `FTickableGameObject` for per-frame evaluation) | | **Class Type** | World Subsystem | | **Asset Path** | N/A (auto-created by engine) | | **C++ Header** | `Source/PG_Framework/Public/Capture/SS_PlanarCaptureManager.h` | diff --git a/docs/blueprints/INDEX.md b/docs/blueprints/INDEX.md index ef24814..3fcf185 100644 --- a/docs/blueprints/INDEX.md +++ b/docs/blueprints/INDEX.md @@ -1,6 +1,6 @@ # Master Blueprint Index — UE5 Modular Game Framework -**Version:** 3.3 | **Generated:** 2026-05-21 | **Total Files:** 135 numbered + 1 starter + 1 supplementary (137 total specs) | **C++:** 22 source files +**Version:** 3.4 | **Generated:** 2026-05-22 | **Total Files:** 147 numbered + 1 starter + 1 supplementary (149 total specs) | **C++:** 27 source files (15 full + 10 stubs + 2 utility) This document is the canonical index of every Blueprint specification file in the framework. Each entry links to its full spec document and includes: file name, asset type, parent class, purpose summary, and key dependencies. @@ -326,7 +326,7 @@ Below are the most cross-referenced systems — these are the ones the State Man --- -*Master Blueprint Index v3.1 — The single reference document for every file in the framework. Now 135 files with State Management, MetaSounds Audio, and Multiplayer Networking support.* +*Master Blueprint Index v3.4 — The single reference document for every file in the framework. Now 147 files with State Management, MetaSounds Audio, Multiplayer Networking, and Planar Capture System support.* --- diff --git a/docs/checklists/cpp-blueprint-status.md b/docs/checklists/cpp-blueprint-status.md index 5d4677c..debb3e0 100644 --- a/docs/checklists/cpp-blueprint-status.md +++ b/docs/checklists/cpp-blueprint-status.md @@ -300,7 +300,7 @@ Abbreviations: | 130 | `UBPC_StateManager` | `Public/Player/BPC_StateManager.h` | `Private/Player/BPC_StateManager.cpp` | 246 + cpp | | 136 | `UBPC_PlanarCapture` | `Public/Capture/BPC_PlanarCapture.h` | `Private/Capture/BPC_PlanarCapture.cpp` | 360 + cpp | | 137 | `ABP_PlanarCaptureActor` | `Public/Capture/BP_PlanarCaptureActor.h` | `Private/Capture/BP_PlanarCaptureActor.cpp` | 250 + cpp | -| 138 | `ASS_PlanarCaptureManager` | `Public/Capture/SS_PlanarCaptureManager.h` | `Private/Capture/SS_PlanarCaptureManager.cpp` | 330 + cpp | +| 138 | `USS_PlanarCaptureManager` | `Public/Capture/SS_PlanarCaptureManager.h` | `Private/Capture/SS_PlanarCaptureManager.cpp` | 330 + cpp | ### C++ Stubs (10 systems — UCLASS + basic vars/delegates, need BP child for logic) @@ -323,7 +323,7 @@ Abbreviations: |---|-----------|--------|--------|---------| | 136 | `UBPC_PlanarCapture` | `Public/Capture/BPC_PlanarCapture.h` | `Private/Capture/BPC_PlanarCapture.cpp` | SceneCapture2D lifecycle, camera math, horror features | | 137 | `ABP_PlanarCaptureActor` | `Public/Capture/BP_PlanarCaptureActor.h` | `Private/Capture/BP_PlanarCaptureActor.cpp` | Placeable surface actor with mesh, MDI, proximity trigger | -| 138 | `ASS_PlanarCaptureManager` | `Public/Capture/SS_PlanarCaptureManager.h` | `Private/Capture/SS_PlanarCaptureManager.cpp` | Global budget manager, RT pool, surface scoring | +| 138 | `USS_PlanarCaptureManager` | `Public/Capture/SS_PlanarCaptureManager.h` | `Private/Capture/SS_PlanarCaptureManager.cpp` | Global budget manager, RT pool, surface scoring | ### Capture Utility (Static Library) diff --git a/docs/checklists/remaining-blueprint-build-order.md b/docs/checklists/remaining-blueprint-build-order.md index 46e0351..bbd7ccd 100644 --- a/docs/checklists/remaining-blueprint-build-order.md +++ b/docs/checklists/remaining-blueprint-build-order.md @@ -773,7 +773,7 @@ STEP 22 — Adaptive BPs (89-101) STEP 23 — Meta + Settings + Polish (102-114) STEP 24 — SS_AudioManager + BP_RoomAudioZone (132-133) STEP 25 — All DA_* Data Asset instances (content-populated, per project) -STEP 26 — Phase 17: Planar Capture C++ (136-138) — UBPC_PlanarCapture, ABP_PlanarCaptureActor, ASS_PlanarCaptureManager +STEP 26 — Phase 17: Planar Capture C++ (136-138) — UBPC_PlanarCapture, ABP_PlanarCaptureActor, USS_PlanarCaptureManager STEP 27 — Phase 17b: Materials (144, 145, 147) — M_CaptureSurface_Master, MPC_CaptureSurface, 7 MI_ instances STEP 28 — Phase 17c: Blueprint Actors (139-143) — BP_Mirror, BP_Portal, BP_Monitor, BP_HorrorMirror, BP_FakeWindow STEP 29 — Phase 17d: Data Asset (146) — DA_PlanarCaptureProfile instances diff --git a/docs/developer/17-capture-systems.md b/docs/developer/17-capture-systems.md index b0aa93c..99a5b77 100644 --- a/docs/developer/17-capture-systems.md +++ b/docs/developer/17-capture-systems.md @@ -18,7 +18,7 @@ The Planar Capture System provides a unified rendering pipeline for mirrors, por │ DA_PlanarCaptureProfile → MPC_CaptureSurface → MI_* material instances│ ├──────────────────────────────────────────────────────────────────────┤ │ C++ RUNTIME LAYER │ -│ ASS_PlanarCaptureManager ← Global budget, RT pool, scoring │ +│ USS_PlanarCaptureManager ← Global budget, RT pool, scoring (WorldSubsystem + FTickable) │ │ ABP_PlanarCaptureActor ← Surface mesh, MDI, registration │ │ UBPC_PlanarCapture ← SceneCapture2D, camera math, horror │ │ UPlanarCaptureCameraUtils ← Static math: mirror, portal, oblique │