Type Definition nannou::draw::primitive::path::PathStroke

type PathStroke<S = Default> = PathOptions<StrokeOptions, S>;

A stroked path drawing context.

Methods

impl<S> PathStroke<S>

pub fn weight(self, weight: f32) -> Self

Short-hand for the stroke_weight method.

pub fn tolerance(self, tolerance: f32) -> Self

Short-hand for the stroke_tolerance method.

pub fn colored_points<I>(self, ctxt: DrawingContext<S>, points: I) -> Path<S> where
    S: BaseFloat,
    I: IntoIterator,
    I::Item: Into<ColoredPoint2<S>>, 

Submit path events as a polyline of colored points.

pub fn colored_points_closed<I>(
    self,
    ctxt: DrawingContext<S>,
    points: I
) -> Path<S> where
    S: BaseFloat,
    I: IntoIterator,
    I::Item: Into<ColoredPoint2<S>>, 

Submit path events as a polyline of colored points.

Trait Implementations

impl<S> SetStroke for PathStroke<S>

fn stroke_options_mut(&mut self) -> &mut StrokeOptions

Provide a mutable reference to the StrokeOptions field.

fn stroke_opts(self, opts: StrokeOptions) -> Self

Specify the whole set of stroke tessellation options.

fn start_cap(self, cap: LineCap) -> Self

The start line cap as specified by the SVG spec.

fn end_cap(self, cap: LineCap) -> Self

The end line cap as specified by the SVG spec.

fn caps(self, cap: LineCap) -> Self

The start and end line cap as specified by the SVG spec.

fn start_cap_butt(self) -> Self

The stroke for each sub-path does not extend beyond its two endpoints. A zero length sub-path will therefore not have any stroke.

fn start_cap_square(self) -> Self

At the end of each sub-path, the shape representing the stroke will be extended by a rectangle with the same width as the stroke width and whose length is half of the stroke width. If a sub-path has zero length, then the resulting effect is that the stroke for that sub-path consists solely of a square with side length equal to the stroke width, centered at the sub-path's point.

fn start_cap_round(self) -> Self

At each end of each sub-path, the shape representing the stroke will be extended by a half circle with a radius equal to the stroke width. If a sub-path has zero length, then the resulting effect is that the stroke for that sub-path consists solely of a full circle centered at the sub-path's point.

fn end_cap_butt(self) -> Self

The stroke for each sub-path does not extend beyond its two endpoints. A zero length sub-path will therefore not have any stroke.

fn end_cap_square(self) -> Self

At the end of each sub-path, the shape representing the stroke will be extended by a rectangle with the same width as the stroke width and whose length is half of the stroke width. If a sub-path has zero length, then the resulting effect is that the stroke for that sub-path consists solely of a square with side length equal to the stroke width, centered at the sub-path's point.

fn end_cap_round(self) -> Self

At each end of each sub-path, the shape representing the stroke will be extended by a half circle with a radius equal to the stroke width. If a sub-path has zero length, then the resulting effect is that the stroke for that sub-path consists solely of a full circle centered at the sub-path's point.

fn caps_butt(self) -> Self

The stroke for each sub-path does not extend beyond its two endpoints. A zero length sub-path will therefore not have any stroke.

fn caps_square(self) -> Self

At the end of each sub-path, the shape representing the stroke will be extended by a rectangle with the same width as the stroke width and whose length is half of the stroke width. If a sub-path has zero length, then the resulting effect is that the stroke for that sub-path consists solely of a square with side length equal to the stroke width, centered at the sub-path's point.

fn caps_round(self) -> Self

At each end of each sub-path, the shape representing the stroke will be extended by a half circle with a radius equal to the stroke width. If a sub-path has zero length, then the resulting effect is that the stroke for that sub-path consists solely of a full circle centered at the sub-path's point.

fn join(self, join: LineJoin) -> Self

The way in which lines are joined at the vertices, matching the SVG spec.

fn join_miter(self) -> Self

A sharp corner is to be used to join path segments.

fn join_miter_clip(self) -> Self

Same as a join_miter, but if the miter limit is exceeded, the miter is clipped at a miter length equal to the miter limit value multiplied by the stroke width.

fn join_round(self) -> Self

A round corner is to be used to join path segments.

fn join_bevel(self) -> Self

A bevelled corner is to be used to join path segments. The bevel shape is a triangle that fills the area between the two stroked segments.

fn stroke_weight(self, stroke_weight: f32) -> Self

The total stroke_weight (aka width) of the line.

fn miter_limit(self, limit: f32) -> Self

Describes the limit before miter lines will clip, as described in the SVG spec.

fn stroke_tolerance(self, tolerance: f32) -> Self

Maximum allowed distance to the path when building an approximation.