Struct CanvasState 

pub struct CanvasState { /* private fields */ }

State for a Canvas component.

Contains the shapes to draw, coordinate bounds, and display options.

Example

use envision::component::{CanvasState, CanvasShape, CanvasMarker};
use ratatui::style::Color;

let state = CanvasState::new()
    .with_bounds(0.0, 200.0, 0.0, 100.0)
    .with_title("Drawing")
    .with_marker(CanvasMarker::HalfBlock)
    .with_shapes(vec![
        CanvasShape::Circle { x: 100.0, y: 50.0, radius: 25.0, color: Color::Cyan },
    ]);

assert_eq!(state.shapes().len(), 1);
assert_eq!(state.x_bounds(), [0.0, 200.0]);
assert_eq!(state.y_bounds(), [0.0, 100.0]);

Implementations

impl CanvasState

pub fn new() -> Self

Creates a new empty canvas with default bounds [0, 100] on both axes.

Example

use envision::component::CanvasState;

let state = CanvasState::new();
assert!(state.shapes().is_empty());
assert_eq!(state.x_bounds(), [0.0, 100.0]);
assert_eq!(state.y_bounds(), [0.0, 100.0]);

pub fn with_shapes(self, shapes: Vec<CanvasShape>) -> Self

Sets the initial shapes (builder pattern).

Example

use envision::component::{CanvasState, CanvasShape};
use ratatui::style::Color;

let state = CanvasState::new().with_shapes(vec![
    CanvasShape::Line { x1: 0.0, y1: 0.0, x2: 100.0, y2: 100.0, color: Color::Red },
]);
assert_eq!(state.shapes().len(), 1);

pub fn with_x_bounds(self, min: f64, max: f64) -> Self

Sets the x-axis range (builder pattern).

Example

use envision::component::CanvasState;

let state = CanvasState::new().with_x_bounds(-50.0, 50.0);
assert_eq!(state.x_bounds(), [-50.0, 50.0]);

pub fn with_y_bounds(self, min: f64, max: f64) -> Self

Sets the y-axis range (builder pattern).

Example

use envision::component::CanvasState;

let state = CanvasState::new().with_y_bounds(0.0, 200.0);
assert_eq!(state.y_bounds(), [0.0, 200.0]);

pub fn with_bounds(self, x_min: f64, x_max: f64, y_min: f64, y_max: f64) -> Self

Sets both x and y axis ranges (builder pattern).

Example

use envision::component::CanvasState;

let state = CanvasState::new().with_bounds(0.0, 200.0, 0.0, 100.0);
assert_eq!(state.x_bounds(), [0.0, 200.0]);
assert_eq!(state.y_bounds(), [0.0, 100.0]);

pub fn with_title(self, title: impl Into<String>) -> Self

Sets the border title (builder pattern).

Example

use envision::component::CanvasState;

let state = CanvasState::new().with_title("Drawing Surface");
assert_eq!(state.title(), Some("Drawing Surface"));

pub fn with_marker(self, marker: CanvasMarker) -> Self

Sets the marker type (builder pattern).

Example

use envision::component::{CanvasState, CanvasMarker};

let state = CanvasState::new().with_marker(CanvasMarker::Block);
assert_eq!(state.marker(), &CanvasMarker::Block);

pub fn shapes(&self) -> &[CanvasShape]

Returns the shapes on the canvas.

Example

use envision::component::{CanvasState, CanvasShape};
use ratatui::style::Color;

let state = CanvasState::new().with_shapes(vec![
    CanvasShape::Circle { x: 50.0, y: 50.0, radius: 10.0, color: Color::Red },
]);
assert_eq!(state.shapes().len(), 1);

pub fn add_shape(&mut self, shape: CanvasShape)

Adds a shape to the canvas.

Example

use envision::component::{CanvasState, CanvasShape};
use ratatui::style::Color;

let mut state = CanvasState::new();
state.add_shape(CanvasShape::Line {
    x1: 0.0, y1: 0.0, x2: 100.0, y2: 100.0, color: Color::White,
});
assert_eq!(state.shapes().len(), 1);

pub fn clear(&mut self)

Removes all shapes from the canvas.

Example

use envision::component::{CanvasState, CanvasShape};
use ratatui::style::Color;

let mut state = CanvasState::new().with_shapes(vec![
    CanvasShape::Circle { x: 50.0, y: 50.0, radius: 10.0, color: Color::Red },
]);
state.clear();
assert!(state.shapes().is_empty());

pub fn x_bounds(&self) -> [f64; 2]

Returns the x-axis bounds.

pub fn y_bounds(&self) -> [f64; 2]

Returns the y-axis bounds.

pub fn set_x_bounds(&mut self, min: f64, max: f64)

Sets the x-axis bounds.

Example

use envision::component::CanvasState;

let mut state = CanvasState::new();
state.set_x_bounds(-100.0, 100.0);
assert_eq!(state.x_bounds(), [-100.0, 100.0]);

pub fn set_y_bounds(&mut self, min: f64, max: f64)

Sets the y-axis bounds.

Example

use envision::component::CanvasState;

let mut state = CanvasState::new();
state.set_y_bounds(-50.0, 50.0);
assert_eq!(state.y_bounds(), [-50.0, 50.0]);

pub fn title(&self) -> Option<&str>

Returns the title.

pub fn set_title(&mut self, title: Option<String>)

Sets the title.

pub fn marker(&self) -> &CanvasMarker

Returns the marker type.

pub fn set_marker(&mut self, marker: CanvasMarker)

Sets the marker type.

pub fn update(&mut self, msg: CanvasMessage) -> Option<()>

Updates the state with a message, returning any output.

Trait Implementations

impl Clone for CanvasState

fn clone(&self) -> CanvasState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanvasState

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

Formats the value using the given formatter.

impl Default for CanvasState

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CanvasState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CanvasState

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CanvasState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CanvasState