Struct nannou::draw::primitive::arrow::Arrow

pub struct Arrow<S = Default> { /* fields omitted */ }

A path containing only two points - a start and end.

A triangle is drawn on the end to indicate direction.

Methods

impl<S> Arrow<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 start(self, start: Point2<S>) -> Self

Specify the start point of the arrow.

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

Specify the end point of the arrow.

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

Specify the start and end points of the arrow.

pub fn head_length(self, length: S) -> Self

The length of the arrow head.

By default, this is equal to weight * 4.0.

This value will be clamped to the length of the line itself.

pub fn head_width(self, width: S) -> Self

The width of the arrow head.

By default, this is equal to weight * 2.0.

Trait Implementations

impl<S: Clone> Clone for Arrow<S>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Arrow<S>

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

Formats the value using the given formatter.

impl<S> Default for Arrow<S> where
    S: Zero, 

fn default() -> Self

Returns the "default value" for a type.

impl<S> From<Arrow<S>> for Primitive<S>

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

Performs the conversion.

impl RenderPrimitive for Arrow<f32>

fn render_primitive(
    self,
    ctxt: RenderContext,
    mesh: &mut Mesh
) -> PrimitiveRender

Render self into the given mesh.

impl<S> SetColor<f32> for Arrow<S>

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<S> SetOrientation<S> for Arrow<S>

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

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

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

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

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

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

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

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

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

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 degrees.

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

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

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

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

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 where
    S: BaseFloat, 

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 pitch(self, pitch: S) -> Self where
    S: BaseFloat, 

Specify the "pitch" of the orientation in radians.

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

Specify the "yaw" of the orientation in radians.

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

Specify the "roll" of the orientation in radians.

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

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 Arrow<S>

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

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

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, z: 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.

impl<S> SetStroke for Arrow<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.