Skip to main content

InteractiveRippleBuffer

Struct InteractiveRippleBuffer 

#[repr(C)]
pub struct InteractiveRippleBuffer { pub h_prev: [f32; 4096], pub h_curr: [f32; 4096], pub h_next: [f32; 4096], pub center_x: f32, pub center_z: f32, pub world_size_m: f32, pub wave_speed: f32, pub damping: f32, }
Expand description

A zero-heap 2D discrete wave heightfield solver.

Fields§

§h_prev: [f32; 4096]

Previous time-step height buffer $h^{n-1}$

§h_curr: [f32; 4096]

Current time-step height buffer $h^n$

§h_next: [f32; 4096]

Next time-step height buffer $h^{n+1}$

§center_x: f32

World-space center X coordinate

§center_z: f32

World-space center Z coordinate

§world_size_m: f32

Physical width of the grid in meters

§wave_speed: f32

Wave propagation speed $c$ in m/s (typically 1.5 - 3.5 m/s for shallow water ripples)

§damping: f32

Damping factor per step $\gamma \in (0.0, 1.0)$ (e.g. 0.985)

Implementations§

§

impl InteractiveRippleBuffer

pub const fn new( center_x: f32, center_z: f32, world_size_m: f32, wave_speed: f32, damping: f32, ) -> InteractiveRippleBuffer

Creates a new interactive ripple grid centered at (center_x, center_z) in world space.

pub fn clear(&mut self)

Resets all height buffers to zero (calm water).

pub fn cell_size(&self) -> f32

Spatial resolution $\Delta x$ in meters.

pub fn world_to_grid(&self, wx: f32, wz: f32) -> (f32, f32)

Converts world coordinates $(wx, wz)$ to continuous grid indices $(gx, gz) \in [0, \text{DIM}-1]$.

pub fn inject_impulse( &mut self, wx: f32, wz: f32, amplitude: f32, radius_m: f32, )

Injects a smooth radial Gaussian impulse into the wave heightfield.

pub fn step(&mut self, dt: f32)

Steps the 2D wave equation forward by $\Delta t$ seconds.

Uses Courant-Friedrichs-Lewy (CFL) stable finite difference: $h^{n+1}{i,j} = \left[ 2h^n{i,j} - h^{n-1}{i,j} + \alpha (h^n{i+1,j} + h^n_{i-1,j} + h^n_{i,j+1} + h^n_{i,j-1} - 4h^n_{i,j}) \right] \cdot \gamma$ where $\alpha = (c \cdot \Delta t / \Delta x)^2 \le 0.5$.

pub fn sample_height(&self, wx: f32, wz: f32) -> f32

Bilinear sampling of the water surface height at arbitrary world coordinates $(wx, wz)$.

pub fn sample_normal(&self, wx: f32, wz: f32) -> [f32; 3]

Evaluates the normalized surface normal vector $[nx, ny, nz]$ at arbitrary world coordinates.

Trait Implementations§

§

impl Clone for InteractiveRippleBuffer

§

fn clone(&self) -> InteractiveRippleBuffer

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
§

impl Copy for InteractiveRippleBuffer

§

impl Default for InteractiveRippleBuffer

§

fn default() -> InteractiveRippleBuffer

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,