Class Point

Hierarchy

Point

Index

Constructors

constructor

Methods

Constructors

constructor

new Point(context: Context, geometryHelper: GeometryHelper, line: Line): Point

- Defined in bitbybit-docs.d.ts:20355
Parameters
- context: Context
- geometryHelper: GeometryHelper
- line: Line
Returns Point

Methods

averagePoint

averagePoint(inputs: PointsDto): Point3

- Defined in bitbybit-docs.d.ts:20502
Get average point of points

group

extract

shortname

average point

drawable

true

Parameters
- inputs: PointsDto
  
  The points
Returns Point3

point

closestPointFromPoints

closestPointFromPoints(inputs: ClosestPointFromPointsDto): Point3

- Defined in bitbybit-docs.d.ts:20439
Finds the closest point in a collection

group

extract

shortname

closest pt

drawable

true

Parameters
- inputs: ClosestPointFromPointsDto
  
  Point and points collection to find the closest point in
Returns Point3

Closest point

closestPointFromPointsDistance

closestPointFromPointsDistance(inputs: ClosestPointFromPointsDto): number

- Defined in bitbybit-docs.d.ts:20421
Measures the closest distance between a point and a collection of points

group

extract

shortname

distance to closest pt

drawable

false

Parameters
- inputs: ClosestPointFromPointsDto
  
  Point from which to measure and points to measure the distance against
Returns number

Distance to closest point

closestPointFromPointsIndex

closestPointFromPointsIndex(inputs: ClosestPointFromPointsDto): number

- Defined in bitbybit-docs.d.ts:20430
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
- inputs: ClosestPointFromPointsDto
  
  Point from which to find the index in a collection of points
Returns number

Closest point index

distance

distance(inputs: StartEndPointsDto): number

- Defined in bitbybit-docs.d.ts:20448
Finds the distance between two points

group

measure

shortname

distance

drawable

false

Parameters
- inputs: StartEndPointsDto
  
  Coordinates of start and end points
Returns number

Distance

distancesToPoints

distancesToPoints(inputs: StartEndPointsListDto): number[]

- Defined in bitbybit-docs.d.ts:20457
Finds the distances between the start point and multiple end points

group

measure

shortname

distances to points

drawable

false

Parameters
- inputs: StartEndPointsListDto
  
  Coordinates of start and end points
Returns number[]

Distances

getX

getX(inputs: PointDto): number

- Defined in bitbybit-docs.d.ts:20475
Get x coordinate of the point

group

get

shortname

x coord

drawable

false

Parameters
- inputs: PointDto
  
  The point
Returns number

X coordinate

getY

getY(inputs: PointDto): number

- Defined in bitbybit-docs.d.ts:20484
Get y coordinate of the point

group

get

shortname

y coord

drawable

false

Parameters
- inputs: PointDto
  
  The point
Returns number

Y coordinate

getZ

getZ(inputs: PointDto): number

- Defined in bitbybit-docs.d.ts:20493
Get z coordinate of the point

group

get

shortname

z coord

drawable

false

Parameters
- inputs: PointDto
  
  The point
Returns number

Z coordinate

hexGrid

hexGrid(inputs: HexGridCentersDto): Point3[]

- Defined in bitbybit-docs.d.ts:20539
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
- inputs: HexGridCentersDto
  
  Information about hexagon and the grid
Returns Point3[]

Points in the array on the grid

multiplyPoint

multiplyPoint(inputs: MultiplyPointDto): Point3[]

- Defined in bitbybit-docs.d.ts:20466
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

pointXY

pointXY(inputs: PointXYDto): Point2

- Defined in bitbybit-docs.d.ts:20520
Creates the xy point

group

create

shortname

point xy

drawable

false

Parameters
- inputs: PointXYDto
  
  xy information
Returns Point2

point 3d

pointXYZ

pointXYZ(inputs: PointXYZDto): Point3

- Defined in bitbybit-docs.d.ts:20511
Creates the xyz point

group

create

shortname

point xyz

drawable

true

Parameters
- inputs: PointXYZDto
  
  xyz information
Returns Point3

point 3d

spiral

spiral(inputs: SpiralDto): Point3[]

- Defined in bitbybit-docs.d.ts:20529
Creates the spiral out of multiple points

group

create

shortname

spiral

drawable

true

Parameters
- inputs: SpiralDto
  
  Spiral information
Returns Point3[]

Specified number of points in the array along the spiral

transformPoint

transformPoint(inputs: TransformPointDto): Point3

- Defined in bitbybit-docs.d.ts:20394
Transforms the single point

group

transforms

shortname

transform point

drawable

true

Parameters
- inputs: TransformPointDto
  
  Contains a point and the transformations to apply
Returns Point3

Transformed point

transformPoints

transformPoints(inputs: TransformPointsDto): Point3[]

- Defined in bitbybit-docs.d.ts:20403
Transforms multiple points

group

transforms

shortname

transform points

drawable

true

Parameters
- inputs: TransformPointsDto
  
  Contains points and the transformations to apply
Returns Point3[]

Transformed points

transformsForPoints

transformsForPoints(inputs: TransformsForPointsDto): Point3[]

- Defined in bitbybit-docs.d.ts:20412
Transforms multiple points by multiple transformations

group

transforms

shortname

transforms for points

drawable

true

Parameters
- inputs: TransformsForPointsDto
  
  Contains points and the transformations to apply
Returns Point3[]

Transformed points

Generated using TypeDoc