Struct fj::Sketch

#[repr(C)]
pub struct Sketch { /* private fields */ }

A sketch

Sketches are currently limited to a single cycle of straight lines, represented by a number of points. For example, if the points a, b, and c are provided, the edges ab, bc, and ca are assumed.

Nothing about these edges is checked right now, but algorithms might assume that the edges are non-overlapping. If you create a Sketch with overlapping edges, you’re on your own.

Examples

Convenient syntax for this operation is available through crate::syntax.

use fj::syntax::*;

// `a` and `b` can be anything that converts to `fj::Shape`
let sketch = [[0., 0.], [1., 0.], [0., 1.]].sketch();

Implementations

impl Sketch

pub fn from_segments(segments: Vec<SketchSegment>) -> Self

Create a sketch made of sketch segments

pub fn from_points(points: Vec<[f64; 2]>) -> Self

Create a sketch made of straight lines from a bunch of points

pub fn from_circle(circle: Circle) -> Self

Create a sketch from a circle

pub fn with_color(self, color: [u8; 4]) -> Self

Set the rendering color of the sketch in RGBA

pub fn chain(&self) -> &Chain

Access the chain of the sketch

pub fn color(&self) -> [u8; 4]

Get the rendering color of the sketch in RGBA

Trait Implementations

impl Clone for Sketch

fn clone(&self) -> Sketch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sketch

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

Formats the value using the given formatter.

impl From<Sketch> for Shape

fn from(shape: Sketch) -> Self

Converts to this type from the input type.

impl From<Sketch> for Shape2d

fn from(shape: Sketch) -> Self

Converts to this type from the input type.

impl PartialEq<Sketch> for Sketch

fn eq(&self, other: &Sketch) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Sketch