Enum veloren_world::sim::erosion::RiverKind

pub enum RiverKind {
    Ocean,
    Lake {
        neighbor_pass_pos: Vec2<i32>,
    },
    River {
        cross_section: Vec2<f32>,
    },
}

Kind of water on this tile.

Variants

Ocean

Lake

Fields

neighbor_pass_pos: Vec2<i32>

In addition to a downhill node (pointing to, eventually, the bottom of the lake), each lake also has a “pass” that identifies the direction out of which water should flow from this lake if it is minimally flooded. While some lakes may be too full for this to be the actual pass used by their enclosing lake, we still use this as a way to make sure that lake connections to rivers flow in the correct direction.

River

River should be maximal.

Fields

cross_section: Vec2<f32>

Dimensions of the river’s cross-sectional area, as m × m (rivers are approximated as an open rectangular prism in the direction of the velocity vector).

Implementations

impl RiverKind

pub fn is_ocean(&self) -> bool

pub fn is_river(&self) -> bool

pub fn is_lake(&self) -> bool

Trait Implementations

impl Clone for RiverKind

fn clone(&self) -> RiverKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RiverKind

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

Formats the value using the given formatter.

impl PartialEq for RiverKind

fn eq(&self, other: &RiverKind) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RiverKind

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for RiverKind

impl StructuralPartialEq for RiverKind