Skip to content

jsl/symbols/arrows

Package name: jsl/symbols/arrows

Many symbols have arrows in them - think

potentiometer, variable inductors/transformers, LEDs, Photodiodes, etc.

This file includes functions for constructing arrows and styling them.

Summary

Data Types

ArrowStyle

Select the style of arrow to construct

Functions

Function Description
construct-arrow Helper for Constructing Arrow Shapes
ArrowSymbolParams

ArrowSymbolParams

Arrow Symbol Parameterization

Functions

Function Description
set-default-arrow-symbol-params
construct-arrow Construct a Arrow Shape from the provided specs
get-default-arrow-symbol-params
to-tuple
ArrowSymbolParams

Definitions

ArrowStyle

Select the style of arrow to construct

public defenum ArrowStyle <: Equalable & Hashable

  • ClosedArrow

  • OpenArrow

Functions

construct-arrow

Helper for Constructing Arrow Shapes

public defn construct-arrow (style:ArrowStyle = ? -- head-dims:Dims = ?, shaft-length:Double = ?, line-width:Double = ?) -> Shape

  • Returns Shape

ArrowSymbolParams

public defn ArrowSymbolParams ( -- style:ArrowStyle = ?, head-dims:Dims = ?, shaft-length:Double = ?, line-width:Double = ?) -> ArrowSymbolParams

  • Returns ArrowSymbolParams

ArrowSymbolParams

Arrow Symbol Parameterization

public defstruct ArrowSymbolParams <: Equalable :
    head-dims: Dims
    line-width: Double
    shaft-length: Double
    style: ArrowStyle

  • head-dims: Dims

  • line-width: Double

  • shaft-length: Double

  • style: ArrowStyle

Functions

set-default-arrow-symbol-params

public defn set-default-arrow-symbol-params (v:ArrowSymbolParams) -> False

  • Returns False

construct-arrow

Construct a Arrow Shape from the provided specs

public defn construct-arrow (v:ArrowSymbolParams) -> Shape

  • Returns Shape

This function constructs a Union shape that presents as an arrow. The arrow is constructed with the tip of the arrow at the origin (0,0) and the end of the arrow at shaft-length on the positive X axis. This symbol is constructed in symbol grid units.

get-default-arrow-symbol-params

public defn get-default-arrow-symbol-params () -> ArrowSymbolParams

  • Returns ArrowSymbolParams

to-tuple

public defn to-tuple (v:ArrowSymbolParams) -> [ArrowStyle, Dims, Double, Double]

  • Returns [ArrowStyle, Dims, Double, Double]

ArrowSymbolParams

public defn ArrowSymbolParams ( -- style:ArrowStyle = ?, head-dims:Dims = ?, shaft-length:Double = ?, line-width:Double = ?) -> ArrowSymbolParams

  • Returns ArrowSymbolParams

Related Packages

Forwarded by packages: jsl/symbols/framework, jsl/symbols