Struct veloren_world::layer::tree::TreeConfig

pub struct TreeConfig {

    pub trunk_len: f32,
    pub trunk_radius: f32,
    pub branch_child_len: f32,
    pub branch_child_radius: f32,
    pub branch_child_radius_lerp: bool,
    pub leaf_radius: Range<f32>,
    pub leaf_radius_scaled: f32,
    pub straightness: f32,
    pub max_depth: usize,
    pub splits: Range<f32>,
    pub split_range: Range<f32>,
    pub branch_len_bias: f32,
    pub leaf_vertical_scale: f32,
    pub proportionality: f32,
    pub inhabited: bool,
    pub hanging_sprites: &'static [(f32, SpriteKind)],
    pub trunk_block: StructureBlock,
}

A type that specifies the generation properties of a tree.

Fields

trunk_len: f32

Length of trunk, also scales other branches.

trunk_radius: f32

Radius of trunk, also scales other branches.

branch_child_len: f32

The scale that child branch lengths should be compared to their parents.

branch_child_radius: f32

The scale that child branch radii should be compared to their parents.

branch_child_radius_lerp: bool

Whether the child of a branch has its radius lerped to its parent.

leaf_radius: Range<f32>

The range of radii that leaf-emitting branches might have.

leaf_radius_scaled: f32

An additional leaf radius that may be scaled with proportion along the parent and branch_len_bias.

straightness: f32

0 - 1 (0 = chaotic, 1 = straight).

max_depth: usize

Maximum number of branch layers (not including trunk).

splits: Range<f32>

The number of branches that form from each branch.

split_range: Range<f32>

The range of proportions along a branch at which a split into another branch might occur. This value is clamped between 0 and 1, but a wider range may bias the results towards branch ends.

branch_len_bias: f32

The bias applied to the length of branches based on the proportion along their parent that they eminate from. -1.0 = negative bias (branches at ends are longer, branches at the start are shorter) 0.0 = no bias (branches do not change their length with regard to parent branch proportion) 1.0 = positive bias (branches at ends are shorter, branches at the start are longer)

leaf_vertical_scale: f32

The scale of leaves in the vertical plane. Less than 1.0 implies a flattening of the leaves.

proportionality: f32

How evenly spaced (vs random) sub-branches are along their parent.

inhabited: bool

Whether the tree is inhabited (adds various features and effects)

hanging_sprites: &'static [(f32, SpriteKind)]

trunk_block: StructureBlock

The colour of branches and the trunk.

Implementations

impl TreeConfig

pub fn oak(rng: &mut impl Rng, scale: f32, crowding: f32) -> Self

pub fn dead(rng: &mut impl Rng, scale: f32) -> Self

pub fn apple(rng: &mut impl Rng, scale: f32) -> Self

pub fn frostpine(rng: &mut impl Rng, scale: f32) -> Self

pub fn jungle(rng: &mut impl Rng, scale: f32) -> Self

pub fn baobab(rng: &mut impl Rng, scale: f32) -> Self

pub fn cedar(rng: &mut impl Rng, scale: f32) -> Self

pub fn birch(rng: &mut impl Rng, scale: f32) -> Self

pub fn acacia(rng: &mut impl Rng, scale: f32) -> Self

pub fn chestnut(rng: &mut impl Rng, scale: f32, crowding: f32) -> Self

pub fn pine(rng: &mut impl Rng, scale: f32, calendar: Option<&Calendar>) -> Self

pub fn redwood(rng: &mut impl Rng, scale: f32) -> Self

pub fn giant(_rng: &mut impl Rng, scale: f32, inhabited: bool) -> Self

pub fn cherry(rng: &mut impl Rng, scale: f32) -> Self

Trait Implementations

impl Clone for TreeConfig

fn clone(&self) -> TreeConfig

Returns a copy of the value.

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

Performs copy-assignment from source.