@bitbybit-dev/base
Version:
Bit By Bit Developers Base CAD Library to Program Geometry
241 lines (240 loc) • 6.33 kB
TypeScript
import { Base } from "./base-inputs";
export declare namespace Line {
class LinePointsDto {
/**
* Provide options without default values
*/
constructor(start?: Base.Point3, end?: Base.Point3);
/**
* Start point
* @default undefined
*/
start?: Base.Point3;
/**
* End point
* @default undefined
*/
end?: Base.Point3;
}
class LineStartEndPointsDto {
/**
* Provide options without default values
*/
constructor(startPoints?: Base.Point3[], endPoints?: Base.Point3[]);
/**
* Start points
* @default undefined
*/
startPoints: Base.Point3[];
/**
* End points
* @default undefined
*/
endPoints: Base.Point3[];
}
class DrawLineDto<T> {
/**
* Provide options without default values
*/
constructor(line?: LinePointsDto, opacity?: number, colours?: string | string[], size?: number, updatable?: boolean, lineMesh?: T);
/**
* Line
* @default undefined
*/
line?: LinePointsDto;
/**
* Value between 0 and 1
* @default 1
* @minimum 0
* @maximum 1
* @step 0.1
*/
opacity?: number;
/**
* Hex colour string
* @default #444444
*/
colours?: string | string[];
/**
* Width of the line
* @default 3
* @minimum 0
* @maximum Infinity
* @step 0.1
*/
size?: number;
/**
* Indicates wether the position of this line will change in time
* @default false
*/
updatable?: boolean;
/**
* Line mesh variable in case it already exists and needs updating
* @default undefined
*/
lineMesh?: T;
}
class DrawLinesDto<T> {
/**
* Provide options without default values
*/
constructor(lines?: LinePointsDto[], opacity?: number, colours?: string | string[], size?: number, updatable?: boolean, linesMesh?: T);
/**
* Lines
* @default undefined
*/
lines?: LinePointsDto[];
/**
* Value between 0 and 1
* @default 1
* @minimum 0
* @maximum 1
* @step 0.1
*/
opacity?: number;
/**
* Hex colour string
* @default #444444
*/
colours?: string | string[];
/**
* Width of the line
* @default 3
* @minimum 0
* @maximum Infinity
* @step 0.1
*/
size?: number;
/**
* Indicates wether the position of these lines will change in time
* @default false
*/
updatable?: boolean;
/**
* Line mesh variable in case it already exists and needs updating
* @default undefined
*/
linesMesh?: T;
}
class PointsLinesDto {
constructor(points?: Base.Point3[]);
/**
* Points
* @default undefined
*/
points?: Base.Point3[];
}
class LineDto {
constructor(line?: LinePointsDto);
/**
* Line to convert
* @default undefined
*/
line?: LinePointsDto;
}
class SegmentDto {
constructor(segment?: Base.Segment3);
/**
* Segment
* @default undefined
*/
segment?: Base.Segment3;
}
class SegmentsDto {
constructor(segments?: Base.Segment3[]);
/**
* Segments
* @default undefined
*/
segments?: Base.Segment3[];
}
class LinesDto {
constructor(lines?: LinePointsDto[]);
/**
* Lines to convert
* @default undefined
*/
lines?: LinePointsDto[];
}
class LineLineIntersectionDto {
constructor(line1?: LinePointsDto, line2?: LinePointsDto, tolerance?: number);
/**
* First line
* @default undefined
*/
line1?: LinePointsDto;
/**
* Second line
* @default undefined
*/
line2?: LinePointsDto;
/**
* Set to false if you want to check for infinite lines
* @default true
*/
checkSegmentsOnly?: boolean;
/**
* Tolerance for intersection
* @default 0.01
* @minimum 0
* @maximum Infinity
* @step 0.1
*/
tolerance?: number;
}
class PointOnLineDto {
constructor(line?: LinePointsDto, param?: number);
/**
* Line to get point on
* @default undefined
*/
line?: LinePointsDto;
/**
* Param to use for point on line
* @default 0.5
* @minimum -Infinity
* @maximum Infinity
* @step 0.1
*/
param?: number;
}
class TransformLineDto {
constructor(line?: LinePointsDto, transformation?: Base.TransformMatrixes);
/**
* Line to transform
* @default undefined
*/
line?: LinePointsDto;
/**
* Transformation matrix or a list of transformation matrixes
* @default undefined
*/
transformation?: Base.TransformMatrixes;
}
class TransformsLinesDto {
constructor(lines?: LinePointsDto[], transformation?: Base.TransformMatrixes[]);
/**
* Lines to transform
* @default undefined
*/
lines?: LinePointsDto[];
/**
* Transformations matrix or a list of transformations matrixes
* @default undefined
*/
transformation?: Base.TransformMatrixes[];
}
class TransformLinesDto {
constructor(lines?: LinePointsDto[], transformation?: Base.TransformMatrixes);
/**
* Lines to transform
* @default undefined
*/
lines?: LinePointsDto[];
/**
* Transformation matrix or a list of transformation matrixes
* @default undefined
*/
transformation?: Base.TransformMatrixes;
}
}