@bitbybit-dev/base
Version:
Bit By Bit Developers Base CAD Library to Program Geometry
207 lines (206 loc) • 5.69 kB
TypeScript
import { Base } from "./base-inputs";
export declare namespace Polyline {
class PolylineCreateDto {
/**
* Provide options without default values
*/
constructor(points?: Base.Point3[], isClosed?: boolean);
/**
* Points of the polyline
* @default undefined
*/
points?: Base.Point3[];
/**
* Can contain is closed information
* @default false
*/
isClosed?: boolean;
}
class PolylinePropertiesDto {
/**
* Provide options without default values
*/
constructor(points?: Base.Point3[], isClosed?: boolean);
/**
* Points of the polyline
* @default undefined
*/
points?: Base.Point3[];
/**
* Can contain is closed information
* @default false
*/
isClosed?: boolean;
/**
* Optional polyline color
* @default #444444
*/
color?: string | number[];
}
class PolylineDto {
constructor(polyline?: PolylinePropertiesDto);
/**
* Polyline with points
* @default undefined
*/
polyline?: PolylinePropertiesDto;
}
class PolylinesDto {
constructor(polylines?: PolylinePropertiesDto[]);
/**
* Polylines array
* @default undefined
*/
polylines?: PolylinePropertiesDto[];
}
class TransformPolylineDto {
constructor(polyline?: PolylinePropertiesDto, transformation?: Base.TransformMatrixes);
/**
* Polyline to transform
* @default undefined
*/
polyline?: PolylinePropertiesDto;
/**
* Transformation matrix or a list of transformation matrixes
* @default undefined
*/
transformation?: Base.TransformMatrixes;
}
class DrawPolylineDto<T> {
/**
* Provide options without default values
*/
constructor(polyline?: PolylinePropertiesDto, opacity?: number, colours?: string | string[], size?: number, updatable?: boolean, polylineMesh?: T);
/**
* Polyline
* @default undefined
*/
polyline?: PolylinePropertiesDto;
/**
* 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 polyline
* @default 3
* @minimum 0
* @maximum Infinity
* @step 0.1
*/
size?: number;
/**
* Indicates wether the position of this polyline will change in time
* @default false
*/
updatable?: boolean;
/**
* Line mesh variable in case it already exists and needs updating
* @default undefined
*/
polylineMesh?: T;
}
class DrawPolylinesDto<T> {
/**
* Provide options without default values
*/
constructor(polylines?: PolylinePropertiesDto[], opacity?: number, colours?: string | string[], size?: number, updatable?: boolean, polylinesMesh?: T);
/**
* Polylines
* @default undefined
*/
polylines?: PolylinePropertiesDto[];
/**
* 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 polyline
* @default 3
* @minimum 0
* @maximum Infinity
* @step 0.1
*/
size?: number;
/**
* Indicates wether the position of this polyline will change in time
* @default false
*/
updatable?: boolean;
/**
* Polyline mesh variable in case it already exists and needs updating
* @default undefined
*/
polylinesMesh?: T;
}
class SegmentsToleranceDto {
constructor(segments?: Base.Segment3[]);
/**
* Segments array
* @default undefined
*/
segments?: Base.Segment3[];
/**
* Tolerance for the calculation
* @default 1e-5
* @minimum -Infinity
* @maximum Infinity
* @step 1e-5
*/
tolerance?: number;
}
class PolylineToleranceDto {
constructor(polyline?: PolylinePropertiesDto, tolerance?: number);
/**
* Polyline to check
* @default undefined
*/
polyline?: PolylinePropertiesDto;
/**
* Tolerance for the calculation
* @default 1e-5
* @minimum -Infinity
* @maximum Infinity
* @step 1e-5
*/
tolerance?: number;
}
class TwoPolylinesToleranceDto {
constructor(polyline1?: PolylinePropertiesDto, polyline2?: PolylinePropertiesDto, tolerance?: number);
/**
* First polyline to check
* @default undefined
*/
polyline1?: PolylinePropertiesDto;
/**
* Second polyline to check
* @default undefined
*/
polyline2?: PolylinePropertiesDto;
/**
* Tolerance for the calculation
* @default 1e-5
* @minimum -Infinity
* @maximum Infinity
* @step 1e-5
*/
tolerance?: number;
}
}