Class: Solid
Defined in: packages/replicad/src/shapes.ts:936
Extends
_3DShape<TopoDS_Solid>
Constructors
Constructor
new Solid(ocShape): Solid;
Defined in: packages/replicad/src/shapes.ts:189
Parameters
ocShape
TopoDS_Solid
Returns
Solid
Inherited from
Other
boundingBox
Get Signature
get boundingBox(): BoundingBox;
Defined in: packages/replicad/src/shapes.ts:408
Returns
Inherited from
edges
Get Signature
get edges(): Edge[];
Defined in: packages/replicad/src/shapes.ts:389
Returns
Edge[]
Inherited from
faces
Get Signature
get faces(): Face[];
Defined in: packages/replicad/src/shapes.ts:393
Returns
Face[]
Inherited from
hashCode
Get Signature
get hashCode(): number;
Defined in: packages/replicad/src/shapes.ts:201
Returns
number
Inherited from
isNull
Get Signature
get isNull(): boolean;
Defined in: packages/replicad/src/shapes.ts:205
Returns
boolean
Inherited from
solids
Get Signature
get solids(): Solid[];
Defined in: packages/replicad/src/shapes.ts:397
Returns
Solid[]
Inherited from
wires
Get Signature
get wires(): Wire[];
Defined in: packages/replicad/src/shapes.ts:404
Returns
Wire[]
Inherited from
wrapped
Get Signature
get wrapped(): Type;
Defined in: packages/replicad/src/register.ts:41
Returns
Type
Set Signature
set wrapped(newWrapped): void;
Defined in: packages/replicad/src/register.ts:46
Parameters
newWrapped
Type
Returns
void
Inherited from
[dispose]()
dispose: void;
Defined in: node_modules/typescript/lib/lib.esnext.disposable.d.ts:36
Returns
void
Inherited from
asShape3D()
asShape3D(): Shape3D;
Defined in: packages/replicad/src/shapes.ts:260
Asserts that this shape is a 3D shape (Shell, Solid, CompSolid, or Compound) and returns it typed as Shape3D. Throws if the shape is not 3D.
Useful for chaining after operations that return a generic shape type.
Returns
Inherited from
clone()
clone(): this;
Defined in: packages/replicad/src/shapes.ts:193
Returns
this
Inherited from
delete()
delete(): void;
Defined in: packages/replicad/src/register.ts:58
Returns
void
Inherited from
isEqual()
isEqual(other): boolean;
Defined in: packages/replicad/src/shapes.ts:213
Parameters
other
Returns
boolean
Inherited from
isSame()
isSame(other): boolean;
Defined in: packages/replicad/src/shapes.ts:209
Parameters
other
Returns
boolean
Inherited from
meshShape()
meshShape(options?): MeshShape;
Defined in: packages/replicad/src/shapes.ts:703
Parameters
options?
angularTolerance?
number
tolerance?
number
Returns
Inherited from
serialize()
serialize(): string;
Defined in: packages/replicad/src/shapes.ts:197
Returns
string
Inherited from
simplify()
simplify(): this;
Defined in: packages/replicad/src/shapes.ts:270
Simplifies the shape by removing unnecessary edges and faces
Returns
this
Inherited from
Shape Export
blobSTEP()
blobSTEP(): Blob;
Defined in: packages/replicad/src/shapes.ts:439
Exports the current shape as a STEP file as a Blob
Returns
Blob
Inherited from
blobSTL()
blobSTL(options?): Blob;
Defined in: packages/replicad/src/shapes.ts:451
Exports the current shape as a STL file as a Blob
In order to create a STL file, the shape needs to be meshed. The tolerances correspond to the values used to mesh the shape.
Parameters
options?
STLExportOptions = {}
Returns
Blob
Inherited from
mesh()
mesh(options?): ShapeMesh;
Defined in: packages/replicad/src/shapes.ts:420
Exports the current shape as a set of triangle. These can be used by threejs for instance to represent the the shape
Parameters
options?
MeshOptions = {}
Returns
Inherited from
meshEdges()
meshEdges(options?): ShapeEdgeMesh;
Defined in: packages/replicad/src/shapes.ts:430
Exports the current shape as a set of lines. These can be used by threejs for instance to represent the edges of the shape
Parameters
options?
MeshOptions = {}
Returns
Inherited from
Shape Modifications
chamfer()
chamfer(radiusConfig, filter?): Shape3D;
Defined in: packages/replicad/src/shapes.ts:859
Creates a new shapes with some edges chamfered, as specified in the radius config.
If the radius is a filter finder object (with an EdgeFinder as filter,
and a radius to specifiy the chamfer radius), the fillet will only be
applied to the edges as selected by the finder. The finder will be
deleted unless it is explicitly specified to keep it.
If the radius is a number all the edges will be chamfered.
If the radius is a function edges will be chamfered according to the value returned by the function (0 or null will not add any chamfer).
Parameters
radiusConfig
filter?
FinderFunction<EdgeFinder, AnyShape>
Returns
Inherited from
cut()
cut(tool, options?): Shape3D;
Defined in: packages/replicad/src/shapes.ts:663
Builds a new shape by removing the tool tape from this shape
Parameters
tool
options?
Returns
Inherited from
cutPlane()
cutPlane(
plane?,
offset?,
keep?): Solid | Compound | null;
Defined in: packages/replicad/src/shapes.ts:687
Cuts this shape with a plane and retains one of its half-spaces. Positive is the direction of the plane normal and is kept by default.
Parameters
plane?
offset?
number = 0
keep?
PlaneSide = "positive"
Returns
Solid | Compound | null
Inherited from
draft()
draft(
angle,
faceFinder,
neutralPlane?): Shape3D;
Defined in: packages/replicad/src/shapes.ts:921
Applies a draft angle to selected faces of the shape.
A draft angle is a taper applied to faces, commonly used in moulding and casting to allow parts to be released from a mould. The selected faces are tilted by the given angle relative to the neutral plane.
The face finder function receives a FaceFinder and should return it
with the desired filters applied to select which faces to draft.
The neutral plane defines the reference from which the draft angle is measured — faces are unchanged where they intersect this plane and taper away from it.
Parameters
angle
number
faceFinder
FinderFunction<FaceFinder, AnyShape>
neutralPlane?
Returns
Inherited from
fillet()
fillet(radiusConfig, filter?): Shape3D;
Defined in: packages/replicad/src/shapes.ts:820
Creates a new shapes with some edges filletted, as specified in the radius config.
If the radius is a filter finder object (with an EdgeFinder as filter,
and a radius to specifiy the fillet radius), the fillet will only be
applied to the edges as selected by the finder. The finder will be
deleted unless it is explicitly specified to keep it.
If the radius is a number all the edges will be filletted.
If the radius is a function edges will be filletted according to the value returned by the function (0 or null will not add any fillet).
Parameters
radiusConfig
filter?
FinderFunction<EdgeFinder, AnyShape>
Returns
Inherited from
fuse()
fuse(other, options?): Shape3D;
Defined in: packages/replicad/src/shapes.ts:652
Builds a new shape out of the two, fused, shapes
Parameters
other
options?
Returns
Inherited from
intersect()
intersect(tool): Shape3D;
Defined in: packages/replicad/src/shapes.ts:674
Builds a new shape by intersecting this shape and another
Parameters
tool
Returns
Inherited from
shell()
Call Signature
shell(config, tolerance?): Shape3D;
Defined in: packages/replicad/src/shapes.ts:755
Hollows out the current shape, removing the faces found by the filter and
keeping a border of thickness
Parameters
config
filter
thickness
number
tolerance?
number
Returns
Inherited from
Call Signature
shell(
thickness,
finderFcn,
tolerance?): Shape3D;
Defined in: packages/replicad/src/shapes.ts:759
Hollows out the current shape, removing the faces found by the filter and
keeping a border of thickness
Parameters
thickness
number
finderFcn
FinderFunction<FaceFinder, AnyShape>
tolerance?
number
Returns
Inherited from
split()
split(
plane?,
offset?,
tolerance?): PlaneSplitResult<Solid | Compound>;
Defined in: packages/replicad/src/shapes.ts:228
Splits the solid parts of this shape with an oriented plane and groups them by side. Non-solid results are ignored.
offset translates the splitting plane along its normal. Each side is
null when empty, the resulting shape when it contains one piece, or a
Compound when it contains multiple disconnected pieces. Positive is the
direction of the plane's normal.
Parameters
plane?
offset?
number = 0
tolerance?
number = 1e-7
Returns
PlaneSplitResult<Solid | Compound>
Inherited from
Shape Transformations
mirror()
mirror(inputPlane?, origin?): this;
Defined in: packages/replicad/src/shapes.ts:362
Mirrors the shape through a plane
Parameters
inputPlane?
origin?
Returns
this
Inherited from
rotate()
rotate(
angle,
position?,
direction?): this;
Defined in: packages/replicad/src/shapes.ts:343
Rotates the shape
Parameters
angle
number
position?
Point = ...
direction?
Direction = ...
Returns
this
Inherited from
scale()
scale(scale, center?): this;
Defined in: packages/replicad/src/shapes.ts:378
Returns a scaled version of the shape
Parameters
scale
number
center?
Point = ...
Returns
this
Inherited from
translate()
Call Signature
translate(
xDist,
yDist,
zDist): this;
Defined in: packages/replicad/src/shapes.ts:294
Translates the shape of an arbitrary vector
Parameters
xDist
number
yDist
number
zDist
number
Returns
this
Inherited from
Call Signature
translate(vector): this;
Defined in: packages/replicad/src/shapes.ts:295
Translates the shape of an arbitrary vector
Parameters
vector
Returns
this
Inherited from
translateX()
translateX(distance): this;
Defined in: packages/replicad/src/shapes.ts:316
Translates the shape on the X axis
Parameters
distance
number
Returns
this
Inherited from
translateY()
translateY(distance): this;
Defined in: packages/replicad/src/shapes.ts:325
Translates the shape on the Y axis
Parameters
distance
number
Returns
this
Inherited from
translateZ()
translateZ(distance): this;
Defined in: packages/replicad/src/shapes.ts:334
Translates the shape on the Z axis
Parameters
distance
number
Returns
this