@bitbybit-dev/occt-worker
Version:
Bit By Bit Developers CAD algorithms using OpenCascade Technology kernel adapted for WebWorker
296 lines (295 loc) • 12.1 kB
TypeScript
import { Inputs } from "@bitbybit-dev/occt";
import { OCCTWorkerManager } from "../../occ-worker/occ-worker-manager";
export declare class OCCTOperations {
private readonly occWorkerManager;
constructor(occWorkerManager: OCCTWorkerManager);
/**
* Lofts wires into a shell
* @param inputs Loft wires
* @returns Resulting loft shape
* @group lofts
* @shortname loft
* @drawable true
*/
loft(inputs: Inputs.OCCT.LoftDto<Inputs.OCCT.TopoDSWirePointer>): Promise<Inputs.OCCT.TopoDSShapePointer>;
/**
* Lofts wires into a shell by using many advanced options
* @param inputs Advanced loft parameters
* @returns Resulting loft shell
* @group lofts
* @shortname loft adv.
* @drawable true
*/
loftAdvanced(inputs: Inputs.OCCT.LoftAdvancedDto<Inputs.OCCT.TopoDSWirePointer>): Promise<Inputs.OCCT.TopoDSShapePointer>;
/**
* Computes two closest points between two shapes
* @param inputs two shapes
* @returns Resulting points
* @group closest pts
* @shortname two shapes
* @drawable true
*/
closestPointsBetweenTwoShapes(inputs: Inputs.OCCT.ClosestPointsBetweenTwoShapesDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.Base.Point3[]>;
/**
* Computes closest points between a list of points and a given shape
* @param inputs a list of points and a shape
* @returns Resulting points
* @group closest pts
* @shortname on shape
* @drawable true
*/
closestPointsOnShapeFromPoints(inputs: Inputs.OCCT.ClosestPointsOnShapeFromPointsDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.Base.Point3[]>;
/**
* Computes closest points between a list of points and shapes
* @param inputs a list of points and a list of shapes
* @returns Resulting points
* @group closest pts
* @shortname on shapes
* @drawable true
*/
closestPointsOnShapesFromPoints(inputs: Inputs.OCCT.ClosestPointsOnShapesFromPointsDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.Base.Point3[]>;
/**
* Computes distances between a list of points and a corresponding closest points on shapes.
* @param inputs a list of points and a shapes
* @returns Resulting distances
* @group measure
* @shortname distances points to shape
* @drawable false
*/
distancesToShapeFromPoints(inputs: Inputs.OCCT.ClosestPointsOnShapeFromPointsDto<Inputs.OCCT.TopoDSShapePointer>): Promise<number[]>;
/**
* Computes bounding box parameters of the shape
* @param inputs a shape
* @returns Min, max center and size of the bounding box
* @group measure
* @shortname bbox of shape
* @drawable false
*/
boundingBoxOfShape(inputs: Inputs.OCCT.ShapeDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.OCCT.BoundingBoxPropsDto>;
/**
* Get min point of the bounding box of the shape
* @param inputs a shape
* @returns Min point of the bounding box
* @group measure
* @shortname bbox min of shape
* @drawable true
*/
boundingBoxMinOfShape(inputs: Inputs.OCCT.ShapeDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.Base.Point3>;
/**
* Get max point of the bounding box of the shape
* @param inputs a shape
* @returns Max point of the bounding box
* @group measure
* @shortname bbox max of shape
* @drawable true
*/
boundingBoxMaxOfShape(inputs: Inputs.OCCT.ShapeDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.Base.Point3>;
/**
* Get center point of the bounding box of the shape
* @param inputs a shape
* @returns Center point of the bounding box
* @group measure
* @shortname bbox center of shape
* @drawable true
*/
boundingBoxCenterOfShape(inputs: Inputs.OCCT.ShapeDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.Base.Point3>;
/**
* Get size point of the bounding box of the shape
* @param inputs a shape
* @returns Center point of the bounding box
* @group measure
* @shortname bbox size of shape
* @drawable false
*/
boundingBoxSizeOfShape(inputs: Inputs.OCCT.ShapeDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.Base.Vector3>;
/**
* Get bounding box shape of the shape
* @param inputs a shape
* @returns shape of the bounding box
* @group measure
* @shortname bbox shape of shape
* @drawable true
*/
boundingBoxShapeOfShape(inputs: Inputs.OCCT.ShapeDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.OCCT.TopoDSShapePointer>;
/**
* Computes bounding sphere parameters of the shape
* @param inputs a shape
* @returns Center and radius of the bounding sphere
* @group measure
* @shortname bsphere of shape
* @drawable false
*/
boundingSphereOfShape(inputs: Inputs.OCCT.ShapeDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.OCCT.BoundingSpherePropsDto>;
/**
* Get center point of the bounding sphere of the shape
* @param inputs a shape
* @returns Center point of the bounding sphere
* @group measure
* @shortname bsphere center of shape
* @drawable false
*/
boundingSphereCenterOfShape(inputs: Inputs.OCCT.ShapeDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.Base.Point3>;
/**
* Get radius of the bounding sphere of the shape
* @param inputs a shape
* @returns Radius of the bounding sphere
* @group measure
* @shortname bsphere radius of shape
* @drawable false
*/
boundingSphereRadiusOfShape(inputs: Inputs.OCCT.ShapeDto<Inputs.OCCT.TopoDSShapePointer>): Promise<number>;
/**
* Get bounding sphere shape of the shape
* @param inputs a shape
* @returns shape of the bounding sphere
* @group measure
* @shortname bsphere shape of shape
* @drawable true
*/
boundingSphereShapeOfShape(inputs: Inputs.OCCT.ShapeDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.OCCT.TopoDSShapePointer>;
/**
* Extrudes the shape along direction - wire will produce shell, face will produce solid
* @param inputs Shape to extrude and direction parameter with tolerance
* @returns Resulting extruded shape
* @group extrusions
* @shortname extrude
* @drawable true
*/
extrude(inputs: Inputs.OCCT.ExtrudeDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.OCCT.TopoDSShapePointer>;
/**
* Extrudes the shapes along direction
* @param inputs Shapes to extrude and direction parameter with tolerance
* @returns Resulting extruded shapes
* @group extrusions
* @shortname extrude shapes
* @drawable true
*/
extrudeShapes(inputs: Inputs.OCCT.ExtrudeShapesDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.OCCT.TopoDSShapePointer[]>;
/**
* Splits the shape with shapes
* @param inputs Shape to split and shapes to split with
* @returns Resulting shapes
* @group divisions
* @shortname split
* @drawable true
*/
splitShapeWithShapes(inputs: Inputs.OCCT.SplitDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.OCCT.TopoDSShapePointer[]>;
/**
* Revolves the shape around the given direction
* @param inputs Revolve parameters
* @returns Resulting revolved shape
* @group revolutions
* @shortname revolve
* @drawable true
*/
revolve(inputs: Inputs.OCCT.RevolveDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.OCCT.TopoDSShapePointer>;
/**
* Rotated extrude that is perofrmed on the shape
* @param inputs Rotated extrusion inputs
* @returns OpenCascade shape
* @group extrusions
* @shortname rotated extrude
* @drawable true
*/
rotatedExtrude(inputs: Inputs.OCCT.RotationExtrudeDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.OCCT.TopoDSShapePointer>;
/**
* Pipe shapes along the wire
* @param inputs Path wire and shapes along the path
* @returns OpenCascade shape
* @group pipeing
* @shortname pipe
* @drawable true
*/
pipe(inputs: Inputs.OCCT.ShapeShapesDto<Inputs.OCCT.TopoDSWirePointer, Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.OCCT.TopoDSShapePointer>;
/**
* Pipes polyline wire with ngon profile.
* @param inputs Path polyline wire
* @returns OpenCascade piped shapes
* @group pipeing
* @shortname pipe polyline ngon
* @drawable true
*/
pipePolylineWireNGon(inputs: Inputs.OCCT.PipePolygonWireNGonDto<Inputs.OCCT.TopoDSWirePointer>): Promise<Inputs.OCCT.TopoDSShapePointer>;
/**
* Pipe wires with cylindrical shape
* @param inputs Path wires and radius
* @returns OpenCascade piped shapes
* @group pipeing
* @shortname pipe wires cylindrical
* @drawable true
*/
pipeWiresCylindrical(inputs: Inputs.OCCT.PipeWiresCylindricalDto<Inputs.OCCT.TopoDSWirePointer>): Promise<Inputs.OCCT.TopoDSShapePointer[]>;
/**
* Pipe wire with cylindrical shape
* @param inputs Path wire and radius
* @returns OpenCascade piped shapes
* @group pipeing
* @shortname pipe wire cylindrical
* @drawable true
*/
pipeWireCylindrical(inputs: Inputs.OCCT.PipeWireCylindricalDto<Inputs.OCCT.TopoDSWirePointer>): Promise<Inputs.OCCT.TopoDSShapePointer>;
/**
* Offset for various shapes
* @param inputs Shape to offset and distance with tolerance
* @returns Resulting offset shape
* @group offsets
* @shortname offset
* @drawable true
*/
offset(inputs: Inputs.OCCT.OffsetDto<Inputs.OCCT.TopoDSShapePointer, Inputs.OCCT.TopoDSFacePointer>): Promise<Inputs.OCCT.TopoDSShapePointer>;
/**
* Offset advanced that give more options for offset, such as joinType for edges and corners
* @param inputs Shape to offset and advanced parameters
* @returns Resulting offset shape
* @group offsets
* @shortname offset adv.
* @drawable true
*/
offsetAdv(inputs: Inputs.OCCT.OffsetAdvancedDto<Inputs.OCCT.TopoDSShapePointer, Inputs.OCCT.TopoDSFacePointer>): Promise<Inputs.OCCT.TopoDSShapePointer>;
/**
* Thickens the shape into a solid by an offset distance
* @param inputs OpenCascade shape
* @returns OpenCascade solid shape
* @group offsets
* @shortname thicken
* @drawable true
*/
makeThickSolidSimple(inputs: Inputs.OCCT.ThisckSolidSimpleDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.OCCT.TopoDSShapePointer>;
/**
* Thickens the shape into a solid by joining
* @param inputs OpenCascade shape and options for thickening
* @returns OpenCascade solid shape
* @group offsets
* @shortname joined thicken
* @drawable true
*/
makeThickSolidByJoin(inputs: Inputs.OCCT.ThickSolidByJoinDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.OCCT.TopoDSShapePointer>;
/**
* Slices the shape
* @param inputs OpenCascade shape and options for slicing
* @returns OpenCascade shape
* @group divisions
* @shortname slice
* @drawable true
*/
slice(inputs: Inputs.OCCT.SliceDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.OCCT.TopoDSCompoundPointer>;
/**
* Slices the shape in step pattern
* @param inputs OpenCascade shape and options for slicing
* @returns OpenCascade shape
* @group divisions
* @shortname slice in step pattern
* @drawable true
*/
sliceInStepPattern(inputs: Inputs.OCCT.SliceInStepPatternDto<Inputs.OCCT.TopoDSShapePointer>): Promise<Inputs.OCCT.TopoDSCompoundPointer>;
/**
* Offset the 3D wire. When using this method consider using it on filleted wires that do not contain sharp corners.
* You can use fillet 3D on it.
* @param inputs wire and shape
* @returns OpenCascade compound
* @group offsets
* @shortname offset 3d wire
* @drawable true
*/
offset3DWire(inputs: Inputs.OCCT.Offset3DWireDto<Inputs.OCCT.TopoDSWirePointer>): Promise<Inputs.OCCT.TopoDSWirePointer>;
}