Struct nannou::draw::primitive::polygon::PolygonInit

pub struct PolygonInit { /* private fields */ }

State related to drawing a Polygon.

Implementations

impl PolygonInit

pub fn stroke<C>(self, color: C) -> Self

where C: IntoLinSrgba<ColorScalar>,

Stroke the outline with the given color.

pub fn points<I>(self, ctxt: DrawingContext<'_>, points: I) -> Polygon

where I: IntoIterator, I::Item: Into<Point2>,

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

pub fn points_colored<I, P, C>( self, ctxt: DrawingContext<'_>, points: I ) -> Polygon

where I: IntoIterator<Item = (P, C)>, P: Into<Point2>, C: IntoLinSrgba<ColorScalar>,

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

pub fn points_textured<I, P, T>( self, ctxt: DrawingContext<'_>, view: &dyn ToTextureView, points: I ) -> Polygon

where I: IntoIterator<Item = (P, T)>, P: Into<Point2>, T: Into<TexCoords>,

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

Trait Implementations

impl Clone for PolygonInit

fn clone(&self) -> PolygonInit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PolygonInit

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

Formats the value using the given formatter.

impl Default for PolygonInit

fn default() -> PolygonInit

Returns the “default value” for a type.

impl From<PolygonInit> for Primitive

fn from(prim: PolygonInit) -> Self

Converts to this type from the input type.

impl SetColor<f32> for PolygonInit

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 SetOrientation for PolygonInit

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 SetPolygon for PolygonInit

fn polygon_options_mut(&mut self) -> &mut PolygonOptions

Access to the polygon builder parameters.

fn no_fill(self) -> Self

Specify no fill color and in turn no fill tessellation for the polygon.

fn stroke_color<C>(self, color: C) -> Self

where C: IntoLinSrgba<ColorScalar>,

Specify a color to use for stroke tessellation.

fn polygon_options(self, opts: PolygonOptions) -> Self

Specify the whole set of polygon options.

impl SetPosition for PolygonInit

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.

impl SetStroke for PolygonInit

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.