pub struct Layer {
pub paths: Vec<Path>,
/* private fields */
}
Fields§
§paths: Vec<Path>
Implementations§
source§impl Layer
impl Layer
pub fn flatten(&self, tolerance: f64) -> FlattenedLayer
pub fn bezier_handles(&self) -> FlattenedLayer
pub fn display_vertices(&self) -> Vec<Point>
pub fn crop(&mut self, x_min: f64, y_min: f64, x_max: f64, y_max: f64) -> &Self
source§impl Layer
impl Layer
sourcepub fn sort(&mut self, flip: bool)
pub fn sort(&mut self, flip: bool)
Sort the paths such as to minimize the pen up distance
This is done using a greedy algorithm, starting with the layer’s first path. Any path that cannot be spatially indexed (empty or otherwise degenerate) is moved at the end.
pub fn sort_with_builder(&mut self, builder: IndexBuilder)
Trait Implementations§
source§impl DocumentTrait<Layer, Path, BezPath> for Document
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)
source§fn merge_layers(&mut self)
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<()>
source§impl Draw for Layer
impl Draw for Layer
Implementing this trait allows drawing directly into a layer.
Each Draw
method will append a new path with default metadata to the layer.
Example
use vsvg::{Draw, DocumentTrait};
let mut doc = vsvg::Document::default();
let layer = doc.get_mut(0);
layer.circle(5.0, 5.0, 10.0);
fn add_path<T: IntoBezPathTolerance>(&mut self, path: T) -> &mut Self
source§fn cubic_bezier(
&mut self,
x1: impl Into<f64>,
y1: impl Into<f64>,
x2: impl Into<f64>,
y2: impl Into<f64>,
x3: impl Into<f64>,
y3: impl Into<f64>,
x4: impl Into<f64>,
y4: impl Into<f64>
) -> &mut Self
fn cubic_bezier( &mut self, x1: impl Into<f64>, y1: impl Into<f64>, x2: impl Into<f64>, y2: impl Into<f64>, x3: impl Into<f64>, y3: impl Into<f64>, x4: impl Into<f64>, y4: impl Into<f64> ) -> &mut Self
Draw a cubic Bézier curve from (
x1
, y1
) to (x4
, y4
) with control points at (x2
,
y2
) and (x3
, y3
).source§fn quadratic_bezier(
&mut self,
x1: impl Into<f64>,
y1: impl Into<f64>,
x2: impl Into<f64>,
y2: impl Into<f64>,
x3: impl Into<f64>,
y3: impl Into<f64>
) -> &mut Self
fn quadratic_bezier( &mut self, x1: impl Into<f64>, y1: impl Into<f64>, x2: impl Into<f64>, y2: impl Into<f64>, x3: impl Into<f64>, y3: impl Into<f64> ) -> &mut Self
Draw a quadratic Bézier curve from (
x1
, y1
) to (x3
, y3
) with control point at (x2
,
y2
).source§fn arc(
&mut self,
x: impl Into<f64>,
y: impl Into<f64>,
rx: impl Into<f64>,
ry: impl Into<f64>,
start: f64,
sweep: f64,
x_rot: f64
) -> &mut Self
fn arc( &mut self, x: impl Into<f64>, y: impl Into<f64>, rx: impl Into<f64>, ry: impl Into<f64>, start: f64, sweep: f64, x_rot: f64 ) -> &mut Self
Draw an elliptical arc centered on (
x
, y
) with radii rx
and ry
. The arc starts at
start
and sweeps sweep
radians. x_rot
is the rotation of the ellipse in radians.source§fn circle(
&mut self,
x: impl Into<f64>,
y: impl Into<f64>,
r: impl Into<f64>
) -> &mut Self
fn circle( &mut self, x: impl Into<f64>, y: impl Into<f64>, r: impl Into<f64> ) -> &mut Self
Draw a circle centered on (
x
, y
) with radius r
.source§fn ellipse(
&mut self,
x: impl Into<f64>,
y: impl Into<f64>,
rx: impl Into<f64>,
ry: impl Into<f64>,
x_rot: f64
) -> &mut Self
fn ellipse( &mut self, x: impl Into<f64>, y: impl Into<f64>, rx: impl Into<f64>, ry: impl Into<f64>, x_rot: f64 ) -> &mut Self
Draw an ellipse centered on (
x
, y
) with radii rx
and ry
. x_rot
is the rotation of
the ellipse in radians.source§fn line(
&mut self,
x1: impl Into<f64>,
y1: impl Into<f64>,
x2: impl Into<f64>,
y2: impl Into<f64>
) -> &mut Self
fn line( &mut self, x1: impl Into<f64>, y1: impl Into<f64>, x2: impl Into<f64>, y2: impl Into<f64> ) -> &mut Self
Draw a line from (
x1
, y1
) to (x2
, y2
).source§fn polyline(
&mut self,
points: impl IntoIterator<Item = impl Into<Point>>,
close: bool
) -> &mut Self
fn polyline( &mut self, points: impl IntoIterator<Item = impl Into<Point>>, close: bool ) -> &mut Self
Draw a polyline from a sequence of points, optionally closing it.
source§fn rect(
&mut self,
x: impl Into<f64>,
y: impl Into<f64>,
w: impl Into<f64>,
h: impl Into<f64>
) -> &mut Self
fn rect( &mut self, x: impl Into<f64>, y: impl Into<f64>, w: impl Into<f64>, h: impl Into<f64> ) -> &mut Self
Draw a rectangle centered on (
x
, y
) with width w
and height h
.source§fn rounded_rect(
&mut self,
x: impl Into<f64>,
y: impl Into<f64>,
w: impl Into<f64>,
h: impl Into<f64>,
tl: impl Into<f64>,
tr: impl Into<f64>,
br: impl Into<f64>,
bl: impl Into<f64>
) -> &mut Self
fn rounded_rect( &mut self, x: impl Into<f64>, y: impl Into<f64>, w: impl Into<f64>, h: impl Into<f64>, tl: impl Into<f64>, tr: impl Into<f64>, br: impl Into<f64>, bl: impl Into<f64> ) -> &mut Self
Draw a rounded rectangle centered on (
x
, y
) with width w
and height h
. The corners
are rounded with radii tl
, tr
, br
, bl
.source§fn catmull_rom(
&mut self,
points: impl IntoIterator<Item = impl Into<Point>>,
tension: f64
) -> &mut Self
fn catmull_rom( &mut self, points: impl IntoIterator<Item = impl Into<Point>>, tension: f64 ) -> &mut Self
Draw a Catmull-Rom spline from a sequence of points and a tension parameter. Read more
source§impl From<FlattenedLayer> for Layer
impl From<FlattenedLayer> for Layer
source§fn from(flattened_layer: FlattenedLayer) -> Self
fn from(flattened_layer: FlattenedLayer) -> Self
Converts to this type from the input type.
source§impl LayerTrait<Path, BezPath> for Layer
impl LayerTrait<Path, BezPath> for Layer
fn from_paths_and_metadata(paths: Vec<Path>, metadata: LayerMetadata) -> Self
fn paths(&self) -> &[Path]
fn paths_mut(&mut self) -> &mut Vec<Path>
fn metadata(&self) -> &LayerMetadata
fn metadata_mut(&mut self) -> &mut LayerMetadata
fn new() -> Self
fn for_each<F>(&mut self, f: F)
fn bounds(&self) -> Option<Rect>
fn push_path(&mut self, path: impl Into<P>)
fn sort(&mut self, flip: bool)
fn sort_with_builder(&mut self, builder: IndexBuilder)
fn pen_up_trajectories(&self) -> Vec<(Point, Point)>
fn stats(&self) -> LayerStats
source§impl Transforms for Layer
impl Transforms for Layer
Implementing this trait allows applying affine transforms to the layer content.
source§fn translate(&mut self, dx: impl Into<f64>, dy: impl Into<f64>) -> &mut Self
fn translate(&mut self, dx: impl Into<f64>, dy: impl Into<f64>) -> &mut Self
Translate the geometry by
dx
and dy
.source§fn scale(&mut self, s: impl Into<f64>) -> &mut Self
fn scale(&mut self, s: impl Into<f64>) -> &mut Self
Scale the geometry by
s
around the origin.source§fn scale_non_uniform(
&mut self,
sx: impl Into<f64>,
sy: impl Into<f64>
) -> &mut Self
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.source§fn scale_around(
&mut self,
sx: impl Into<f64>,
sy: impl Into<f64>,
cx: impl Into<f64>,
cy: impl Into<f64>
) -> &mut Self
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)
.source§fn rotate(&mut self, theta: f64) -> &mut Self
fn rotate(&mut self, theta: f64) -> &mut Self
Rotate the geometry by
theta
radians around the origin.source§fn rotate_deg(&mut self, theta: f64) -> &mut Self
fn rotate_deg(&mut self, theta: f64) -> &mut Self
Rotate the geometry by
theta
degrees around the origin.source§fn rotate_around(
&mut self,
theta: f64,
cx: impl Into<f64>,
cy: impl Into<f64>
) -> &mut Self
fn rotate_around( &mut self, theta: f64, cx: impl Into<f64>, cy: impl Into<f64> ) -> &mut Self
Rotate the geometry by
theta
radians around the point (cx, cy)
.source§fn rotate_around_deg(
&mut self,
theta: f64,
cx: impl Into<f64>,
cy: impl Into<f64>
) -> &mut Self
fn rotate_around_deg( &mut self, theta: f64, cx: impl Into<f64>, cy: impl Into<f64> ) -> &mut Self
Rotate the geometry by
theta
degrees around the point (cx, cy)
.Auto Trait Implementations§
impl RefUnwindSafe for Layer
impl Send for Layer
impl Sync for Layer
impl Unpin for Layer
impl UnwindSafe for Layer
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref()
only in debug builds, and is erased in release
builds.