Math.Geometry


Arc2D Module

Functions and values

Function or value Description

boundingBox givenArc

Full Usage: boundingBox givenArc

Parameters:
    givenArc : Arc2D<'Units, 'Coordinates>

Returns: BoundingBox2D<'Units, 'Coordinates>

Get a bounding box for a given arc.

givenArc : Arc2D<'Units, 'Coordinates>
Returns: BoundingBox2D<'Units, 'Coordinates>

centerPoint arc

Full Usage: centerPoint arc

Parameters:
    arc : Arc2D<'Units, 'Coordinates>

Returns: Point2D<'Units, 'Coordinates>
arc : Arc2D<'Units, 'Coordinates>
Returns: Point2D<'Units, 'Coordinates>

endPoint arc

Full Usage: endPoint arc

Parameters:
    arc : Arc2D<'Units, 'Coordinates>

Returns: Point2D<'Units, 'Coordinates>
arc : Arc2D<'Units, 'Coordinates>
Returns: Point2D<'Units, 'Coordinates>

firstDerivative arc parameterValue

Full Usage: firstDerivative arc parameterValue

Parameters:
    arc : Arc2D<'Units, 'Coordinates>
    parameterValue : float

Returns: Vector2D<'Units, 'Coordinates>

Get the first derivative of an arc at a given parameter value.

arc : Arc2D<'Units, 'Coordinates>
parameterValue : float
Returns: Vector2D<'Units, 'Coordinates>

from givenStartPoint givenEndPoint givenSweptAngle

Full Usage: from givenStartPoint givenEndPoint givenSweptAngle

Parameters:
    givenStartPoint : Point2D<'Units, 'Coordinates>
    givenEndPoint : Point2D<'Units, 'Coordinates>
    givenSweptAngle : Angle

Returns: Arc2D<'Units, 'Coordinates>

Construct an arc with from the first given point to the second, with the

givenStartPoint : Point2D<'Units, 'Coordinates>
givenEndPoint : Point2D<'Units, 'Coordinates>
givenSweptAngle : Angle
Returns: Arc2D<'Units, 'Coordinates>

fromNondegenerate arc

Full Usage: fromNondegenerate arc

Parameters:
Returns: Arc2D<'Units, 'Coordinates>

Convert a nondegenerate arc back to a general `Arc2d`.

arc : Nondegenerate<'Units, 'Coordinates>
Returns: Arc2D<'Units, 'Coordinates>

midpoint arc

Full Usage: midpoint arc

Parameters:
    arc : Arc2D<'Units, 'Coordinates>

Returns: Point2D<'Units, 'Coordinates>
arc : Arc2D<'Units, 'Coordinates>
Returns: Point2D<'Units, 'Coordinates>

mirrorAcross axis arc

Full Usage: mirrorAcross axis arc

Parameters:
    axis : Axis2D<'Units, 'Coordinates>
    arc : Arc2D<'Units, 'Coordinates>

Returns: Arc2D<'Units, 'Coordinates>

Mirror an arc across a given axis. This negates the sign of the arc's swept angle.

axis : Axis2D<'Units, 'Coordinates>
arc : Arc2D<'Units, 'Coordinates>
Returns: Arc2D<'Units, 'Coordinates>

nondegenerate arc

Full Usage: nondegenerate arc

Parameters:
    arc : Arc2D<'Units, 'Coordinates>

Returns: Result<Nondegenerate<'Units, 'Coordinates>, Point2D<'Units, 'Coordinates>>

Attempt to construct a non-degenerate arc from a general `Arc2d`. If the arc is in fact degenerate (consists of a single point), returns an `Err` with that point.

arc : Arc2D<'Units, 'Coordinates>
Returns: Result<Nondegenerate<'Units, 'Coordinates>, Point2D<'Units, 'Coordinates>>

placeIn frame arc

Full Usage: placeIn frame arc

Parameters:
    frame : Frame2D<'Units, 'GlobalCoordinates, 'LocalCoordinates>
    arc : Arc2D<'Units, 'LocalCoordinates>

Returns: Arc2D<'Units, 'GlobalCoordinates>

Take an arc considered to be defined in local coordinates relative to a given reference frame, and return that arc expressed in global coordinates.

frame : Frame2D<'Units, 'GlobalCoordinates, 'LocalCoordinates>
arc : Arc2D<'Units, 'LocalCoordinates>
Returns: Arc2D<'Units, 'GlobalCoordinates>

pointOn arc parameterValue

Full Usage: pointOn arc parameterValue

Parameters:
    arc : Arc2D<'Units, 'Coordinates>
    parameterValue : float

Returns: Point2D<'Units, 'Coordinates>

Get the point along an arc at a given parameter value.

arc : Arc2D<'Units, 'Coordinates>
parameterValue : float
Returns: Point2D<'Units, 'Coordinates>

radius arc

Full Usage: radius arc

Parameters:
    arc : Arc2D<'Units, 'Coordinates>

Returns: Quantity<'Units>

Get the radius of an arc.

arc : Arc2D<'Units, 'Coordinates>
Returns: Quantity<'Units>

relativeTo frame arc

Full Usage: relativeTo frame arc

Parameters:
    frame : Frame2D<'Units, 'GlobalCoordinates, 'LocalCoordinates>
    arc : Arc2D<'Units, 'GlobalCoordinates>

Returns: Arc2D<'Units, 'LocalCoordinates>

Take an arc defined in global coordinates, and return it expressed in local coordinates relative to a given reference frame.

frame : Frame2D<'Units, 'GlobalCoordinates, 'LocalCoordinates>
arc : Arc2D<'Units, 'GlobalCoordinates>
Returns: Arc2D<'Units, 'LocalCoordinates>

reverse arc

Full Usage: reverse arc

Parameters:
    arc : Arc2D<'Units, 'Coordinates>

Returns: Arc2D<'Units, 'Coordinates>

Reverse the direction of an arc, so that the start point becomes the end point and vice versa.

arc : Arc2D<'Units, 'Coordinates>
Returns: Arc2D<'Units, 'Coordinates>

rotateAround point angle arc

Full Usage: rotateAround point angle arc

Parameters:
    point : Point2D<'Units, 'Coordinates>
    angle : Angle
    arc : Arc2D<'Units, 'Coordinates>

Returns: Arc2D<'Units, 'Coordinates>

Rotate an arc around a given point by a given angle.

point : Point2D<'Units, 'Coordinates>
angle : Angle
arc : Arc2D<'Units, 'Coordinates>
Returns: Arc2D<'Units, 'Coordinates>

sample nondegenerateArc parameterValue

Full Usage: sample nondegenerateArc parameterValue

Parameters:
    nondegenerateArc : Nondegenerate<'Units, 'Coordinates>
    parameterValue : float

Returns: Point2D<'Units, 'Coordinates> * Direction2D<'Coordinates>

Get both the point and tangent direction of a nondegenerate arc at a given parameter value.

nondegenerateArc : Nondegenerate<'Units, 'Coordinates>
parameterValue : float
Returns: Point2D<'Units, 'Coordinates> * Direction2D<'Coordinates>

scaleAbout point scale arc

Full Usage: scaleAbout point scale arc

Parameters:
    point : Point2D<'Units, 'Coordinates>
    scale : float
    arc : Arc2D<'Units, 'Coordinates>

Returns: Arc2D<'Units, 'Coordinates>

Scale an arc about a given point by a given scale.

point : Point2D<'Units, 'Coordinates>
scale : float
arc : Arc2D<'Units, 'Coordinates>
Returns: Arc2D<'Units, 'Coordinates>

startPoint arc

Full Usage: startPoint arc

Parameters:
    arc : Arc2D<'Units, 'Coordinates>

Returns: Point2D<'Units, 'Coordinates>

Get the start point of an arc.

arc : Arc2D<'Units, 'Coordinates>
Returns: Point2D<'Units, 'Coordinates>

sweptAngle arc

Full Usage: sweptAngle arc

Parameters:
    arc : Arc2D<'Units, 'Coordinates>

Returns: Angle

Get the swept angle of an arc. The result will be positive for a

arc : Arc2D<'Units, 'Coordinates>
Returns: Angle

sweptAround givenCenterPoint givenSweptAngle givenStartPoint

Full Usage: sweptAround givenCenterPoint givenSweptAngle givenStartPoint

Parameters:
    givenCenterPoint : Point2D<'Units, 'Coordinates>
    givenSweptAngle : Angle
    givenStartPoint : Point2D<'Units, 'Coordinates>

Returns: Arc2D<'Units, 'Coordinates>

Construct an arc by sweeping (rotating) a given start point around a given center point by a given angle. The center point to sweep around is given first and the start point to be swept is given last. A positive swept angle means that the arc is formed by rotating the start point counterclockwise around the center point. A negative swept angle results in a clockwise arc instead.

givenCenterPoint : Point2D<'Units, 'Coordinates>
givenSweptAngle : Angle
givenStartPoint : Point2D<'Units, 'Coordinates>
Returns: Arc2D<'Units, 'Coordinates>

tangentDirection arc parameterValue

Full Usage: tangentDirection arc parameterValue

Parameters:
    arc : Nondegenerate<'Units, 'Coordinates>
    parameterValue : float

Returns: Direction2D<'Coordinates>

Get the tangent direction to a nondegenerate arc at a given parameter

arc : Nondegenerate<'Units, 'Coordinates>
parameterValue : float
Returns: Direction2D<'Coordinates>

throughPoints first second third

Full Usage: throughPoints first second third

Parameters:
    first : Point2D<'Units, 'Coordinates>
    second : Point2D<'Units, 'Coordinates>
    third : Point2D<'Units, 'Coordinates>

Returns: Arc2D<'Units, 'Coordinates> option

Attempt to construct an arc that starts at the first given point, passes through the second given point and ends at the third given point:

first : Point2D<'Units, 'Coordinates>
second : Point2D<'Units, 'Coordinates>
third : Point2D<'Units, 'Coordinates>
Returns: Arc2D<'Units, 'Coordinates> option

translateBy displacement arc

Full Usage: translateBy displacement arc

Parameters:
    displacement : Vector2D<'Units, 'Coordinates>
    arc : Arc2D<'Units, 'Coordinates>

Returns: Arc2D<'Units, 'Coordinates>

Translate an arc by a given displacement.

displacement : Vector2D<'Units, 'Coordinates>
arc : Arc2D<'Units, 'Coordinates>
Returns: Arc2D<'Units, 'Coordinates>

translateIn direction distance arc

Full Usage: translateIn direction distance arc

Parameters:
Returns: Arc2D<'Units, 'Coordinates>

Translate an arc in a given direction by a given distance.

direction : Direction2D<'Coordinates>
distance : Quantity<'Units>
arc : Arc2D<'Units, 'Coordinates>
Returns: Arc2D<'Units, 'Coordinates>

withCenterPoint centerPoint radius startAngle sweptAngle

Full Usage: withCenterPoint centerPoint radius startAngle sweptAngle

Parameters:
    centerPoint : Point2D<'Units, 'Coordinates>
    radius : Quantity<'Units>
    startAngle : Angle
    sweptAngle : Angle

Returns: Arc2D<'Units, 'Coordinates>

Construct an arc with the given center point, radius, start angle and swept

centerPoint : Point2D<'Units, 'Coordinates>
radius : Quantity<'Units>
startAngle : Angle
sweptAngle : Angle
Returns: Arc2D<'Units, 'Coordinates>

withRadius radius sweptAngle startPoint endPoint

Full Usage: withRadius radius sweptAngle startPoint endPoint

Parameters:
Returns: Arc2D<'Units, 'Coordinates> option
radius : Quantity<'Units>
sweptAngle : SweptAngle
startPoint : Point2D<'Units, 'Coordinates>
endPoint : Point2D<'Units, 'Coordinates>
Returns: Arc2D<'Units, 'Coordinates> option

withSweptAngle center radius startAngle sweptAngle

Full Usage: withSweptAngle center radius startAngle sweptAngle

Parameters:
    center : Point2D<'Units, 'Coordinates>
    radius : Quantity<'Units>
    startAngle : Angle
    sweptAngle : Angle

Returns: Arc2D<'Units, 'Coordinates>

Construct an arc with the given center point, radius, start angle and swept

center : Point2D<'Units, 'Coordinates>
radius : Quantity<'Units>
startAngle : Angle
sweptAngle : Angle
Returns: Arc2D<'Units, 'Coordinates>