Math.Geometry


Axis2D Module

Functions and values

Function or value Description

direction axis

Full Usage: direction axis

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

Returns: Direction2D<'Coordinates>

Get the direction of the axis.

axis : Axis2D<'Units, 'Coordinates>
Returns: Direction2D<'Coordinates>

mirrorAcross otherAxis axis

Full Usage: mirrorAcross otherAxis axis

Parameters:
    otherAxis : Axis2D<'Units, 'Coordinates>
    axis : Axis2D<'Units, 'Coordinates>

Returns: Axis2D<'Units, 'Coordinates>

Mirror one axis across another. The axis to mirror across is given first and the axis to mirror is given second. Axis2D.mirrorAcross Axis2D.x exampleAxis --> Axis2D.through (Point2D.meters 1. -3.) --> (Direction2D.degrees -30.)

otherAxis : Axis2D<'Units, 'Coordinates>
axis : Axis2D<'Units, 'Coordinates>
Returns: Axis2D<'Units, 'Coordinates>

moveTo point axis

Full Usage: moveTo point axis

Parameters:
    point : Point2D<'Units, 'Coordinates>
    axis : Axis2D<'Units, 'Coordinates>

Returns: Axis2D<'Units, 'Coordinates>

Move the origin to have a different origin point but the same direction.

point : Point2D<'Units, 'Coordinates>
axis : Axis2D<'Units, 'Coordinates>
Returns: Axis2D<'Units, 'Coordinates>

originPoint axis

Full Usage: originPoint axis

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

Returns: Point2D<'Units, 'Coordinates>

Get the origin point of the axis.

axis : Axis2D<'Units, 'Coordinates>
Returns: Point2D<'Units, 'Coordinates>

placeIn frame axis

Full Usage: placeIn frame axis

Parameters:
    frame : Frame2D<'Units, 'GlobalCoordinates, 'LocalCoordinates>
    axis : Axis2D<'Units, 'LocalCoordinates>

Returns: Axis2D<'Units, 'GlobalCoordinates>

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

frame : Frame2D<'Units, 'GlobalCoordinates, 'LocalCoordinates>
axis : Axis2D<'Units, 'LocalCoordinates>
Returns: Axis2D<'Units, 'GlobalCoordinates>

relativeTo frame axis

Full Usage: relativeTo frame axis

Parameters:
    frame : Frame2D<'Units, 'GlobalCoordinates, 'LocalCoordinates>
    axis : Axis2D<'Units, 'GlobalCoordinates>

Returns: Axis2D<'Units, 'LocalCoordinates>

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

frame : Frame2D<'Units, 'GlobalCoordinates, 'LocalCoordinates>
axis : Axis2D<'Units, 'GlobalCoordinates>
Returns: Axis2D<'Units, 'LocalCoordinates>

reverse axis

Full Usage: reverse axis

Parameters:
    axis : Axis2D<'Units, 'Coordaintes>

Returns: Axis2D<'Units, 'Coordaintes>

Reverse the direction of the axis.

axis : Axis2D<'Units, 'Coordaintes>
Returns: Axis2D<'Units, 'Coordaintes>

rotateAround center angle axis

Full Usage: rotateAround center angle axis

Parameters:
    center : Point2D<'Units, 'Coordinates>
    angle : Angle
    axis : Axis2D<'Units, 'Coordinates>

Returns: Axis2D<'Units, 'Coordinates>

Rotate an axis around a given center point by a given angle. Rotates the axis' origin point around the given point by the given angle and the axis' direction by the given angle.

center : Point2D<'Units, 'Coordinates>
angle : Angle
axis : Axis2D<'Units, 'Coordinates>
Returns: Axis2D<'Units, 'Coordinates>

rotateBy angle axis

Full Usage: rotateBy angle axis

Parameters:
    angle : Angle
    axis : Axis2D<'Units, 'Coordinates>

Returns: Axis2D<'Units, 'Coordinates>

Rotate an axis around its own origin point by the given angle.

angle : Angle
axis : Axis2D<'Units, 'Coordinates>
Returns: Axis2D<'Units, 'Coordinates>

through origin direction

Full Usage: through origin direction

Parameters:
Returns: Axis2D<'Units, 'Coordinates>
origin : Point2D<'Units, 'Coordinates>
direction : Direction2D<'Coordinates>
Returns: Axis2D<'Units, 'Coordinates>

throughPoints first second

Full Usage: throughPoints first second

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

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

translateBy vector axis

Full Usage: translateBy vector axis

Parameters:
    vector : Vector2D<'Units, 'Coordinates>
    axis : Axis2D<'Units, 'Coordinates>

Returns: Axis2D<'Units, 'Coordinates>

Translate an axis by a given displacement. Applies the given displacement to the axis' origin point and leaves the direction unchanged.

vector : Vector2D<'Units, 'Coordinates>
axis : Axis2D<'Units, 'Coordinates>
Returns: Axis2D<'Units, 'Coordinates>

translateIn translationDirection distance axis

Full Usage: translateIn translationDirection distance axis

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

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

translationDirection : Direction2D<'Coordinates>
distance : Quantity<'Units>
axis : Axis2D<'Units, 'Coordinates>
Returns: Axis2D<'Units, 'Coordinates>

withDirection direction point

Full Usage: withDirection direction point

Parameters:
Returns: Axis2D<'Units, 'Coordinates>
direction : Direction2D<'Coordinates>
point : Point2D<'Units, 'Coordinates>
Returns: Axis2D<'Units, 'Coordinates>

x

Full Usage: x

Returns: Axis2D<'Units, 'Coordinates>
Returns: Axis2D<'Units, 'Coordinates>

y

Full Usage: y

Returns: Axis2D<'Units, 'Coordinates>
Returns: Axis2D<'Units, 'Coordinates>