Struct draught::paint::Painter

pub struct Painter {

    canvas: HtmlCanvasElement,
    context: CanvasRenderingContext2d,
    selected_idx: Option<BrdIdx>,
    white_square: JsValue,
    black_square: JsValue,
    white_piece: JsValue,
    black_piece: JsValue,
    selected_piece: JsValue,
    white_piece_line: JsValue,
    black_piece_line: JsValue,
    selected_piece_line: JsValue,
    king_line: JsValue,
    piece_lines: bool,
    piece_line_proportion: f64,
    square_outline: JsValue,
    outline_width: f64,
    draw_outline: bool,
    width: u32,
    height: u32,
}

Used to paint boards onto HTML canvases

Fields

canvas: HtmlCanvasElement

context: CanvasRenderingContext2d

selected_idx: Option<BrdIdx>

white_square: JsValue

black_square: JsValue

white_piece: JsValue

black_piece: JsValue

selected_piece: JsValue

white_piece_line: JsValue

black_piece_line: JsValue

selected_piece_line: JsValue

king_line: JsValue

piece_lines: bool

piece_line_proportion: f64

square_outline: JsValue

outline_width: f64

draw_outline: bool

width: u32

height: u32

Implementations

impl Painter

pub fn set_selected(&mut self, idx: &Option<BrdIdx>)

Set selected piece by board index

fn get_canvas(canvas_id: &str) -> HtmlCanvasElement

Get a canvas by element ID

fn get_canvas_context(canvas: &HtmlCanvasElement) -> CanvasRenderingContext2d

Get a 2D canvas context for a given canvas

impl Painter

pub fn new(width: u32, height: u32, canvas_id: &str) -> Painter

Default constructor which queries for canvas by ID

pub fn new_with_canvas(
    width: u32,
    height: u32,
    canvas: HtmlCanvasElement
) -> Painter

Constructor with given canvas element

pub fn set_square_outline(&mut self, value: JsValue)

Set new square outline colour value

pub fn set_outline_width(&mut self, value: f64)

Set new line width for outlining squares

pub fn set_draw_outline(&mut self, value: bool)

Set whether squares are outlined

pub fn reset_dimensions(&self)

Reset the canvas dimensions to the given width and height

pub fn validate_board_dim(&self, board: &Board) -> bool

Check whether given canvas dimensions divide evenly by given board dimenions

pub fn draw(&self, board: &Board)

Draw a board onto the canvas

Trait Implementations

impl Debug for Painter

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

Formats the value using the given formatter.

impl From<Painter> for JsValue

fn from(value: Painter) -> Self

Converts to this type from the input type.

impl FromWasmAbi for Painter

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for Painter

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl OptionFromWasmAbi for Painter

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Painter

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Painter

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, Painter>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for Painter

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, Painter>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl WasmDescribe for Painter

fn describe()