Struct nannou::draw::primitive::path::PathOptions

pub struct PathOptions<T> { /* fields omitted */ }

A path drawing context ready to specify tessellation options.

Implementations

impl<T> PathOptions<T>

pub fn new(opts: T) -> Self

Initialise the PathOptions builder.

impl PathOptions<FillOptions>

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

Maximum allowed distance to the path when building an approximation.

This method is shorthand for the fill_tolerance method.

pub fn rule(self, rule: FillRule) -> Self

Specify the rule used to determine what is inside and what is outside of the shape.

Currently, only the EvenOdd rule is implemented.

This method is shorthand for the fill_rule method.

impl PathOptions<StrokeOptions>

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.

impl<T> PathOptions<T> where
    T: TessellationOptions, 

pub fn points<I>(self, ctxt: DrawingContext<'_>, points: I) -> Path where
    I: IntoIterator,
    I::Item: Into<Point2>, 

Consumes an iterator of points and converts them to an iterator yielding path events.

pub fn points_closed<I>(self, ctxt: DrawingContext<'_>, points: I) -> Path where
    I: IntoIterator,
    I::Item: Into<Point2>, 

Consumes an iterator of points and converts them to an iterator yielding path events.

Closes the start and end points.

pub fn points_colored<I, P, C>(
    self,
    ctxt: DrawingContext<'_>,
    points: I
) -> Path where
    I: IntoIterator<Item = (P, C)>,
    P: Into<Point2>,
    C: IntoLinSrgba<ColorScalar>, 

Submit path events as a polyline of colored points.

pub fn points_colored_closed<I, P, C>(
    self,
    ctxt: DrawingContext<'_>,
    points: I
) -> Path where
    I: IntoIterator<Item = (P, C)>,
    P: Into<Point2>,
    C: IntoLinSrgba<ColorScalar>, 

Submit path events as a polyline of colored points.

pub fn points_textured<I, P, TC>(
    self,
    ctxt: DrawingContext<'_>,
    texture_view: &dyn ToTextureView,
    points: I
) -> Path where
    I: IntoIterator<Item = (P, TC)>,
    P: Into<Point2>,
    TC: Into<TexCoords>, 

Submit path events as a polyline of textured points.

pub fn points_textured_closed<I, P, TC>(
    self,
    ctxt: DrawingContext<'_>,
    texture_view: &dyn ToTextureView,
    points: I
) -> Path where
    I: IntoIterator<Item = (P, TC)>,
    P: Into<Point2>,
    TC: Into<TexCoords>, 

Submit path events as a polyline of textured points.

Trait Implementations

impl<T: Clone> Clone for PathOptions<T>

fn clone(&self) -> PathOptions<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for PathOptions<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for PathOptions<T>

fn default() -> PathOptions<T>

Returns the “default value” for a type.

impl From<PathOptions<FillOptions>> for Primitive

fn from(prim: PathFill) -> Self

Performs the conversion.

impl From<PathOptions<StrokeOptions>> for Primitive

fn from(prim: PathStroke) -> Self

Performs the conversion.

impl<T> SetColor<f32> for PathOptions<T>

fn rgba_mut(&mut self) -> &mut Option<LinSrgba>

Provide a mutable reference to the RGBA field which can be used for setting colors.

fn color<C>(self, color: C) -> Self where
    C: IntoLinSrgba<S>, 

Specify a color.

fn rgb<T>(self, r: T, g: T, b: T) -> Self where
    T: Component,
    S: Float, 

Specify the color via red, green and blue channels.

fn rgb8(self, r: u8, g: u8, b: u8) -> Self where
    S: Float, 

Specify the color via red, green and blue channels as bytes

fn rgba<T>(self, r: T, g: T, b: T, a: T) -> Self where
    T: Component,
    S: Float, 

Specify the color via red, green, blue and alpha channels.

fn rgba8(self, r: u8, g: u8, b: u8, a: u8) -> Self where
    S: Float, 

Specify the color via red, green, blue and alpha channels as bytes

fn hsl(self, h: S, s: S, l: S) -> Self where
    S: Float + Into<RgbHue<S>>, 

Specify the color via hue, saturation and luminance.

fn hsla(self, h: S, s: S, l: S, a: S) -> Self where
    S: Float + Into<RgbHue<S>>, 

Specify the color via hue, saturation, luminance and an alpha channel.

fn hsv(self, h: S, s: S, v: S) -> Self where
    S: Float, 

Specify the color via hue, saturation and value (brightness).

fn hsva(self, h: S, s: S, v: S, a: S) -> Self where
    S: Float, 

Specify the color via hue, saturation, value (brightness) and an alpha channel.

fn gray<T>(self, g: T) -> Self where
    T: Component,
    S: Float, 

Specify the color as gray scale

impl<T> SetOrientation for PathOptions<T>

fn properties(&mut self) -> &mut Properties

Provide a mutable reference to the orientation::Properties for updating.

fn look_at(self, target: Point3) -> Self

Describe orientation via the vector that points to the given target.

fn x_radians(self, x: f32) -> Self

Specify the orientation around the x axis as an absolute value in radians.

fn y_radians(self, y: f32) -> Self

Specify the orientation around the y axis as an absolute value in radians.

fn z_radians(self, z: f32) -> Self

Specify the orientation around the z axis as an absolute value in radians.

fn x_degrees(self, x: f32) -> Self

Specify the orientation around the x axis as an absolute value in degrees.

fn y_degrees(self, y: f32) -> Self

Specify the orientation around the y axis as an absolute value in degrees.

fn z_degrees(self, z: f32) -> Self

Specify the orientation around the z axis as an absolute value in degrees.

fn x_turns(self, x: f32) -> Self

Specify the orientation around the x axis as a number of turns around the axis.

fn y_turns(self, y: f32) -> Self

Specify the orientation around the y axis as a number of turns around the axis.

fn z_turns(self, z: f32) -> Self

Specify the orientation around the z axis as a number of turns around the axis.

fn radians(self, v: Vec3) -> Self

Specify the orientation along each axis with the given Vector of radians.

fn degrees(self, v: Vec3) -> Self

Specify the orientation along each axis with the given Vector of degrees.

fn turns(self, v: Vec3) -> Self

Specify the orientation along each axis with the given Vector of “turns”.

fn euler(self, e: Vec3) -> Self

Specify the orientation with the given euler orientation in radians.

fn quaternion(self, q: Quat) -> Self

Specify the orientation with the given Quaternion.

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

Specify the “pitch” of the orientation in radians.

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

Specify the “yaw” of the orientation in radians.

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

Specify the “roll” of the orientation in radians.

fn rotate(self, radians: f32) -> Self

Assuming we’re looking at a 2D plane, positive values cause a clockwise rotation where the given value is specified in radians.

impl<T> SetPosition for PathOptions<T>

fn properties(&mut self) -> &mut Properties

Provide a mutable reference to the position::Properties for updating.

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

Build with the given Absolute Position along the x axis.

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

Build with the given Absolute Position along the y axis.

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

Build with the given Absolute Position along the z axis.

fn xy(self, p: Point2) -> Self

Set the Position with some two-dimensional point.

fn xyz(self, p: Point3) -> Self

Set the Position with some three-dimensional point.

fn x_y(self, x: f32, y: f32) -> Self

Set the Position with x y coordinates.

fn x_y_z(self, x: f32, y: f32, z: f32) -> Self

Set the Position with x y z coordinates.