Math.Geometry


Polyline2D Module

Functions and values

Function or value Description

boundingBox polyline

Full Usage: boundingBox polyline

Parameters:
Returns: BoundingBox2D<'Units, 'Coordinates> option
polyline : Polyline2D<'Units, 'Coordinates>
Returns: BoundingBox2D<'Units, 'Coordinates> option

centroid polyline

Full Usage: centroid polyline

Parameters:
Returns: Point2D<'Units, 'Coordinates> option
polyline : Polyline2D<'Units, 'Coordinates>
Returns: Point2D<'Units, 'Coordinates> option

fromVertices vertices

Full Usage: fromVertices vertices

Parameters:
    vertices : Point2D<'Units, 'Coordinates> list

Returns: Polyline2D<'Units, 'Coordinates>
vertices : Point2D<'Units, 'Coordinates> list
Returns: Polyline2D<'Units, 'Coordinates>

length polyline

Full Usage: length polyline

Parameters:
Returns: Quantity<'Units>
polyline : Polyline2D<'Units, 'Coordinates>
Returns: Quantity<'Units>

mapVertices f polyline

Full Usage: mapVertices f polyline

Parameters:
Returns: Polyline2D<'Units, 'Coordinates2>
f : Point2D<'Units, 'Coordinates1> -> Point2D<'Units, 'Coordinates2>
polyline : Polyline2D<'Units, 'Coordinates1>
Returns: Polyline2D<'Units, 'Coordinates2>

mirrorAcross axis polyline

Full Usage: mirrorAcross axis polyline

Parameters:
    axis : Axis2D<'Units, 'Coordinates>
    polyline : Polyline2D<'Units, 'Coordinates>

Returns: Polyline2D<'Units, 'Coordinates>
axis : Axis2D<'Units, 'Coordinates>
polyline : Polyline2D<'Units, 'Coordinates>
Returns: Polyline2D<'Units, 'Coordinates>

placeIn frame polyline

Full Usage: placeIn frame polyline

Parameters:
    frame : Frame2D<'Units, 'GlobalCoordinates, 'LocalCoordinates>
    polyline : Polyline2D<'Units, 'LocalCoordinates>

Returns: Polyline2D<'Units, 'GlobalCoordinates>
frame : Frame2D<'Units, 'GlobalCoordinates, 'LocalCoordinates>
polyline : Polyline2D<'Units, 'LocalCoordinates>
Returns: Polyline2D<'Units, 'GlobalCoordinates>

projectOnto axis polyline

Full Usage: projectOnto axis polyline

Parameters:
    axis : Axis2D<'Units, 'Coordinates>
    polyline : Polyline2D<'Units, 'Coordinates>

Returns: Polyline2D<'Units, 'Coordinates>
axis : Axis2D<'Units, 'Coordinates>
polyline : Polyline2D<'Units, 'Coordinates>
Returns: Polyline2D<'Units, 'Coordinates>

relativeTo frame polyline

Full Usage: relativeTo frame polyline

Parameters:
    frame : Frame2D<'Units, 'GlobalCoordinates, 'LocalCoordinates>
    polyline : Polyline2D<'Units, 'GlobalCoordinates>

Returns: Polyline2D<'Units, 'LocalCoordinates>
frame : Frame2D<'Units, 'GlobalCoordinates, 'LocalCoordinates>
polyline : Polyline2D<'Units, 'GlobalCoordinates>
Returns: Polyline2D<'Units, 'LocalCoordinates>

rotateAround point angle polyline

Full Usage: rotateAround point angle polyline

Parameters:
    point : Point2D<'Units, 'Coordinates>
    angle : Angle
    polyline : Polyline2D<'Units, 'Coordinates>

Returns: Polyline2D<'Units, 'Coordinates>
point : Point2D<'Units, 'Coordinates>
angle : Angle
polyline : Polyline2D<'Units, 'Coordinates>
Returns: Polyline2D<'Units, 'Coordinates>

scaleAbout point scale polyline

Full Usage: scaleAbout point scale polyline

Parameters:
    point : Point2D<'Units, 'Coordinates>
    scale : float
    polyline : Polyline2D<'Units, 'Coordinates>

Returns: Polyline2D<'Units, 'Coordinates>
point : Point2D<'Units, 'Coordinates>
scale : float
polyline : Polyline2D<'Units, 'Coordinates>
Returns: Polyline2D<'Units, 'Coordinates>

segments polyline

Full Usage: segments polyline

Parameters:
Returns: LineSegment2D<'Units, 'Coordinates> list
polyline : Polyline2D<'Units, 'Coordinates>
Returns: LineSegment2D<'Units, 'Coordinates> list

translateBy vector polyline

Full Usage: translateBy vector polyline

Parameters:
Returns: Polyline2D<'Units, 'Coordinates>
vector : Vector2D<'Units, 'Coordinates>
polyline : Polyline2D<'Units, 'Coordinates>
Returns: Polyline2D<'Units, 'Coordinates>

translateIn direction distance polyline

Full Usage: translateIn direction distance polyline

Parameters:
Returns: Polyline2D<'Units, 'Coordinates>
direction : Direction2D<'Coordinates>
distance : Quantity<'Units>
polyline : Polyline2D<'Units, 'Coordinates>
Returns: Polyline2D<'Units, 'Coordinates>

vertices polyline

Full Usage: vertices polyline

Parameters:
Returns: Point2D<'Units, 'Coordinates> list
polyline : Polyline2D<'Units, 'Coordinates>
Returns: Point2D<'Units, 'Coordinates> list