ixfx
    Preparing search index...

    Module @ixfx/geometry - v0.43.1

    Namespaces

    Arcs

    Arcs are a angle-limited circle. Essentially describing a wedge.

    Beziers
    Circles

    A circle is defined as having a radius

    Compound
    CurveSimplification
    Ellipses
    Grids
    Layouts
    Lines
    Paths
    Points
    Polar

    Work with Polar coordinates. A Polar.Coord is just { angleRadians:number, distance: number }.

    QuadTree

    Quad tree is a datastructure for efficiently determining whether a point/shape is at a location

    Rects
    Shapes

    Generate a few basic geometric shapes Overview:

    SurfacePoints

    Functions for producing points within a shape. Useful for creating patterns.

    Triangles

    Triangle processing.

    Vectors

    Helper functions for working with vectors, which can either be a Points.Point or Polar Polar.Coord. While most of the functionality is provided in either of those modules, the Vector module lets you cleanly interoperate between these two coordinates.

    Waypoints

    Functions

    angleConvert

    Converts an angle to another representation. Input value is assumed degrees unless it's an Angle type of has the unit.

    angleParse

    Parses CSS-style angle strings. By default assumes degrees.

    degreeArc

    Computes the angle arc between a start and end angle, given in degrees. It properly accounts for the wrap-around values.

    degreesSum

    Sum angles together, accounting for the 'wrap around'.

    degreeToGradian
    degreeToRadian

    Convert angle in degrees to angle in radians.

    degreeToTurn
    gradianToDegree

    Returns the gradian value converted to degrees. By default it wraps, so any value 360 or greater wraps around.

    gradianToRadian
    radianArc

    Computes the angle arc between a start and end angle, given in radians. It properly accounts for the wrap-around values.

    radianInvert

    Inverts the angle so it points in the opposite direction of a unit circle

    radiansFromAxisX

    Angle from x-axis to point (ie. Math.atan2)

    radiansSum

    Sum angles together, accounting for the 'wrap around'.

    radianToDegree

    Convert angle in radians to angle in degrees

    radianToGradian
    radianToTurn
    scaler

    Returns a set of scaler functions, to convert to and from ranges.

    turnToDegree

    Converts 'turns' to degrees. By defaults wraps the value, so turn value of 1 or 2 equal 0deg instead of 360 or 720deg.

    turnToRadian

    Classes

    PointsTracker

    A TrackedValueMap for points. Uses PointTracker to track added values.

    PointTracker

    A tracked point. Mutable. Useful for monitoring how it changes over time. Eg. when a pointerdown event happens, to record the start position and then track the pointer as it moves until pointerup.

    Type Aliases

    Angle
    PointTrack

    Information about seen points

    PointTrackerResults

    Results of point tracking

    ScaleBy
    Scaler

    A scale function that takes an input value to scale. Input can be in the form of { x, y } or two number parameters.

    ScalerCombined

    A scaler than can convert to a from an output range