Struct vsvg::Document

pub struct Document {
    pub layers: BTreeMap<LayerID, Layer>,
    /* private fields */
}

Fields

layers: BTreeMap<LayerID, Layer>

Implementations

impl Document

pub fn new_with_page_size(page_size: PageSize) -> Self

pub fn flatten(&self, tolerance: f64) -> FlattenedDocument

pub fn bezier_handles(&self) -> FlattenedDocument

pub fn crop( &mut self, x_min: impl Into<f64>, y_min: impl Into<f64>, x_max: impl Into<f64>, y_max: impl Into<f64>, )

Crops the contents to the bounds provided.

pub fn center_content(&mut self)

Translates the content of the document so that it’s centered on the page.

If the document has no page size defined, the content is translated such that its bounds become (0, 0, content_width, content_height).

impl Document

pub fn from_svg<P: AsRef<Path>>( path: P, single_layer: bool, ) -> Result<Self, Box<dyn Error>>

Create a Document based on a path to an SVG file.

See Document::from_string for more details on layer handling.

pub fn from_string( svg: &str, single_layer: bool, ) -> Result<Self, Box<dyn Error>>

Create a Document based on a string containing SVG data.

The single_layer parameter determines how layer are handled. If true, all content is added to layer 0. Other each top-level group is added to a layer based on the following rules:

1. If the group has an inkscape:groupmode attribute with the value layer, then the layer ID is determined by the first group of digits in the inkscape:label attribute, if any.
2. Otherwise, the layer ID is determined by teh first group of digits in the id attribute, if any.
3. If neither of the above rules apply, then the layer ID is determined by the top-level group’s order of appearance in the SVG file.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Document

Returns the “default value” for a type.

impl DocumentTrait<Layer, Path, BezPath> for Document

fn layers(&self) -> &BTreeMap<LayerID, Layer>

fn layers_mut(&mut self) -> &mut BTreeMap<LayerID, Layer>

fn metadata(&self) -> &DocumentMetadata

fn metadata_mut(&mut self) -> &mut DocumentMetadata

fn push_path(&mut self, id: LayerID, path: impl Into<P>)

fn try_get(&self, id: LayerID) -> Option<&L>

fn get_mut(&mut self, id: LayerID) -> &mut L

fn ensure_exists(&mut self, id: LayerID)

fn for_each<F>(&mut self, f: F)

where F: Fn(&mut L),

fn merge_layers(&mut self)

Merge all existing layers into layer 0, if any.

fn bounds(&self) -> Option<Rect>

fn stats(&self) -> BTreeMap<LayerID, LayerStats>

fn to_svg_string(&self) -> Result<String, Error>

fn to_svg(&self, writer: impl Write) -> Result<()>

fn to_svg_file(&self, file_path: impl AsRef<Path>) -> Result<()>

impl From<FlattenedDocument> for Document

fn from(flattened_document: FlattenedDocument) -> Self

Converts to this type from the input type.

impl Transforms for Document

fn transform(&mut self, affine: &Affine) -> &mut Self

Apply a 2D affine transform

fn translate(&mut self, dx: impl Into<f64>, dy: impl Into<f64>) -> &mut Self

Translate the geometry by dx and dy.

fn scale(&mut self, s: impl Into<f64>) -> &mut Self

Scale the geometry by s around the origin.

fn scale_non_uniform( &mut self, sx: impl Into<f64>, sy: impl Into<f64>, ) -> &mut Self

Scale the geometry by sx and sy around the origin.

fn scale_around( &mut self, sx: impl Into<f64>, sy: impl Into<f64>, cx: impl Into<f64>, cy: impl Into<f64>, ) -> &mut Self

Scale the geometry by sx and sy around the point (cx, cy).

fn rotate(&mut self, theta: impl Into<f64>) -> &mut Self

Rotate the geometry by theta radians around the origin.

fn rotate_around( &mut self, theta: impl Into<f64>, cx: impl Into<f64>, cy: impl Into<f64>, ) -> &mut Self

Rotate the geometry by theta radians around the point (cx, cy).

fn skew(&mut self, kx: impl Into<f64>, ky: impl Into<f64>) -> &mut Self

Skew the geometry by kx and ky radians around the origin.

fn skew_around( &mut self, kx: impl Into<f64>, ky: impl Into<f64>, cx: impl Into<f64>, cy: impl Into<f64>, ) -> &mut Self

Skew the geometry by kx and ky radians around the point (cx, cy).