Struct pizarra::app::Pizarra

pub struct Pizarra { /* fields omitted */ }

Main controller of the pizarra application.

This struct keeps the state of a drawing and exposes the methods necessary to mutate it according to events in the interface.

Implementations

impl Pizarra

pub fn new(dimensions: Vec2DScreen, config: Config) -> Pizarra

Create a new instance of Pizarra’s controller. Only one is needed and it can be put inside an Rc<RefCell<_>> to use it inside event callbacks in UI implementations.

pub fn get_transform(&self) -> Transform

Returns a transform object needed for proper rendering. This object can translate a point from storage coordinates to screen coordinates.

pub fn config(&self) -> Config

Returns the current config

pub fn get_dimensions(&self) -> Vec2DScreen

Returns the dimensions of the screen

pub fn bgcolor(&self) -> Color

Returns current background color

pub fn selected_color(&self) -> Color

pub fn draw_commands_for_screen(&self) -> Vec<DrawCommand>

Returns an iterator over the draw commands required to render the visible portion of the drawing

pub fn draw_commands_for_drawing(&self) -> Vec<DrawCommand>

Returns an interator over the draw commands required to render the wole drawing. Used for exporting to png

pub fn draw_commands_for_current_shape(&self) -> Option<Vec<DrawCommand>>

returns only the draw commands needed to paint the current shape on the screen.

pub fn resize(&mut self, new_size: Vec2DScreen)

Notify the application that the screen size has changed

pub fn set_tool(&mut self, selected_tool: SelectedTool)

Set a new tool used to handle user input

pub fn set_stroke(&mut self, stroke: f64)

Set a new stroke that will be used in next shapes

pub fn set_alpha(&mut self, alpha: u8)

pub fn set_bgcolor(&mut self, bgcolor: Color)

Set the background color of the drawing

pub fn set_erase_radius(&mut self, erase_radius: f64)

Set the radius of action for the eraser tool

pub fn handle_mouse_button_pressed(
    &mut self,
    button: MouseButton,
    point: Vec2DScreen
) -> ShouldRedraw

Public method that the UI must call whenever a button of the mouse or pen is pressed.

pub fn handle_mouse_button_released(
    &mut self,
    button: MouseButton,
    point: Vec2DScreen
) -> ShouldRedraw

Public method that the UI must call whenever a button of the mouse or pen is released.

pub fn handle_mouse_move(&mut self, pos: Vec2DScreen) -> ShouldRedraw

Public methid that the UI must call with updates on the cursor position

pub fn handle_key_pressed(&mut self, key: Key)

pub fn handle_key_released(&mut self, key: Key) -> ShouldRedraw

pub fn zoom_in(&mut self)

Zooms in the current view, so objects are bigger and the visible portion of the drawing gets reduced

pub fn zoom_out(&mut self)

Zooms out the current view, so objects are smaller and the visible portion of the drawing increases

pub fn scroll(&mut self, delta: Vec2DScreen)

pub fn go_home(&mut self)

Resets the center and zoom level of the view to its original place

pub fn set_color(&mut self, color: Color)

Sets the color for the new shapes

pub fn undo(&mut self)

Undoes the last action if any

pub fn redo(&mut self)

Redoes the last undone action, if any

pub fn get_bounds(&self) -> Option<[Vec2DWorld; 2]>

Returns the bounding box that contains all the shapes in the drawing

pub fn get_save_status(&self) -> &SaveStatus

Returns a reference to this drawing’s save status

pub fn set_saved(&mut self, path: PathBuf)

Notify the application that the drawing has been saved at path

pub fn reset(&mut self)

Resets the state of the drawing, undo, shapes etc so you can start drawing again.

pub fn open(&mut self, svg: &str) -> Result<(), Error>

impl Pizarra

pub fn to_svg(&self) -> Option<String>