Class: Face
Defined in: packages/replicad/src/shapes.ts:568
Extends
Shape<TopoDS_Face>
Constructors
Constructor
new Face(ocShape): Face;
Defined in: packages/replicad/src/shapes.ts:189
Parameters
ocShape
TopoDS_Face
Returns
Face
Inherited from
Other
boundingBox
Get Signature
get boundingBox(): BoundingBox;
Defined in: packages/replicad/src/shapes.ts:408
Returns
Inherited from
center
Get Signature
get center(): Vector;
Defined in: packages/replicad/src/shapes.ts:611
Returns
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
geomType
Get Signature
get geomType(): SurfaceType;
Defined in: packages/replicad/src/shapes.ts:588
Returns
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
orientation
Get Signature
get orientation(): "forward" | "backward";
Defined in: packages/replicad/src/shapes.ts:577
Returns
"forward" | "backward"
solids
Get Signature
get solids(): Solid[];
Defined in: packages/replicad/src/shapes.ts:397
Returns
Solid[]
Inherited from
surface
Get Signature
get surface(): Surface;
Defined in: packages/replicad/src/shapes.ts:573
Returns
UVBounds
Get Signature
get UVBounds(): FaceUVBounds;
Defined in: packages/replicad/src/shapes.ts:595
Returns
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
flipOrientation()
flipOrientation(): Face;
Defined in: packages/replicad/src/shapes.ts:583
Returns
Face
innerWires()
innerWires(): Wire[];
Defined in: packages/replicad/src/shapes.ts:621
Returns
Wire[]
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
normalAt()
normalAt(locationVector?): Vector;
Defined in: packages/replicad/src/shapes.ts:607
Parameters
locationVector?
Returns
outerWire()
outerWire(): Wire;
Defined in: packages/replicad/src/shapes.ts:615
Returns
pointOnSurface()
pointOnSurface(u, v): Vector;
Defined in: packages/replicad/src/shapes.ts:599
Parameters
u
number
v
number
Returns
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
triangulation()
triangulation(index0?): FaceTriangulation | null;
Defined in: packages/replicad/src/shapes.ts:632
Parameters
index0?
number = 0
Returns
FaceTriangulation | null
uvCoordinates()
uvCoordinates(point): [number, number];
Defined in: packages/replicad/src/shapes.ts:603
Parameters
point
Returns
[number, number]
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
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