Struct Clipper 

pub struct Clipper<S: ClipperState = NoSubjects, P: PointScaler = Centi> { /* private fields */ }

The Clipper struct used as a builder for applying boolean operations to paths.

Implementations

impl<P: PointScaler> Clipper<NoSubjects, P>

pub fn new() -> Clipper<NoSubjects, P>

Creates a new empty Clipper instance.

impl<P: PointScaler> Clipper<NoSubjects, P>

pub fn add_subject( self, subject: impl Into<Paths<P>>, ) -> Clipper<WithSubjects, P>

Adds a subject path to the Clipper instance.

Examples

use clipper2::*;

let path: Paths = vec![(0.2, 0.2), (6.0, 0.2), (6.0, 6.0), (0.2, 6.0)].into();

let clipper = Clipper::new().add_subject(path);

pub fn add_open_subject( self, subject: impl Into<Paths<P>>, ) -> Clipper<WithSubjects, P>

Adds an open subject path to the Clipper instance.

Examples

use clipper2::*;

let path: Paths = vec![(0.2, 0.2), (6.0, 0.2), (6.0, 6.0), (0.2, 6.0)].into();

let clipper = Clipper::new().add_open_subject(path);

impl<P: PointScaler> Clipper<WithSubjects, P>

pub fn add_subject(self, subject: impl Into<Paths<P>>) -> Self

Adds another subject path to the Clipper instance.

Examples

use clipper2::*;

let path: Paths = vec![(0.2, 0.2), (6.0, 0.2), (6.0, 6.0), (0.2, 6.0)].into();
let path2: Paths = vec![(1.2, 1.2), (4.0, 1.2), (1.2, 4.0)].into();

let clipper = Clipper::new().add_subject(path).add_subject(path2);

pub fn add_open_subject(self, subject: impl Into<Paths<P>>) -> Self

Adds another open subject path to the Clipper instance.

Examples

use clipper2::*;

let path: Paths = vec![(0.2, 0.2), (6.0, 0.2), (6.0, 6.0), (0.2, 6.0)].into();
let path2: Paths = vec![(1.2, 1.2), (4.0, 1.2), (1.2, 4.0)].into();

let clipper = Clipper::new().add_subject(path).add_open_subject(path2);

pub fn add_clip(self, clip: impl Into<Paths<P>>) -> Clipper<WithClips, P>

Adds a clip path to the Clipper instance.

Examples

use clipper2::*;

let path: Paths = vec![(0.2, 0.2), (6.0, 0.2), (6.0, 6.0), (0.2, 6.0)].into();
let path2: Paths = vec![(1.2, 1.2), (4.0, 1.2), (1.2, 4.0)].into();

let clipper = Clipper::new().add_subject(path).add_clip(path2);

impl<P: PointScaler> Clipper<WithClips, P>

pub fn add_clip(self, clip: impl Into<Paths<P>>) -> Self

Adds another clip path to the Clipper instance.

Examples

use clipper2::*;

let path: Paths = vec![(0.2, 0.2), (6.0, 0.2), (6.0, 6.0), (0.2, 6.0)].into();
let path2: Paths = vec![(1.2, 1.2), (4.0, 1.2), (1.2, 4.0)].into();
let path3: Paths = vec![(2.2, 2.2), (5.0, 2.2), (2.2, 5.0)].into();

let clipper = Clipper::new().add_subject(path).add_clip(path2).add_clip(path3);

pub fn union(self, fill_rule: FillRule) -> Result<Paths<P>, ClipperError>

Applies a union boolean operation to the Clipper instance.

Examples

use clipper2::*;

let path: Paths = vec![(0.2, 0.2), (6.0, 0.2), (6.0, 6.0), (0.2, 6.0)].into();
let path2: Paths = vec![(1.2, 1.2), (4.0, 1.2), (1.2, 4.0)].into();

let result = Clipper::new().add_subject(path).add_clip(path2).union(FillRule::NonZero);

For more details see the original union docs.

pub fn difference(self, fill_rule: FillRule) -> Result<Paths<P>, ClipperError>

Applies a difference boolean operation to the Clipper instance.

Examples

use clipper2::*;

let path: Paths = vec![(0.2, 0.2), (6.0, 0.2), (6.0, 6.0), (0.2, 6.0)].into();
let path2: Paths = vec![(1.2, 1.2), (4.0, 1.2), (1.2, 4.0)].into();

let result = Clipper::new().add_subject(path).add_clip(path2).difference(FillRule::NonZero);

For more details see the original difference docs.

pub fn intersect(self, fill_rule: FillRule) -> Result<Paths<P>, ClipperError>

Applies an intersection boolean operation to the Clipper instance.

Examples

use clipper2::*;

let path: Paths = vec![(0.2, 0.2), (6.0, 0.2), (6.0, 6.0), (0.2, 6.0)].into();
let path2: Paths = vec![(1.2, 1.2), (4.0, 1.2), (1.2, 4.0)].into();

let result = Clipper::new().add_subject(path).add_clip(path2).intersect(FillRule::NonZero);

For more details see the original intersect docs.

pub fn xor(self, fill_rule: FillRule) -> Result<Paths<P>, ClipperError>

Applies an xor boolean operation to the Clipper instance.

Examples

use clipper2::*;

let path: Paths = vec![(0.2, 0.2), (6.0, 0.2), (6.0, 6.0), (0.2, 6.0)].into();
let path2: Paths = vec![(1.2, 1.2), (4.0, 1.2), (1.2, 4.0)].into();

let result = Clipper::new().add_subject(path).add_clip(path2).xor(FillRule::NonZero);

For more details see the original xor docs.

Trait Implementations

impl<S: Debug + ClipperState, P: Debug + PointScaler> Debug for Clipper<S, P>

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

Formats the value using the given formatter.

impl Default for Clipper<NoSubjects, Centi>

fn default() -> Self

Returns the “default value” for a type.

impl<S: ClipperState, P: PointScaler> Drop for Clipper<S, P>

fn drop(&mut self)

Executes the destructor for this type.