Struct State

pub struct State<IMG> { /* private fields */ }

The state of the image editor’s core. Most importantly, this contains all the layers and images that are being drawn. This state can be modified externally mainly by sending Events via the execute method.

Implementations

impl<IMG: Bitmap + Serialize + for<'de> Deserialize<'de>> State<IMG>

pub fn new( size: Size<i32>, load_project_fn: Option<LoadProject>, save_project_fn: Option<SaveProject>, ) -> Self

Create a new default state for the editor, with a starting canvas size

pub fn execute(&mut self, event: Event) -> Result<CanvasEffect>

Execute an Event. This is the main way of changing the editor’s state, and probably the most central method of this library. A CanvasEffect is returned to communicate to the caller what kind of visual updates must be made.

pub fn canvas_mut(&mut self) -> &mut Canvas<IMG>

Get a mutable reference to the active Layer’s Canvas

pub fn canvas(&self) -> &Canvas<IMG>

Get a reference to the active Layer’s Canvas

pub fn layers(&self) -> &Layers<IMG>

Get a reference to the collection of Layers

pub fn selected_tool(&self) -> Tool

Get the currently selected Tool

pub fn main_color(&self) -> Color

Get the main (selected) color. This is the color used by most tools when drawing

pub fn spritesheet(&self) -> Size<u8>

Get the spritesheet dimensions (number of horizontal and vertical frames). For a static image (not an animation) it will be (1, 1).

pub fn palette(&self) -> &[Color]

Get the colors of the palette

pub fn selection(&self) -> Option<Selection>

Get the Selection

pub fn free_image(&self) -> Option<&FreeImage<IMG>>

Get the FreeImage

pub fn update_free_image(&mut self, mouse_canvas: Position<i32>) -> Result<()>

When drawing lines, rectangles, etc. or moving things, there are visible effects (e.g. a preview of the line or of the image being moved) that are not immediately represented in the canvas, but are stored as a FreeImage instead. This method must be called as often as possible whenever the mouse moves, in order to update this preview image.

Trait Implementations

impl<IMG: Debug> Debug for State<IMG>

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

Formats the value using the given formatter.

impl<'de, IMG> Deserialize<'de> for State<IMG>

where IMG: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<IMG> Serialize for State<IMG>

where IMG: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.