Struct Stickfigure

pub struct Stickfigure {
    pub version: i32,
    pub build: i32,
    pub scale: f32,
    pub color: Color,
    pub nodes: Graph<Rc<RefCell<Node>>, ()>,
    pub polyfills: Vec<Rc<RefCell<Polyfill>>>,
    /* private fields */
}

Fields

version: i32

build: i32

scale: f32

color: Color

nodes: Graph<Rc<RefCell<Node>>, ()>

polyfills: Vec<Rc<RefCell<Polyfill>>>

Implementations

impl Stickfigure

Public Methods

pub fn new() -> Self

Creates a new, empty Stickfigure, set to latest version and build.

pub fn from_version_and_build( version: i32, build: i32, ) -> Result<Self, LibraryError>

Creates a new, empty Stickfigure, set to the specified version and build.

pub fn to_serializable(&self) -> SerializableStickfigure

pub fn set_is_node_limit_enabled( &mut self, is_enabled: bool, agree: IWillNotAbuseUnlimitedNodes, )

pub fn from_bytes(reader: &mut impl Read) -> Result<Self, LibraryError>

Creates a new Stickfigure from raw bytes of a .nodes file.

pub fn to_bytes(&self) -> Result<Vec<u8>, LibraryError>

Get raw bytes of a .nodes file from an existing Stickfigure.

pub fn add_node( &mut self, node: Node, parent_draw_index: DrawOrderIndex, ) -> Result<DrawOrderIndex, StickfigureError>

Adds a new node to the stickfigure.

The node is given a unique DrawOrderIndex.

Parameters

• node - The Node to add to the Stickfigure.
• parent_draw_index - The DrawOrderIndex of the node to add this node as a child of

Returns

Result of DrawOrderIndex of the newly added node.

pub fn add_node_at_index( &mut self, node: Node, parent_draw_index: DrawOrderIndex, draw_index: DrawOrderIndex, ) -> Result<DrawOrderIndex, StickfigureError>

pub fn change_draw_index( &mut self, draw_index: DrawOrderIndex, new_draw_index: DrawOrderIndex, ) -> Result<(), StickfigureError>

pub fn get_node(&self, draw_index: DrawOrderIndex) -> Option<&Rc<RefCell<Node>>>

Gets a reference to a node.

Parameters

• draw_index - The DrawOrderIndex of the node.

Returns

An Option containing a reference to the node if it exists.

pub fn get_parent(&self, draw_index: DrawOrderIndex) -> Option<DrawOrderIndex>

Get the DrawOrderIndex of the direct parent of the Node at the specified DrawOrderIndex.

pub fn get_children( &self, parent_draw_index: DrawOrderIndex, ) -> Vec<DrawOrderIndex>

Get a Vec<DrawOrderIndex> containing all DrawOrderIndexs of Nodes that are direct children of the Node at the specified DrawOrderIndex.

pub fn get_children_recursive( &self, draw_index: DrawOrderIndex, ) -> Vec<DrawOrderIndex>

pub fn get_parents_recursive( &self, draw_index: DrawOrderIndex, ) -> Vec<DrawOrderIndex>

pub fn get_all_node_indices(&self) -> Vec<DrawOrderIndex>

pub fn get_siblings(&self, draw_index: DrawOrderIndex) -> Vec<DrawOrderIndex>

Gets the sibling nodes of a given node.

Sibling nodes are nodes that share the same parent.

Parameters

• draw_index - The DrawOrderIndex of the node whose siblings are to be found.

Returns

A Vec of DrawOrderIndex representing the siblings of the given node.

pub fn get_nodes_with_property<F>(&self, predicate: F) -> Vec<DrawOrderIndex>

where F: FnMut(&Rc<RefCell<Node>>) -> bool,

pub fn update_nodes_with_property<F>(&mut self, predicate: F, updater: F)

where F: FnMut(&Rc<RefCell<Node>>),

pub fn remove_node( &mut self, draw_index: DrawOrderIndex, ) -> Result<(), StickfigureError>

pub fn add_polyfill(&mut self, polyfill: Polyfill) -> DrawOrderIndex

pub fn get_polyfill( &self, draw_index: DrawOrderIndex, ) -> Option<Rc<RefCell<Polyfill>>>

pub fn remove_polyfill( &mut self, anchor_draw_order: DrawOrderIndex, ) -> Result<(), StickfigureError>

pub fn all_draw_indices_exist(&self, indices: &[DrawOrderIndex]) -> bool

Returns true if all provided DrawOrderIndices exist in the node_index_map.

pub fn draw_index_exists(&self, draw_index: DrawOrderIndex) -> bool

Returns true if provided DrawOrderIndex exists in the node_index_map.

pub fn draw_index_is_polyfill_anchor(&self, draw_index: DrawOrderIndex) -> bool

pub fn missing_draw_indices( &self, indices: &[DrawOrderIndex], ) -> Vec<DrawOrderIndex>

Returns a Vec of DrawOrderIndices that do not exist in node_index_map.

Trait Implementations

impl Clone for Stickfigure

fn clone(&self) -> Stickfigure

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stickfigure

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

Formats the value using the given formatter.

impl Default for Stickfigure

fn default() -> Self

Returns the “default value” for a type.