Struct OceanWave 

pub struct OceanWave {
    pub amplitude: f32,
    pub wavelength: f32,
    pub direction: Vec2,
    pub phase_speed: f32,
}

A single Gerstner wave component.

Fields

amplitude: f32

Wave amplitude (metres).

wavelength: f32

Wavelength (metres).

direction: Vec2

Horizontal direction of propagation (unit Vec2).

phase_speed: f32

Phase speed (m/s). Deep-water: sqrt(g * wavelength / 2π).

Implementations

impl OceanWave

pub fn new( amplitude: f32, wavelength: f32, direction: Vec2, phase_speed: f32, ) -> Self

pub fn deep_water(amplitude: f32, wavelength: f32, direction: Vec2) -> Self

Create a physically-based deep-water wave.

pub fn wave_number(&self) -> f32

Wave number k = 2π / λ.

pub fn omega(&self) -> f32

Angular frequency ω = k * c.

Trait Implementations

impl Clone for OceanWave

fn clone(&self) -> OceanWave

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OceanWave

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.