feat(weather-editor): add free camera and play mode

[Dlizzio]

Adds 2 new buttons to weather editor:

Free camera: Initiates free camera without having to leave the editor, camera speed adjustable by scroll wheel.
Play mode: Allows normal gameplay through viewport.

Both modes exit through set weather editor toggle.

Also adjusted how buttons in the top bar are drawn so the new buttons are implemented properly.

Included two new icons that are free for commercial or personal use without attribution:
https://www.iconpacks.net/free-icon/eye-12109.html
https://uxwing.com/steps-icon/

Summary by CodeRabbit

• New Features

  • Added preview modes: Free Camera (with lock) and Play Mode, toolbar toggle icons, theme-aware icon tinting, and a transparent icon button style.
  • UI: redesigned main menu bar layout, icon-only controls, preview status display, and fly-speed display; scroll-wheel now adjusts Free Camera speed.

• Bug Fixes

  • ESC exits preview mode without closing other UI.
  • Cursor, tooltip, and input handling refined so movement/camera controls work correctly during flying preview.

• Chores

  • Improved icon loading and fallback logging; additional preview icons added.

[coderabbitai]

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

• ▶️ Resume reviews
• 🔍 Trigger review

📝 Walkthrough

Walkthrough

Adds a preview-mode system to the Weather Editor (FreeCamera, FreeCameraLocked, PlayMode), updates menu input/cursor behavior to be preview-aware, introduces preview controls and icons, refactors icon loading/fallback logic, and prevents menu input-swallowing while flying.

Changes

Cohort / File(s)	Summary
Preview Mode Core src/WeatherEditor/EditorWindow.h, src/WeatherEditor/EditorWindow.cpp	Add PreviewMode enum and preview state (previewMode, flySpeed, savedMousePos); implement EnterPreviewMode, ExitPreviewMode, ToggleFreeCameraLock, AdjustFlySpeed, IsPreviewFlying; refactor main-menu-bar UI to absolute positioning and add preview toggle icon buttons.
Menu Input & API src/Menu.h, src/Menu.cpp	Make input handling preview-aware (wheel adjusts fly speed in FreeCamera, ESC exits preview, WeatherEditor hotkey routes based on preview state); add Menu::IsPreviewFlying() and new uiIcons.freeCamera / uiIcons.playMode; destructor releases added icon textures.
Icon Loading src/Menu/IconLoader.cpp	Add free-camera.png and play-mode.png icon defs wired to new UI icons; replace hardcoded texture-release loop with data-driven release; simplify monochrome fallback path derivation and improve fallback failure logging; explicitly release search texture.
Overlay & Cursor Behavior src/Menu/OverlayRenderer.cpp	When editor closes due to invalid parentCell, also exit preview; make ImGui cursor visibility and mouse position respect preview flying (hide cursor and force invalid mouse pos while flying).
Input Hooking src/Hooks.cpp	Update BSInputDeviceManager_PollInputDevices::thunk to avoid swallowing input when Menu::IsPreviewFlying() is true, calling original dispatcher so movement/camera input reaches the game during flying preview.
UI Helpers src/Utils/UI.h, src/Utils/UI.cpp	Add TransparentIconButtonStyle() and GetIconTint() helpers for theme-aware transparent icon buttons and icon tint selection.

Sequence Diagram

sequenceDiagram
    participant User as User
    participant Menu as Menu
    participant Editor as EditorWindow
    participant ImGui as ImGui
    participant Hook as BSInputHook

    User->>Menu: Press WeatherEditorToggleKey
    alt Editor.IsInPreviewMode()
        Menu->>Editor: ExitPreviewMode()
        Editor->>ImGui: Restore mouse pos, set MouseDrawCursor = true
        Editor-->>Menu: previewMode = None
    else
        Menu->>Editor: Open or EnterPreviewMode(...)
        Editor-->>Menu: previewMode = FreeCamera / PlayMode
    end

    User->>Menu: Middle-wheel scroll
    alt Editor.GetPreviewMode() == FreeCamera
        Menu->>Editor: AdjustFlySpeed(scrollDelta)
        Editor->>Editor: Update flySpeed, clamp, apply
    else
        Menu->>ImGui: Forward mouse wheel
    end

    Note over Hook,Menu: Input polling hook behavior
    alt Menu::IsPreviewFlying() == true
        Hook->>Hook: Call original dispatcher (do not swallow)
    else
        Hook->>Hook: Swallow input events
    end

    User->>Menu: Press ESC (Preview active)
    Menu->>Editor: ExitPreviewMode()
    Editor->>ImGui: Restore mouse pos, set MouseDrawCursor = true

Loading

Estimated Code Review Effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Possibly Related PRs

• feat(weather editor): toggle hotkey #1856 — modifies WeatherEditor toggle hotkey and routing, closely related to new hotkey/preview routing changes.
• feat(ui): add Icon Support #1107 — touches Menu icon subsystem and uiIcons handling; relates to added preview icons and destructor texture release.
• fix(VR): disable hmd menu for incompatible openvr #1309 — alters input-polling hook behavior; relevant to the hook changes that skip swallowing while flying.

Suggested Reviewers

• davo0411
• jiayev
• alandtse

Poem

🐰
I hopped into code with whiskers aglow,
Toggled free flight where the soft breezes blow,
Scrolls tweak the speed as the clouds dance by,
Tiny icons wink — a carrot-sky high,
Weather and rabbits rejoice with a sigh.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 13.04% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'feat(weather-editor): add free camera and play mode' directly and accurately summarizes the main changes—two new preview modes added to the weather editor with corresponding UI buttons.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

No actionable suggestions for changed features.

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

src/WeatherEditor/EditorWindow.cpp (1)

1119-1119: Format specifier mismatch for size_t.

undoStack.size() returns size_t, but %d expects int. On 64-bit systems this could truncate or misinterpret the value. The cast (int)undoStack.size() works here since stack size is bounded by maxUndoStates, but consider using %zu or keeping the explicit cast for clarity.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@src/WeatherEditor/EditorWindow.cpp` at line 1119, ImGui::SetTooltip is using
"%d" while passing undoStack.size() (a size_t); change the format to match the
type (use "%zu") or explicitly cast the value to an int (e.g.,
(int)undoStack.size()) to avoid truncation on 64-bit systems—update the call to
ImGui::SetTooltip referencing undoStack.size() (or maxUndoStates if you prefer
bounded size) so the format specifier and argument type match.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/Menu.cpp`:
- Around line 1171-1172: Do not change the semantics of ShouldSwallowInput():
remove the early return that uses editorWindow->IsInPreviewMode() so
ShouldSwallowInput() keeps its original meaning; instead add a separate
predicate (e.g., IsPreviewPassThrough() or Menu::IsInPreviewModePassThrough())
that returns editorWindow && editorWindow->IsInPreviewMode(), and update the
consumers that need preview pass-through behavior (Hooks.cpp input forwarding,
ProcessInputEventQueue(), and any callers like
LightEditor::GatherLights()/weather popup) to consult that new predicate rather
than ShouldSwallowInput().

In `@src/Menu/IconLoader.cpp`:
- Around line 108-109: The new icon entries for freeCamera and playMode are
being loaded but never released, causing leaks when pendingIconReload or theme
switches overwrite their ID3D11ShaderResourceView* pointers; update the resource
cleanup to release them by adding releases for menu->uiIcons.freeCamera.texture
and menu->uiIcons.playMode.texture in the same cleanup loops used by
InitializeMenuIcons() and Menu::~Menu() (or centralize in the existing
icon-release helper used for other uiIcons) and ensure their sizes
(menu->uiIcons.freeCamera.size, menu->uiIcons.playMode.size) are reset/zeroed
after release so future reloads won't double-free or skip recreation.

---

Nitpick comments:
In `@src/WeatherEditor/EditorWindow.cpp`:
- Line 1119: ImGui::SetTooltip is using "%d" while passing undoStack.size() (a
size_t); change the format to match the type (use "%zu") or explicitly cast the
value to an int (e.g., (int)undoStack.size()) to avoid truncation on 64-bit
systems—update the call to ImGui::SetTooltip referencing undoStack.size() (or
maxUndoStates if you prefer bounded size) so the format specifier and argument
type match.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 04a1de42-8032-4061-b681-cd6e20a08201

📥 Commits

Reviewing files that changed from the base of the PR and between 3616a17 and 095e119.

⛔ Files ignored due to path filters (4)

• package/Interface/CommunityShaders/Icons/Action Icons/free-camera.png is excluded by !**/*.png
• package/Interface/CommunityShaders/Icons/Action Icons/pause.png is excluded by !**/*.png
• package/Interface/CommunityShaders/Icons/Action Icons/play-mode.png is excluded by !**/*.png
• package/Interface/CommunityShaders/Icons/Action Icons/undo.png is excluded by !**/*.png

📒 Files selected for processing (8)

• src/Menu.cpp
• src/Menu.h
• src/Menu/IconLoader.cpp
• src/Menu/OverlayRenderer.cpp
• src/Utils/UI.cpp
• src/Utils/UI.h
• src/WeatherEditor/EditorWindow.cpp
• src/WeatherEditor/EditorWindow.h

[github-actions]

✅ A pre-release build is available for this PR:
Download

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

src/WeatherEditor/EditorWindow.cpp (1)

1966-1969: Consider initializing flySpeed from saved settings.

flySpeed is reset to kDefaultFlySpeed every time free camera mode is entered. Users might prefer their last-used speed to persist across sessions or at least within the same editor session.

This is a minor UX consideration and can be addressed in a follow-up if desired.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@src/WeatherEditor/EditorWindow.cpp` around lines 1966 - 1969, Currently
flySpeed is unconditionally set to kDefaultFlySpeed when free camera mode is
entered; instead, read and use the persisted or session value (e.g., a settings
field like savedFlySpeed or a member variable that tracks lastFlySpeed) before
issuing the console commands. Modify the block that sets flySpeed (the flySpeed
variable assignment and subsequent RE::Console::ExecuteCommand calls) to
initialize flySpeed from your settings storage or a cached member (fallback to
kDefaultFlySpeed only if no saved value exists), then use that value in
std::format("sucsm {:.0f}", flySpeed) so the user's last-used speed persists.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/Menu/IconLoader.cpp`:
- Around line 199-210: The Menu destructor currently releases icons manually but
misses the new uiIcons.freeCamera and uiIcons.playMode, causing a leak; update
Menu::~Menu() to also call Release() and null the pointers (following the
existing pattern used for uiIcons.search) for uiIcons.freeCamera and
uiIcons.playMode so the manual cleanup matches the icons handled by iconDefs and
prevents leaked textures.

---

Nitpick comments:
In `@src/WeatherEditor/EditorWindow.cpp`:
- Around line 1966-1969: Currently flySpeed is unconditionally set to
kDefaultFlySpeed when free camera mode is entered; instead, read and use the
persisted or session value (e.g., a settings field like savedFlySpeed or a
member variable that tracks lastFlySpeed) before issuing the console commands.
Modify the block that sets flySpeed (the flySpeed variable assignment and
subsequent RE::Console::ExecuteCommand calls) to initialize flySpeed from your
settings storage or a cached member (fallback to kDefaultFlySpeed only if no
saved value exists), then use that value in std::format("sucsm {:.0f}",
flySpeed) so the user's last-used speed persists.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 4a57b3c0-15d8-430d-b068-91bccbcf1c45

📥 Commits

Reviewing files that changed from the base of the PR and between 095e119 and 0bc6d69.

📒 Files selected for processing (7)

• src/Hooks.cpp
• src/Menu.cpp
• src/Menu.h
• src/Menu/IconLoader.cpp
• src/Menu/OverlayRenderer.cpp
• src/WeatherEditor/EditorWindow.cpp
• src/WeatherEditor/EditorWindow.h

✅ Files skipped from review due to trivial changes (1)

• src/Menu/OverlayRenderer.cpp

🚧 Files skipped from review as they are similar to previous changes (2)

• src/WeatherEditor/EditorWindow.h
• src/Menu.cpp

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/Menu.cpp`:
- Around line 957-963: The current branch forwards wheel events to ImGui via
io.AddMouseWheelEvent whenever the preview is not FreeCamera, which lets
PreviewMode::PlayMode (and pass-through) scroll editor widgets; update the
condition so AddMouseWheelEvent is only called when there is no EditorWindow or
when ew->previewMode is neither EditorWindow::PreviewMode::PlayMode nor
EditorWindow::PreviewMode::PassThrough. Locate the block handling event.keyCode
> 7 around the EditorWindow pointer ew and change the logic: if ew exists handle
FreeCamera with AdjustFlySpeed, else only call io.AddMouseWheelEvent when ew is
null or ew->previewMode is not PlayMode and not PassThrough.
- Around line 1055-1068: The hotkey handler dereferences
EditorWindow::GetSingleton() into ew without checking for null, causing a crash
if the singleton isn't created; update the lambda for
settings.WeatherEditorToggleKey to first call auto* ew =
EditorWindow::GetSingleton() and proceed only if ew is non-null (guard all
subsequent uses: ew->GetPreviewMode(), ew->IsInPreviewMode(),
ew->ToggleFreeCameraLock(), ew->ExitPreviewMode(), and ew->open); leave the
RE::PlayerCharacter::GetSingleton() check as-is and only toggle ew->open when
both ew and the player/parentCell exist.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 30ad4b6b-d171-4b83-8ab3-1da73dc2546a

📥 Commits

Reviewing files that changed from the base of the PR and between 0bc6d69 and 6e7bcee.

📒 Files selected for processing (1)

• src/Menu.cpp

[alandtse]

Where do the new icons come from? What's their license?

[Dlizzio]

Where do the new icons come from? What's their license?

They are linked in the description

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/WeatherEditor/EditorWindow.cpp`:
- Line 1121: The tooltip call uses "%d" for undoStack.size() which is size_t;
change the format specifier to "%zu" in the ImGui::SetTooltip call and remove
the (int) cast (or replace it with static_cast<size_t>(undoStack.size())) so the
value is printed with the correct type; update the call to
ImGui::SetTooltip(...) referencing undoStack.size() accordingly.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: a915c4dc-358e-46dd-a214-393ecb1a037d

📥 Commits

Reviewing files that changed from the base of the PR and between a20ba38 and b466943.

📒 Files selected for processing (1)

• src/WeatherEditor/EditorWindow.cpp