Enum usvg_tree::Node

pub enum Node {
    Group(Box<Group>),
    Path(Box<Path>),
    Image(Box<Image>),
    Text(Box<Text>),
}

Node’s kind.

Variants

Group(Box<Group>)

Path(Box<Path>)

Image(Box<Image>)

Text(Box<Text>)

Implementations

impl Node

pub fn id(&self) -> &str

Returns node’s ID.

pub fn abs_transform(&self) -> Transform

Returns node’s absolute transform.

If a current node doesn’t support transformation - a default transform will be returned.

This method is cheap since absolute transforms are already resolved.

pub fn bounding_box(&self) -> Option<Rect>

Returns node’s bounding box in object coordinates, if any.

This method is cheap since bounding boxes are already calculated.

pub fn abs_bounding_box(&self) -> Option<Rect>

Returns node’s bounding box in canvas coordinates, if any.

This method is cheap since bounding boxes are already calculated.

pub fn stroke_bounding_box(&self) -> Option<NonZeroRect>

Returns node’s bounding box, including stroke, in object coordinates, if any.

This method is cheap since bounding boxes are already calculated.

pub fn abs_stroke_bounding_box(&self) -> Option<NonZeroRect>

Returns node’s bounding box, including stroke, in canvas coordinates, if any.

This method is cheap since bounding boxes are already calculated.

pub fn subroots<F: FnMut(&Group)>(&self, f: F)

Calls a closure for each subroot this Node has.

The Tree::root field contain only render-able SVG elements. But some elements, specifically clip paths, masks, patterns and feImage can store their own SVG subtrees. And while one can access them manually, it’s pretty verbose. This methods allows looping over all SVG elements present in the Tree.

Example

fn all_nodes(parent: &usvg_tree::Group) {
    for node in &parent.children {
        // do stuff...

        if let usvg_tree::Node::Group(ref g) = node {
            all_nodes(g);
        }

        // handle subroots as well
        node.subroots(|subroot| all_nodes(subroot));
    }
}

pub fn subroots_mut<F: FnMut(&mut Group)>(&mut self, f: F)

Calls a closure for each subroot this Node has.

A mutable version of subroots().

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.