Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Point

Index

Constructors

constructor

Methods

averagePoint

  • Get average point of points

    group

    extract

    shortname

    average point

    drawable

    true

    Parameters

    Returns Point3

    point

boundingBoxOfPoints

  • Gets a bounding box of the points

    group

    extract

    shortname

    bounding box pts

    drawable

    true

    Parameters

    Returns BoundingBox

    Bounding box of points

closestPointFromPoints

  • Finds the closest point in a collection

    group

    extract

    shortname

    closest pt

    drawable

    true

    Parameters

    Returns Point3

    Closest point

closestPointFromPointsDistance

  • Measures the closest distance between a point and a collection of points

    group

    extract

    shortname

    distance to closest pt

    drawable

    false

    Parameters

    Returns number

    Distance to closest point

closestPointFromPointsIndex

  • Finds the closest point index between a point and a collection of points. Caution, index is not 0 based, it starts with 1.

    group

    extract

    shortname

    index of closest pt

    drawable

    false

    Parameters

    Returns number

    Closest point index

distance

  • Finds the distance between two points

    group

    measure

    shortname

    distance

    drawable

    false

    Parameters

    Returns number

    Distance

distancesToPoints

  • Finds the distances between the start point and multiple end points

    group

    measure

    shortname

    distances to points

    drawable

    false

    Parameters

    Returns number[]

    Distances

getX

  • Get x coordinate of the point

    group

    get

    shortname

    x coord

    drawable

    false

    Parameters

    Returns number

    X coordinate

getY

  • Get y coordinate of the point

    group

    get

    shortname

    y coord

    drawable

    false

    Parameters

    Returns number

    Y coordinate

getZ

  • Get z coordinate of the point

    group

    get

    shortname

    z coord

    drawable

    false

    Parameters

    Returns number

    Z coordinate

hexGrid

  • Creates a flat point grid on XY plane. This grid contains center points for hexagons of the given radius. Be aware that we control only the nr of hexagons to be made and not the length and width of the grid.

    group

    create

    shortname

    hex grid

    drawable

    true

    Parameters

    Returns Point3[]

    Points in the array on the grid

hexGridScaledToFit

  • Creates a pointy-top or flat-top hexagon grid, scaling hexagons to fit specified dimensions exactly. Returns both center points and the vertices of each (potentially scaled) hexagon. Hexagons are ordered column-first, then row-first.

    group

    create

    shortname

    scaled hex grid to fit

    drawable

    false

    Parameters

    Returns HexGridData

    An object containing the array of center points and an array of hexagon vertex arrays.

maxFilletRadius

  • Calculates the maximum possible fillet radius at a corner formed by two line segments sharing an endpoint (C), such that the fillet arc is tangent to both segments and lies entirely within them.

    group

    fillet

    shortname

    max fillet radius

    drawable

    false

    Parameters

    Returns number

    the maximum fillet radius

maxFilletRadiusHalfLine

  • Calculates the maximum possible fillet radius at a corner C, such that the fillet arc is tangent to both segments (P1-C, P2-C) and the tangent points lie within the first half of each segment (measured from C).

    group

    fillet

    shortname

    max fillet radius half line

    drawable

    false

    Parameters

    Returns number

    the maximum fillet radius

maxFilletsHalfLine

  • Calculates the maximum possible fillet radius at each corner of a polyline formed by formed by a series of points. The fillet radius is calculated for each internal corner and optionally for the closing corners if the polyline is closed.

    group

    fillet

    shortname

    max fillets half line

    drawable

    false

    Parameters

    Returns number[]

    Array of maximum fillet radii for each corner

multiplyPoint

  • Multiply point by a specified amount

    group

    transforms

    shortname

    multiply point

    drawable

    true

    Parameters

    • inputs: MultiplyPointDto

      The point to be multiplied and the amount of points to create

    Returns Point3[]

    Distance

normalFromThreePoints

  • Creates a normal vector from 3 points

    group

    create

    shortname

    normal from 3 points

    drawable

    true

    Parameters

    Returns Vector3

    Normal vector

pointXY

  • Creates the xy point

    group

    create

    shortname

    point xy

    drawable

    false

    Parameters

    Returns Point2

    point 3d

pointXYZ

  • Creates the xyz point

    group

    create

    shortname

    point xyz

    drawable

    true

    Parameters

    Returns Point3

    point 3d

removeConsecutiveDuplicates

  • Removes consecutive duplicates from the point array with tolerance

    group

    clean

    shortname

    remove duplicates

    drawable

    true

    Parameters

    Returns Point3[]

    Points in the array without consecutive duplicates

rotatePointsCenterAxis

  • Rotate multiple points by providing center point, axis and degrees of rotation

    group

    transforms

    shortname

    rotate points center axis

    drawable

    true

    Parameters

    Returns Point3[]

    Rotated points

safestPointsMaxFilletHalfLine

  • Calculates the single safest maximum fillet radius that can be applied uniformly to all corners of collection of points, based on the 'half-line' constraint. This is determined by finding the minimum of the maximum possible fillet radii calculated for each individual corner.

    group

    fillet

    shortname

    safest fillet radii points

    drawable

    false

    Parameters

    Returns number

    The smallest value from the results of pointsMaxFilletsHalfLine. Returns 0 if the polyline has fewer than 3 points or if any calculated maximum radius is 0.

scalePointsCenterXYZ

  • Scale multiple points by providing center point and x, y, z scale factors

    group

    transforms

    shortname

    scale points on center

    drawable

    true

    Parameters

    Returns Point3[]

    Scaled points

sortPoints

  • Sorts points lexicographically (X, then Y, then Z)

    group

    sort

    shortname

    sort points

    drawable

    true

    Parameters

    Returns Point3[]

    sorted points

spiral

  • Creates the spiral out of multiple points

    group

    create

    shortname

    spiral

    drawable

    true

    Parameters

    Returns Point3[]

    Specified number of points in the array along the spiral

stretchPointsDirFromCenter

  • Stretch multiple points by providing center point, direction and uniform scale factor

    group

    transforms

    shortname

    stretch points dir from center

    drawable

    true

    Parameters

    Returns Point3[]

    Stretched points

transformPoint

  • Transforms the single point

    group

    transforms

    shortname

    transform point

    drawable

    true

    Parameters

    Returns Point3

    Transformed point

transformPoints

  • Transforms multiple points

    group

    transforms

    shortname

    transform points

    drawable

    true

    Parameters

    Returns Point3[]

    Transformed points

transformsForPoints

  • Transforms multiple points by multiple transformations

    group

    transforms

    shortname

    transforms for points

    drawable

    true

    Parameters

    Returns Point3[]

    Transformed points

translatePoints

  • Translate multiple points

    group

    transforms

    shortname

    translate points

    drawable

    true

    Parameters

    Returns Point3[]

    Translated points

translatePointsWithVectors

  • Translate multiple points

    group

    transforms

    shortname

    translate points with vectors

    drawable

    true

    Parameters

    Returns Point3[]

    Translated points

translateXYZPoints

  • Translate multiple points by x, y, z values provided

    group

    transforms

    shortname

    translate xyz points

    drawable

    true

    Parameters

    Returns Point3[]

    Translated points

twoPointsAlmostEqual

  • Checks if two points are almost equal

    group

    measure

    shortname

    two points almost equal

    drawable

    false

    Parameters

    Returns boolean

    true if the points are almost equal

Generated using TypeDoc