Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • T

Hierarchy

  • ZigZagBetweenTwoWiresDto

Index

Constructors

constructor

  • new ZigZagBetweenTwoWiresDto<T>(wire1?: T, wire2?: T, nrZigZags?: number, inverse?: boolean, divideByEqualDistance?: boolean, zigZagsPerEdge?: boolean): ZigZagBetweenTwoWiresDto<T>
  • Type parameters

    • T

    Parameters

    • Optional wire1: T
    • Optional wire2: T
    • Optional nrZigZags: number
    • Optional inverse: boolean
    • Optional divideByEqualDistance: boolean
    • Optional zigZagsPerEdge: boolean

    Returns ZigZagBetweenTwoWiresDto<T>

Properties

divideByEqualDistance

divideByEqualDistance: boolean

If true, the zig zags will be spaced equally on each edge. By default we follow parametric subdivision of the edges, which is not always equal to distance based subdivisions.

default

false

inverse

inverse: boolean

Inverse the the zig zag to go from wire2 to wire1

default

false

nrZigZags

nrZigZags: number

How many zig zags to create between the two wires on each edge. The number of edges should match. Edges will be joined by zigzags in order. One zig zag means two edges forming a corner.

default

20

minimum

1

maximum

Infinity

step

1

wire1

wire1: T

The first wire for zig zag

default

undefined

wire2

wire2: T

The second wire for zig zag

default

undefined

zigZagsPerEdge

zigZagsPerEdge: boolean

By default the number of zig zags is applied to each edge. If this is set to false, the number of zig zags will be applied to the whole wire. This could then skip some corners where edges meet.

default

true

Generated using TypeDoc