Struct World

pub struct World {
    pub seed: u64,
    pub width: f32,
    pub height: f32,
    pub scale: f32,
    pub frames: Option<usize>,
    pub framerate: usize,
}

The world in which the painting takes place.

Fields

seed: u64

The RNG seed for this painting.

width: f32

The width in coordinate space of the painting.

Coordinate space may differ from output space. If width is 500 but scale is 10, the painting will have a coordinate space width of 500, but the final output will have a width of 5000 pixels.

height: f32

The height in coordinate space of the painting.

Coordinate space may differ from output space. If height is 500 but scale is 10, the painting will have a coordinate space height of 500, but the final output will have a height of 5000 pixels.

scale: f32

The scale of the output.

The final output space is (widthscale)x(heightscale). This value is useful for painting and doing work at one quickly rendering resolution, and later exporting at a much higher resolution while preserving the composition exactly.

This value may be needed when writing shaders or using other raster graphics, to adjust them for the real output size. Vector painting such as with paths should not need to consider this.

frames: Option<usize>

The total number of frames in this painting.

framerate: usize

The number of frames (to try) to render per second.

Implementations

impl World

pub fn normalize(&self, p: P2) -> P2

Normalizes coordinates into the range [0, 1] by dividing them by the coordinate space dimensions.

pub fn center(&self) -> P2

Returns the center of the coordinate space.

pub fn rect(&self) -> Rect

Returns a Rect representing the entire frame.

Trait Implementations

impl Clone for World

fn clone(&self) -> World

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for World

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

Formats the value using the given formatter.

impl Paint for World

Draws a rectangle path covering the entire canvas.

fn paint(&self, comp: &mut Canvas)

Paints self in the composition.

impl StructOpt for World

fn clap<'a, 'b>() -> App<'a, 'b>

Returns the corresponding clap::App.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Creates the struct from clap::ArgMatches. It cannot fail with a parameter generated by clap by construction.

fn from_args() -> Self

where Self: Sized,

Gets the struct from the command line arguments. Print the error message and quit the program in case of failure.

fn from_iter<I>(iter: I) -> Self

where Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error>

where Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making.

impl Copy for World