Struct nannou::draw::properties::primitive::line::Line

pub struct Line<S = DefaultScalar> { /* fields omitted */ }

Properties related to drawing a Line.

Methods

impl<S> Line<S> where     S: BaseFloat,

pub fn new(start: Point2<S>, end: Point2<S>, half_thickness: S) -> Self

Create a new Line. from its geometric parts.

pub fn thickness(self, thickness: S) -> Self

Specify the thickness of the Line.

pub fn half_thickness(self, half_thickness: S) -> Self

Specify half the thickness of the Line.

As the half-thickness is used more commonly within Line geometric calculations, this can be slightly more efficient than the full thickness method.

pub fn start(self, start: Point2<S>) -> Self

Specify the start point for the line.

pub fn end(self, end: Point2<S>) -> Self

Specify the end point for the line.

pub fn points(self, start: Point2<S>, end: Point2<S>) -> Self

Use the given four points as the vertices (corners) of the quad.

pub fn caps_round(self) -> Self

Draw rounded caps on the ends of the line.

The radius of the semi-circle is equal to the line's half_thickness.

pub fn caps_round_with_resolution(self, resolution: usize) -> Self

Draw rounded caps on the ends of the line.

The radius of the semi-circle is equal to the line's half_thickness.

pub fn caps_square(self) -> Self

Draw squared caps on the ends of the line.

The length of the protrusion is equal to the line's half_thickness.

Trait Implementations

impl<S: Clone> Clone for Line<S>

fn clone(&self) -> Line<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Line<S>

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

Formats the value using the given formatter.

impl<S> IntoDrawn<S> for Line<S> where     S: BaseFloat,

type Vertices = IterFromPoint2s<CappedVertices<S>, S>

The iterator type yielding all unique vertices in the drawing.

type Indices = TriangleIndices

The iterator type yielding all vertex indices, describing edges of the drawing.

fn into_drawn(self, draw: Draw<S>) -> Drawn<S, Self::Vertices, Self::Indices>

Consume self and return its Drawn form.

impl<S> From<Line<S>> for Line<S> where     S: BaseFloat,

fn from(line: Line<S>) -> Self

Performs the conversion.

impl<S> From<Capped<S>> for Line<S> where     S: BaseFloat,

fn from(capped: Capped<S>) -> Self

Performs the conversion.

impl<S> Default for Line<S> where     S: BaseFloat,

fn default() -> Self

Returns the "default value" for a type.

impl<S> SetOrientation<S> for Line<S>

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

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

fn look_at(self, target: LookAt<S>) -> Self

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

fn look_at_node(self, node: Index) -> Self

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

fn look_at_point(self, point: Point3<S>) -> Self

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

fn x_orientation(self, orientation: Orientation<S>) -> Self

Build with the given Orientation along the x axis.

fn y_orientation(self, orientation: Orientation<S>) -> Self

Build with the given Orientation along the x axis.

fn z_orientation(self, orientation: Orientation<S>) -> Self

Build with the given Orientation along the x axis.

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

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

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

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

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

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

fn x_degrees(self, x: S) -> Self where     S: BaseFloat,

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

fn y_degrees(self, y: S) -> Self where     S: BaseFloat,

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

fn z_degrees(self, z: S) -> Self where     S: BaseFloat,

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

fn x_turns(self, x: S) -> Self where     S: BaseFloat,

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

fn y_turns(self, y: S) -> Self where     S: BaseFloat,

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

fn z_turns(self, z: S) -> Self where     S: BaseFloat,

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

fn radians(self, v: Vector3<S>) -> Self

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

fn degrees(self, v: Vector3<S>) -> Self where     S: BaseFloat,

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

fn turns(self, v: Vector3<S>) -> Self where     S: BaseFloat,

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

fn euler<A>(self, e: Euler<A>) -> Self where     S: BaseFloat,     A: Angle + Into<Rad<S>>,

Specify the orientation with the given Euler.

fn quaternion(self, q: Quaternion<S>) -> Self where     S: BaseFloat,

Specify the orientation with the given Quaternion.

fn x_radians_relative(self, x: S) -> Self

Specify the orientation around the x axis as a relative value in radians.

fn y_radians_relative(self, y: S) -> Self

Specify the orientation around the y axis as a relative value in radians.

fn z_radians_relative(self, z: S) -> Self

Specify the orientation around the z axis as a relative value in radians.

fn x_radians_relative_to(self, other: Index, x: S) -> Self

Specify the orientation around the x axis as a relative value in radians.

fn y_radians_relative_to(self, other: Index, y: S) -> Self

Specify the orientation around the y axis as a relative value in radians.

fn z_radians_relative_to(self, other: Index, z: S) -> Self

Specify the orientation around the z axis as a relative value in radians.

fn x_degrees_relative(self, x: S) -> Self where     S: BaseFloat,

Specify the orientation around the x axis as a relative value in degrees.

fn y_degrees_relative(self, y: S) -> Self where     S: BaseFloat,

Specify the orientation around the y axis as a relative value in degrees.

fn z_degrees_relative(self, z: S) -> Self where     S: BaseFloat,

Specify the orientation around the z axis as a relative value in degrees.

fn x_degrees_relative_to(self, other: Index, x: S) -> Self where     S: BaseFloat,

Specify the orientation around the x axis as a relative value in degrees.

fn y_degrees_relative_to(self, other: Index, y: S) -> Self where     S: BaseFloat,

Specify the orientation around the y axis as a relative value in degrees.

fn z_degrees_relative_to(self, other: Index, z: S) -> Self where     S: BaseFloat,

Specify the orientation around the z axis as a relative value in degrees.

fn x_turns_relative(self, x: S) -> Self where     S: BaseFloat,

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

fn y_turns_relative(self, y: S) -> Self where     S: BaseFloat,

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

fn z_turns_relative(self, z: S) -> Self where     S: BaseFloat,

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

fn x_turns_relative_to(self, other: Index, x: S) -> Self where     S: BaseFloat,

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

fn y_turns_relative_to(self, other: Index, y: S) -> Self where     S: BaseFloat,

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

fn z_turns_relative_to(self, other: Index, z: S) -> Self where     S: BaseFloat,

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

fn radians_relative(self, v: Vector3<S>) -> Self

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

fn radians_relative_to(self, other: Index, v: Vector3<S>) -> Self

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

fn degrees_relative(self, v: Vector3<S>) -> Self where     S: BaseFloat,

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

fn degrees_relative_to(self, other: Index, v: Vector3<S>) -> Self where     S: BaseFloat,

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

fn turns_relative(self, v: Vector3<S>) -> Self where     S: BaseFloat,

Specify a relative orientation along each axis with the given Vector of "turns".

fn turns_relative_to(self, other: Index, v: Vector3<S>) -> Self where     S: BaseFloat,

Specify a relative orientation along each axis with the given Vector of "turns".

fn euler_relative<A>(self, e: Euler<A>) -> Self where     S: BaseFloat,     A: Angle + Into<Rad<S>>,

Specify a relative orientation with the given Euler.

fn euler_relative_to<A>(self, other: Index, e: Euler<A>) -> Self where     S: BaseFloat,     A: Angle + Into<Rad<S>>,

Specify a relative orientation with the given Euler.

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

Specify the "pitch" of the orientation in radians.

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

Specify the "yaw" of the orientation in radians.

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

Specify the "roll" of the orientation in radians.

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

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

impl<S> SetPosition<S> for Line<S>

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

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

fn x_position(self, position: Position<S>) -> Self

Build with the given Position along the x axis.

fn y_position(self, position: Position<S>) -> Self

Build with the given Position along the y axis.

fn z_position(self, position: Position<S>) -> Self

Build with the given Position along the z axis.

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

Build with the given Absolute Position along the x axis.

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

Build with the given Absolute Position along the y axis.

fn z(self, y: S) -> Self

Build with the given Absolute Position along the z axis.

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

Set the Position with some two-dimensional point.

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

Set the Position with some three-dimensional point.

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

Set the Position with x y coordinates.

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

Set the Position with x y z coordinates.

fn x_position_relative(self, x: Relative<S>) -> Self

Set the x Position Relative to the previous node.

fn y_position_relative(self, y: Relative<S>) -> Self

Set the y Position Relative to the previous node.

fn z_position_relative(self, z: Relative<S>) -> Self

Set the z Position Relative to the previous node.

fn x_y_position_relative(self, x: Relative<S>, y: Relative<S>) -> Self

Set the x and y Positions Relative to the previous node.

fn x_y_z_position_relative(     self,     x: Relative<S>,     y: Relative<S>,     z: Relative<S> ) -> Self

Set the x, y and z Positions Relative to the previous node.

fn x_position_relative_to(self, other: Index, x: Relative<S>) -> Self

Set the x Position Relative to the given node.

fn y_position_relative_to(self, other: Index, y: Relative<S>) -> Self

Set the y Position Relative to the given node.

fn z_position_relative_to(self, other: Index, z: Relative<S>) -> Self

Set the y Position Relative to the given node.

fn x_y_position_relative_to(     self,     other: Index,     x: Relative<S>,     y: Relative<S> ) -> Self

Set the x and y Positions Relative to the given node.

fn x_y_z_position_relative_to(     self,     other: Index,     x: Relative<S>,     y: Relative<S>,     z: Relative<S> ) -> Self

Set the x, y and z Positions Relative to the given node.

fn x_relative(self, x: S) -> Self

Set the Position as a Scalar along the x axis Relative to the middle of previous node.

fn y_relative(self, y: S) -> Self

Set the Position as a Scalar along the y axis Relative to the middle of previous node.

fn z_relative(self, z: S) -> Self

Set the Position as a Scalar along the z axis Relative to the middle of previous node.

fn xy_relative(self, p: Point2<S>) -> Self

Set the Position as a Point Relative to the middle of the previous node.

fn xyz_relative(self, p: Point3<S>) -> Self

Set the Position as a Point Relative to the middle of the previous node.

fn x_y_relative(self, x: S, y: S) -> Self

Set the Position as Scalars along the x and y axes Relative to the middle of the previous node.

fn x_y_z_relative(self, x: S, y: S, z: S) -> Self

Set the Position as Scalars along the x, y and z axes Relative to the middle of the previous node.

fn x_relative_to(self, other: Index, x: S) -> Self

Set the position relative to the node with the given node::Index.

fn y_relative_to(self, other: Index, y: S) -> Self

Set the position relative to the node with the given node::Index.

fn z_relative_to(self, other: Index, z: S) -> Self

Set the position relative to the node with the given node::Index.

fn xy_relative_to(self, other: Index, p: Point2<S>) -> Self

Set the position relative to the node with the given node::Index.

fn xyz_relative_to(self, other: Index, p: Point3<S>) -> Self

Set the position relative to the node with the given node::Index.

fn x_y_relative_to(self, other: Index, x: S, y: S) -> Self

Set the position relative to the node with the given node::Index.

fn x_y_z_relative_to(self, other: Index, x: S, y: S, z: S) -> Self

Set the position relative to the node with the given node::Index.

fn x_direction(self, direction: Direction, x: S) -> Self

Build with the Position along the x axis as some distance from another node.

fn y_direction(self, direction: Direction, y: S) -> Self

Build with the Position along the y axis as some distance from another node.

fn z_direction(self, direction: Direction, z: S) -> Self

Build with the Position along the z axis as some distance from another node.

fn left(self, x: S) -> Self

Build with the Position as some distance to the left of another node.

fn right(self, x: S) -> Self

Build with the Position as some distance to the right of another node.

fn down(self, y: S) -> Self

Build with the Position as some distance below another node.

fn up(self, y: S) -> Self

Build with the Position as some distance above another node.

fn backwards(self, z: S) -> Self

Build with the Position as some distance in front of another node.

fn forwards(self, z: S) -> Self

Build with the Position as some distance behind another node.

fn x_direction_from(self, other: Index, direction: Direction, x: S) -> Self

Build with the Position along the x axis as some distance from the given node.

fn y_direction_from(self, other: Index, direction: Direction, y: S) -> Self

Build with the Position along the y axis as some distance from the given node.

fn z_direction_from(self, other: Index, direction: Direction, z: S) -> Self

Build with the Position along the z axis as some distance from the given node.

fn left_from(self, other: Index, x: S) -> Self

Build with the Position as some distance to the left of the given node.

fn right_from(self, other: Index, x: S) -> Self

Build with the Position as some distance to the right of the given node.

fn down_from(self, other: Index, y: S) -> Self

Build with the Position as some distance below the given node.

fn up_from(self, other: Index, y: S) -> Self

Build with the Position as some distance above the given node.

fn backwards_from(self, other: Index, z: S) -> Self

Build with the Position as some distance in front of the given node.

fn forwards_from(self, other: Index, z: S) -> Self

Build with the Position as some distance above the given node.

fn x_align(self, align: Align<S>) -> Self

Align the Position of the node along the x axis.

fn y_align(self, align: Align<S>) -> Self

Align the Position of the node along the y axis.

fn z_align(self, align: Align<S>) -> Self

Align the Position of the node along the z axis.

fn align_left(self) -> Self

Align the position to the left.

fn align_left_with_margin(self, margin: S) -> Self

Align the position to the left.

fn align_middle_x(self) -> Self

Align the position to the middle.

fn align_right(self) -> Self

Align the position to the right.

fn align_right_with_margin(self, margin: S) -> Self

Align the position to the right.

fn align_bottom(self) -> Self

Align the position to the bottom.

fn align_bottom_with_margin(self, margin: S) -> Self

Align the position to the bottom.

fn align_middle_y(self) -> Self

Align the position to the middle.

fn align_top(self) -> Self

Align the position to the top.

fn align_top_with_margin(self, margin: S) -> Self

Align the position to the top.

fn align_front(self) -> Self

Align the position to the front.

fn align_front_with_margin(self, margin: S) -> Self

Align the position to the front.

fn align_middle_z(self) -> Self

Align the position to the middle.

fn align_back(self) -> Self

Align the position to the back.

fn align_back_with_margin(self, margin: S) -> Self

Align the position to the back.

fn x_align_to(self, other: Index, align: Align<S>) -> Self

Align the Position of the node with the given node along the x axis.

fn y_align_to(self, other: Index, align: Align<S>) -> Self

Align the Position of the node with the given node along the y axis.

fn z_align_to(self, other: Index, align: Align<S>) -> Self

Align the Position of the node with the given node along the z axis.

fn align_left_of(self, other: Index) -> Self

Align the position to the left.

fn align_left_of_with_margin(self, other: Index, margin: S) -> Self

Align the position to the left.

fn align_middle_x_of(self, other: Index) -> Self

Align the position to the middle.

fn align_right_of(self, other: Index) -> Self

Align the position to the right.

fn align_right_of_with_margin(self, other: Index, margin: S) -> Self

Align the position to the right.

fn align_bottom_of(self, other: Index) -> Self

Align the position to the bottom.

fn align_bottom_of_with_margin(self, other: Index, margin: S) -> Self

Align the position to the bottom.

fn align_middle_y_of(self, other: Index) -> Self

Align the position to the middle.

fn align_top_of(self, other: Index) -> Self

Align the position to the top.

fn align_top_of_with_margin(self, other: Index, margin: S) -> Self

Align the position to the top.

fn align_front_of(self, other: Index) -> Self

Align the position to the front.

fn align_front_of_with_margin(self, other: Index, margin: S) -> Self

Align the position to the front.

fn align_middle_z_of(self, other: Index) -> Self

Align the position to the middle.

fn align_back_of(self, other: Index) -> Self

Align the position to the back.

fn align_back_of_with_margin(self, other: Index, margin: S) -> Self

Align the position to the back.

fn middle(self) -> Self

Align the node to the middle of the last node.

fn bottom_left(self) -> Self

Align the node to the bottom left of the last node.

fn mid_left(self) -> Self

Align the node to the middle left of the last node.

fn top_left(self) -> Self

Align the node to the top left of the last node.

fn mid_top(self) -> Self

Align the node to the middle top of the last node.

fn top_right(self) -> Self

Align the node to the top right of the last node.

fn mid_right(self) -> Self

Align the node to the middle right of the last node.

fn bottom_right(self) -> Self

Align the node to the bottom right of the last node.

fn mid_bottom(self) -> Self

Align the node to the middle bottom of the last node.

fn middle_of(self, other: Index) -> Self

Align the node in the middle of the given Node.

fn bottom_left_of(self, other: Index) -> Self

Align the node to the bottom left of the given Node.

fn mid_left_of(self, other: Index) -> Self

Align the node to the middle left of the given Node.

fn top_left_of(self, other: Index) -> Self

Align the node to the top left of the given Node.

fn mid_top_of(self, other: Index) -> Self

Align the node to the middle top of the given Node.

fn top_right_of(self, other: Index) -> Self

Align the node to the top right of the given Node.

fn mid_right_of(self, other: Index) -> Self

Align the node to the middle right of the given Node.

fn bottom_right_of(self, other: Index) -> Self

Align the node to the bottom right of the given Node.

fn mid_bottom_of(self, other: Index) -> Self

Align the node to the middle bottom of the given Node.

impl<S> SetColor<ColorScalar> for Line<S>

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

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

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

Specify a color.

fn rgb(self, r: S, g: S, b: S) -> Self

Specify the color via red, green and blue channels.

fn rgba(self, r: S, g: S, b: S, a: S) -> Self

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

fn hsl(self, h: S, s: S, l: S) -> Self where     S: 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: 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: Into<RgbHue<S>>,

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

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

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

impl<S> From<Line<S>> for Primitive<S>

fn from(prim: Line<S>) -> Self

Performs the conversion.