Add configurable water surface grid size

Enables users to define the water surface visualization grid dimensions and center the grids position (via the SetWaterGridExtent() API). Handy for adjusting the visible water area to match the simulation domain.

Default to 100m x 100m centered at origin if not specified.

Author: dav-og

include/hydroc/gui/guihelper.h

@@ -48,6 +48,19 @@ class UI {
      */
     virtual void SetWaveModel(std::shared_ptr<WaveBase> wave);
 
+    /**@brief Set the water grid extent for visualization.
+     *
+     * Configures the dimensions and position of the water surface mesh.
+     * Call after Init() and before SetWaveModel().
+     *
+     * @param width Grid extent in X direction [m] (default: 100m)
+     * @param length Grid extent in Y direction [m] (default: 100m)
+     * @param center_x Grid center X coordinate [m] (default: 0)
+     * @param center_y Grid center Y coordinate [m] (default: 0)
+     */
+    virtual void SetWaterGridExtent(double width, double length,
+                                    double center_x = 0.0, double center_y = 0.0);
+
     /**@brief return the internal system.
      *
      * Should be called after init.
@@ -75,6 +88,8 @@ class GUI : public UI {
     void SetCamera(double x, double y, double z, double dirx, double diry, double dirz) override;
     bool IsRunning(double timestep) override;
     void SetWaveModel(std::shared_ptr<WaveBase> wave) override;
+    void SetWaterGridExtent(double width, double length,
+                            double center_x = 0.0, double center_y = 0.0) override;
 
   private:
     std::shared_ptr<hydroc::gui::GUIImpl> pImpl;

src/gui/guihelper.cpp

@@ -29,9 +29,13 @@ bool UI::IsRunning(double timestep) {
     return true;
 }
 
-void UI::SetWaveModel(std::shared_ptr<WaveBase> wave) {
+void UI::SetWaveModel(std::shared_ptr<WaveBase> /*wave*/) {
     // Default (headless) UI does not render waves.
-    (void)wave;
+}
+
+void UI::SetWaterGridExtent(double /*width*/, double /*length*/,
+                            double /*center_x*/, double /*center_y*/) {
+    // Default (headless) UI does not render water surface.
 }
 
 // -----------------------------------------------------------------------------
@@ -64,3 +68,7 @@ bool GUI::IsRunning(double timestep) {
 void GUI::SetWaveModel(std::shared_ptr<WaveBase> wave) {
     pImpl->SetWaveModel(wave);
 }
+
+void GUI::SetWaterGridExtent(double width, double length, double center_x, double center_y) {
+    pImpl->SetWaterGridExtent(width, length, center_x, center_y);
+}

src/gui/guihelperVSG.cpp

@@ -114,6 +114,21 @@ void GUIImplVSG::SetWaveModel(std::shared_ptr<WaveBase> wave) {
     // Water surface will be created/updated on first render via EnsureWaterSurface().
 }
 
+void GUIImplVSG::SetWaterGridExtent(double width, double length, double center_x, double center_y) {
+    if (!viewer_settings_) {
+        return;
+    }
+
+    viewer_settings_->grid_width = width;
+    viewer_settings_->grid_length = length;
+    viewer_settings_->grid_center_x = center_x;
+    viewer_settings_->grid_center_y = center_y;
+    viewer_settings_->grid_extent_changed = true;
+
+    std::cout << "[WaterSurface] Grid extent: " << width << " x " << length << " m"
+              << ", center: (" << center_x << ", " << center_y << ")" << std::endl;
+}
+
 void GUIImplVSG::EnsureWaterSurface() {
     // Require both system and visual system to be valid.
     if (!system_ || !pVis) {
@@ -141,7 +156,7 @@ void GUIImplVSG::EnsureWaterSurface() {
     // Always create animated water surface (supports waves + radiation viz).
     // Static plane fallback removed - animated water handles all cases.
     int resolution = (viewer_settings_) ? viewer_settings_->grid_resolution : 0;
-    animated_water_->Initialize(pVis.get(), resolution);
+    animated_water_->Initialize(pVis.get(), resolution, viewer_settings_.get());
 
     if (animated_water_->IsInitialized()) {
         std::cout << "[WaterSurface] wave_ptr=" << (wave_model_ ? "ok" : "null");
@@ -173,10 +188,12 @@ bool GUIImplVSG::IsRunning(double timestep) {
         // Handle visibility toggle.
         animated_water_->SetVisible(viewer_settings_->show_water);
 
-        // Handle resolution change (requires mesh rebuild).
-        if (viewer_settings_->resolution_changed && animated_water_->IsInitialized()) {
-            animated_water_->Reinitialize(viewer_settings_->grid_resolution);
+        // Handle resolution or extent change (requires mesh rebuild).
+        if ((viewer_settings_->resolution_changed || viewer_settings_->grid_extent_changed) &&
+            animated_water_->IsInitialized()) {
+            animated_water_->Reinitialize(viewer_settings_->grid_resolution, viewer_settings_.get());
             viewer_settings_->resolution_changed = false;
+            viewer_settings_->grid_extent_changed = false;
         }
     }
 

src/gui/guihelper_impl.h

@@ -42,9 +42,12 @@ class GUIImpl {
         hydroc::cli::LogWarning(
             "Warning: GUI deactivated. HydroChrono was built without run-time visualization support.");
     }
-    virtual void SetCamera(double x, double y, double z, double dirx, double diry, double dirz) {}
-    virtual bool IsRunning(double timestep) { return true; }
-    virtual void SetWaveModel(std::shared_ptr<WaveBase> wave) { (void)wave; }
+    virtual void SetCamera(double /*x*/, double /*y*/, double /*z*/,
+                           double /*dirx*/, double /*diry*/, double /*dirz*/) {}
+    virtual bool IsRunning(double /*timestep*/) { return true; }
+    virtual void SetWaveModel(std::shared_ptr<WaveBase> /*wave*/) {}
+    virtual void SetWaterGridExtent(double /*width*/, double /*length*/,
+                                     double /*center_x*/, double /*center_y*/) {}
 };
 
 #ifdef HYDROCHRONO_HAVE_IRRLICHT
@@ -82,6 +85,7 @@ class GUIImplVSG : public GUIImpl {
     virtual void SetCamera(double x, double y, double z, double dirx, double diry, double dirz) override;
     virtual bool IsRunning(double timestep) override;
     virtual void SetWaveModel(std::shared_ptr<WaveBase> wave) override;
+    virtual void SetWaterGridExtent(double width, double length, double center_x, double center_y) override;
 
   private:
     /// Ensure water surface is created (animated if wave model set, static otherwise).

src/gui/vsg_gui_component.cpp

@@ -12,7 +12,7 @@ HydroChronoGuiComponent::HydroChronoGuiComponent(chrono::vsg3d::ChVisualSystemVS
                                                  ViewerSettings* settings)
     : vsys_(vsys), pressed_(button_pressed), settings_(settings) {}
 
-void HydroChronoGuiComponent::render(vsg::CommandBuffer& cb) {
+void HydroChronoGuiComponent::render(vsg::CommandBuffer& /*cb*/) {
     // Play/Pause button (top center, no background).
     {
         ImGuiWindowFlags window_flags = 0;

src/gui/vsg_gui_component.h

@@ -12,40 +12,41 @@
 namespace hydroc {
 namespace gui {
 
-// =============================================================================
-// ViewerSettings: Runtime-adjustable water visualization settings
-// =============================================================================
-// Allows tuning water appearance without recompiling.
-// Owned by GUIImplVSG, passed by pointer to GUI component and water surface.
+/// Runtime-adjustable water visualization settings.
+///
+/// Allows tuning water appearance without recompiling. Owned by GUIImplVSG
+/// and passed by pointer to GUI components and the water surface renderer.
 struct ViewerSettings {
+    // --- Display Options ---
     bool show_water = true;           ///< Toggle water surface visibility
-    float wave_visual_scale = 1.0f;   ///< Multiplier for wave elevation display
-    int grid_resolution = 64;         ///< Vertices per side (32/64/96/128)
-    int update_hz = 30;               ///< Max update rate in Hz (10-60)
+    bool show_water_grid = false;     ///< Show wireframe overlay on water surface
     bool show_water_status = false;   ///< Show status line in overlay
 
-    // Allowed discrete values for grid resolution.
+    // --- Wave Rendering ---
+    float wave_visual_scale = 1.0f;   ///< Multiplier for wave elevation display
+    int update_hz = 30;               ///< Maximum update rate [Hz], range 10-60
+
+    // --- Grid Resolution ---
+    int grid_resolution = 64;         ///< Vertices per side (32, 64, 96, or 128)
+    bool resolution_changed = false;  ///< Triggers mesh rebuild when resolution changes
+
     static constexpr int kResolutionOptions[] = {32, 64, 96, 128};
     static constexpr int kResolutionCount = 4;
 
-    // Track if resolution changed (requires mesh rebuild).
-    bool resolution_changed = false;
+    // --- Grid Extent ---
+    // Values <= 0 use defaults (100m x 100m centered at origin).
+    double grid_width = 0.0;          ///< Grid extent in X direction [m]
+    double grid_length = 0.0;         ///< Grid extent in Y direction [m]
+    double grid_center_x = 0.0;       ///< Grid center X coordinate [m]
+    double grid_center_y = 0.0;       ///< Grid center Y coordinate [m]
+    bool grid_extent_changed = false; ///< Triggers mesh rebuild when extent changes
 
-    // =========================================================================
-    // Radiation Visualization (Tier 0 - Approximate, Visual Only)
-    // =========================================================================
-    // Simple visualization of radiated waves from moving bodies.
-    // NOT physically accurate - purely for visual feedback.
-    //
-    // Most parameters are auto-derived from physics:
-    //   - Wavelength derived from wave speed using deep water dispersion
-    //   - Amplitude scales with body velocity and size
-    //   - Only "Visual Scale" is user-adjustable (for inspection)
+    // --- Radiation Visualization (Approximate) ---
+    // Visual-only representation of radiated waves from moving bodies.
+    // NOT physically accurate; wavelength derived from dispersion relation,
+    // amplitude scales with body velocity and size.
     bool show_radiation_viz = false;       ///< Enable radiated wave visualization
-    float radiation_visual_scale = 1.0f;   ///< Visual amplification (range 0.1-5x, for inspection only)
-
-    // Water surface grid overlay for better visibility.
-    bool show_water_grid = false;          ///< Show wireframe grid on water surface
+    float radiation_visual_scale = 1.0f;   ///< Visual amplification [0.1x - 5x]
 };
 
 /// ImGui component for HydroChrono visualization overlay.