Enum PathSegment

pub enum PathSegment {
    Line {
        end: Point3d<LengthUnit>,
        relative: bool,
    },
    Arc {
        center: Point2d<LengthUnit>,
        radius: LengthUnit,
        start: Angle,
        end: Angle,
        relative: bool,
    },
    Bezier {
        control1: Point3d<LengthUnit>,
        control2: Point3d<LengthUnit>,
        end: Point3d<LengthUnit>,
        relative: bool,
    },
    TangentialArc {
        radius: LengthUnit,
        offset: Angle,
    },
    TangentialArcTo {
        to: Point3d<LengthUnit>,
        angle_snap_increment: Option<Angle>,
    },
    ArcTo {
        interior: Point3d<LengthUnit>,
        end: Point3d<LengthUnit>,
        relative: bool,
    },
    CircularInvolute {
        start_radius: LengthUnit,
        end_radius: LengthUnit,
        angle: Angle,
        reverse: bool,
    },
}

A segment of a path. Paths are composed of many segments.

Variants

Line

A straight line segment. Goes from the current path “pen” to the given endpoint.

Fields

end: Point3d<LengthUnit>

End point of the line.

relative: bool

Whether or not this line is a relative offset

Arc

A circular arc segment. Arcs can be drawn clockwise when start > end.

Fields

center: Point2d<LengthUnit>

Center of the circle

radius: LengthUnit

Radius of the circle

start: Angle

Start of the arc along circle’s perimeter.

end: Angle

End of the arc along circle’s perimeter.

relative: bool

Whether or not this arc is a relative offset

Bezier

A cubic bezier curve segment. Start at the end of the current line, go through control point 1 and 2, then end at a given point.

Fields

control1: Point3d<LengthUnit>

First control point.

control2: Point3d<LengthUnit>

Second control point.

end: Point3d<LengthUnit>

Final control point.

relative: bool

Whether or not this bezier is a relative offset

TangentialArc

Adds a tangent arc from current pen position with the given radius and angle.

Fields

radius: LengthUnit

Radius of the arc. Not to be confused with Raiders of the Lost Ark.

offset: Angle

Offset of the arc. Negative values will arc clockwise.

TangentialArcTo

Adds a tangent arc from current pen position to the new position. Arcs will choose a clockwise or counter-clockwise direction based on the arc end position.

Fields

to: Point3d<LengthUnit>

Where the arc should end. Must lie in the same plane as the current path pen position. Must not be colinear with current path pen position.

angle_snap_increment: Option<Angle>

0 will be interpreted as none/null.

ArcTo

Adds an arc from the current position that goes through the given interior point and ends at the given end position

Fields

interior: Point3d<LengthUnit>

Interior point of the arc.

end: Point3d<LengthUnit>

End point of the arc.

relative: bool

Whether or not interior and end are relative to the previous path position

CircularInvolute

Adds a circular involute from the current position that goes through the given end_radius and is rotated around the current point by angle.

Fields

start_radius: LengthUnit

The involute is described between two circles, start_radius is the radius of the inner circle.

end_radius: LengthUnit

The involute is described between two circles, end_radius is the radius of the outer circle.

angle: Angle

The angle to rotate the involute by. A value of zero will produce a curve with a tangent along the x-axis at the start point of the curve.

reverse: bool

If reverse is true, the segment will start from the end of the involute, otherwise it will start from that start.

Trait Implementations

impl Clone for PathSegment

fn clone(&self) -> PathSegment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathSegment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PathSegment

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PathSegment

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for PathSegment

fn eq(&self, other: &PathSegment) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PathSegment

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for PathSegment

type WithoutGenerics = PathSegment

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = PathSegment

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.

impl Copy for PathSegment

impl StructuralPartialEq for PathSegment