Class OCCTFace

Hierarchy

OCCTFace

Index

Constructors

constructor

Methods

Constructors

constructor

new OCCTFace(occWorkerManager: OCCTWorkerManager): OCCTFace

- Defined in bitbybit-docs.d.ts:26823
Parameters
- occWorkerManager: OCCTWorkerManager
Returns OCCTFace

Methods

createCircleFace

createCircleFace(inputs: CircleDto): Promise<TopoDSFacePointer>

- Defined in bitbybit-docs.d.ts:26949
Creates OpenCascade circle face

group

primitives

shortname

circle

drawable

true

Parameters
- inputs: CircleDto
  
  Circle parameters
Returns Promise<TopoDSFacePointer>

OpenCascade circle face

createEllipseFace

createEllipseFace(inputs: EllipseDto): Promise<TopoDSFacePointer>

- Defined in bitbybit-docs.d.ts:26967
Creates OpenCascade ellipse face

group

primitives

shortname

ellipse

drawable

true

Parameters
- inputs: EllipseDto
  
  Ellipse parameters
Returns Promise<TopoDSFacePointer>

OpenCascade ellipse face

createFaceFromMultipleCircleTanWireCollections

createFaceFromMultipleCircleTanWireCollections(inputs: FaceFromMultipleCircleTanWireCollectionsDto<TopoDSWirePointer>): Promise<TopoDSShapePointer>

- Defined in bitbybit-docs.d.ts:26913
Creates face from multiple circle tangent wire collections

group

from

shortname

face from multiple circle tan collections

drawable

true

Parameters
- inputs: FaceFromMultipleCircleTanWireCollectionsDto<TopoDSWirePointer>
  
  OpenCascade circle wire shapes
Returns Promise<TopoDSShapePointer>

OpenCascade face shape

createFaceFromMultipleCircleTanWires

createFaceFromMultipleCircleTanWires(inputs: FaceFromMultipleCircleTanWiresDto<TopoDSWirePointer>): Promise<TopoDSShapePointer>

- Defined in bitbybit-docs.d.ts:26904
Creates face from multiple circle tangent wires

group

from

shortname

face from circles tan

drawable

true

Parameters
- inputs: FaceFromMultipleCircleTanWiresDto<TopoDSWirePointer>
  
  OpenCascade circle wire shapes
Returns Promise<TopoDSShapePointer>

OpenCascade face shape

createFaceFromWire

createFaceFromWire(inputs: FaceFromWireDto<TopoDSWirePointer>): Promise<TopoDSFacePointer>

- Defined in bitbybit-docs.d.ts:26868
Creates a face from wire

group

from

shortname

face from wire

drawable

true

Parameters
- inputs: FaceFromWireDto<TopoDSWirePointer>
  
  OpenCascade wire shape and indication if face should be planar
Returns Promise<TopoDSFacePointer>

OpenCascade face shape

createFaceFromWireOnFace

createFaceFromWireOnFace(inputs: FaceFromWireOnFaceDto<TopoDSWirePointer, TopoDSFacePointer>): Promise<TopoDSFacePointer>

- Defined in bitbybit-docs.d.ts:26859
Creates a face from wire on face

group

from

shortname

face from wire on face

drawable

true

Parameters
- inputs: FaceFromWireOnFaceDto<TopoDSWirePointer, TopoDSFacePointer>
  
  OpenCascade wire shape and guiding face
Returns Promise<TopoDSFacePointer>

OpenCascade face shape

createFaceFromWires

createFaceFromWires(inputs: FaceFromWiresDto<TopoDSWirePointer>): Promise<TopoDSFacePointer>

- Defined in bitbybit-docs.d.ts:26877
Creates a face from wires. This can produce hollow faces.

group

from

shortname

face from wires

drawable

true

Parameters
- inputs: FaceFromWiresDto<TopoDSWirePointer>
  
  OpenCascade wire shapes and indication if face should be planar
Returns Promise<TopoDSFacePointer>

OpenCascade face shape

createFaceFromWiresOnFace

createFaceFromWiresOnFace(inputs: FaceFromWiresOnFaceDto<TopoDSWirePointer, TopoDSFacePointer>): Promise<TopoDSFacePointer>

- Defined in bitbybit-docs.d.ts:26886
Creates a face from wires on the guiding face. This can produce hollow faces.

group

from

shortname

face from wires on face

drawable

true

Parameters
- inputs: FaceFromWiresOnFaceDto<TopoDSWirePointer, TopoDSFacePointer>
  
  OpenCascade wire shapes and indication if wire is inside the face
Returns Promise<TopoDSFacePointer>

OpenCascade face shape

createFacesFromWires

createFacesFromWires(inputs: FacesFromWiresDto<TopoDSWirePointer>): Promise<TopoDSFacePointer[]>

- Defined in bitbybit-docs.d.ts:26895
Creates faces from wires

group

from

shortname

faces from wires

drawable

true

Parameters
- inputs: FacesFromWiresDto<TopoDSWirePointer>
  
  OpenCascade wire shape and indication if face should be planar
Returns Promise<TopoDSFacePointer[]>

OpenCascade face shape

createFacesFromWiresOnFace

createFacesFromWiresOnFace(inputs: FacesFromWiresOnFaceDto<TopoDSWirePointer, TopoDSFacePointer>): Promise<TopoDSFacePointer[]>

- Defined in bitbybit-docs.d.ts:26850
Creates a faces from wires on face

group

from

shortname

faces from wires on face

drawable

true

Parameters
- inputs: FacesFromWiresOnFaceDto<TopoDSWirePointer, TopoDSFacePointer>
  
  OpenCascade wires and guiding face
Returns Promise<TopoDSFacePointer[]>

OpenCascade faces

createPolygonFace

createPolygonFace(inputs: PolygonDto): Promise<TopoDSFacePointer>

- Defined in bitbybit-docs.d.ts:26940
Creates OpenCascade Polygon face

group

primitives

shortname

polygon

drawable

true

Parameters
- inputs: PolygonDto
  
  Polygon points
Returns Promise<TopoDSFacePointer>

OpenCascade polygon face

createRectangleFace

createRectangleFace(inputs: RectangleDto): Promise<TopoDSFacePointer>

- Defined in bitbybit-docs.d.ts:26985
Creates OpenCascade rectangle face

group

primitives

shortname

rectangle

drawable

true

Parameters
- inputs: RectangleDto
  
  rectangle parameters
Returns Promise<TopoDSFacePointer>

OpenCascade rectangle

createSquareFace

createSquareFace(inputs: SquareDto): Promise<TopoDSFacePointer>

- Defined in bitbybit-docs.d.ts:26976
Creates OpenCascade square face

group

primitives

shortname

square

drawable

true

Parameters
- inputs: SquareDto
  
  Square parameters
Returns Promise<TopoDSFacePointer>

OpenCascade square face

faceFromSurface

faceFromSurface(inputs: ShapeDto<GeomSurfacePointer>): Promise<TopoDSFacePointer>

- Defined in bitbybit-docs.d.ts:26922
Creates a face from the surface

group

from

shortname

surface

drawable

true

Parameters
- inputs: ShapeDto<GeomSurfacePointer>
  
  Face shape
Returns Promise<TopoDSFacePointer>

OpenCascade surface

faceFromSurfaceAndWire

faceFromSurfaceAndWire(inputs: FaceFromSurfaceAndWireDto<GeomSurfacePointer, TopoDSWirePointer>): Promise<TopoDSFacePointer>

- Defined in bitbybit-docs.d.ts:26931
Creates a face from the surface and a wire

group

from

shortname

surface and wire

drawable

true

Parameters
- inputs: FaceFromSurfaceAndWireDto<GeomSurfacePointer, TopoDSWirePointer>
  
  OpenCascade surface, a wire and indication wether face should be created inside or not
Returns Promise<TopoDSFacePointer>

Face shape

filterFacePoints

filterFacePoints(inputs: FilterFacePointsDto<TopoDSFacePointer>): Promise<Point3[]>

- Defined in bitbybit-docs.d.ts:27237
Filters points on face

group

filter

shortname

filter face points

drawable

true

Parameters
- inputs: FilterFacePointsDto<TopoDSFacePointer>
  
  face and collection of points with options
Returns Promise<Point3[]>

filtered points

filterFacesPoints

filterFacesPoints(inputs: FilterFacesPointsDto<TopoDSFacePointer>): Promise<Point3[] | Point3[][]>

- Defined in bitbybit-docs.d.ts:27246
Filters points on faces

group

filter

shortname

filter points on faces

drawable

true

Parameters
- inputs: FilterFacesPointsDto<TopoDSFacePointer>
  
  faces and collection of points with options
Returns Promise<Point3[] | Point3[][]>

filtered points

fromBaseMesh

fromBaseMesh(inputs: MeshBaseDto): Promise<TopoDSFacePointer[]>

- Defined in bitbybit-docs.d.ts:26841
Creates faces from mesh definition

group

from base

shortname

faces from mesh

drawable

true

Parameters
- inputs: MeshBaseDto
  
  Mesh
Returns Promise<TopoDSFacePointer[]>

OpenCascade faces

fromBaseTriangle

fromBaseTriangle(inputs: TriangleBaseDto): Promise<TopoDSFacePointer>

- Defined in bitbybit-docs.d.ts:26832
Creates face from triangle definition

group

from base

shortname

face from triangle

drawable

true

Parameters
- inputs: TriangleBaseDto
  
  Triangle
Returns Promise<TopoDSFacePointer>

OpenCascade face

getFace

getFace(inputs: ShapeIndexDto<TopoDSShapePointer>): Promise<TopoDSFacePointer>

- Defined in bitbybit-docs.d.ts:26994
Gets the face by providing an index from the shape

group

get

shortname

face

drawable

true

Parameters
- inputs: ShapeIndexDto<TopoDSShapePointer>
  
  Shape
Returns Promise<TopoDSFacePointer>

OpenCascade face

getFaceArea

getFaceArea(inputs: ShapeDto<TopoDSFacePointer>): Promise<number>

- Defined in bitbybit-docs.d.ts:27201
Get the area of the face

group

get

shortname

face area

drawable

false

Parameters
- inputs: ShapeDto<TopoDSFacePointer>
  
  OCCT Face
Returns Promise<number>

area

getFaceCenterOfMass

getFaceCenterOfMass(inputs: ShapeDto<TopoDSFacePointer>): Promise<Point3>

- Defined in bitbybit-docs.d.ts:27219
Get the face center of mass point

group

get

shortname

center of mass

drawable

true

Parameters
- inputs: ShapeDto<TopoDSFacePointer>
  
  OCCT Face
Returns Promise<Point3>

point

getFaces

getFaces(inputs: ShapeDto<TopoDSShapePointer>): Promise<TopoDSFacePointer[]>

- Defined in bitbybit-docs.d.ts:27003
Gets the faces of the shape in a list

group

get

shortname

faces

drawable

true

Parameters
- inputs: ShapeDto<TopoDSShapePointer>
  
  Shape
Returns Promise<TopoDSFacePointer[]>

OpenCascade faces array

getFacesAreas

getFacesAreas(inputs: ShapesDto<TopoDSFacePointer>): Promise<number[]>

- Defined in bitbybit-docs.d.ts:27210
Get the areas of the faces

group

get

shortname

areas of faces

drawable

false

Parameters
- inputs: ShapesDto<TopoDSFacePointer>
  
  OCCT Faces
Returns Promise<number[]>

areas

getFacesCentersOfMass

getFacesCentersOfMass(inputs: ShapesDto<TopoDSFacePointer>): Promise<Point3[]>

- Defined in bitbybit-docs.d.ts:27228
Get the center of mass points for faces

group

get

shortname

centers of mass

drawable

true

Parameters
- inputs: ShapesDto<TopoDSFacePointer>
  
  OCCT Faces
Returns Promise<Point3[]>

points

getUMaxBound

getUMaxBound(inputs: ShapeDto<TopoDSFacePointer>): Promise<number>

- Defined in bitbybit-docs.d.ts:27174
Gets the U max bound of the face

group

get

shortname

u max

drawable

false

Parameters
- inputs: ShapeDto<TopoDSFacePointer>
  
  OCCT Face
Returns Promise<number>

u max bound

getUMinBound

getUMinBound(inputs: ShapeDto<TopoDSFacePointer>): Promise<number>

- Defined in bitbybit-docs.d.ts:27165
Gets the U min bound of the face

group

get

shortname

u min

drawable

false

Parameters
- inputs: ShapeDto<TopoDSFacePointer>
  
  OCCT Face
Returns Promise<number>

u min bound

getVMaxBound

getVMaxBound(inputs: ShapeDto<TopoDSFacePointer>): Promise<number>

- Defined in bitbybit-docs.d.ts:27192
Gets the V max bound of the face

group

get

shortname

v max

drawable

false

Parameters
- inputs: ShapeDto<TopoDSFacePointer>
  
  OCCT Face
Returns Promise<number>

v max bound

getVMinBound

getVMinBound(inputs: ShapeDto<TopoDSFacePointer>): Promise<number>

- Defined in bitbybit-docs.d.ts:27183
Gets the V min bound of the face

group

get

shortname

v min

drawable

false

Parameters
- inputs: ShapeDto<TopoDSFacePointer>
  
  OCCT Face
Returns Promise<number>

v min bound

hexagonsInGrid

hexagonsInGrid(inputs: HexagonsInGridDto): Promise<TopoDSFacePointer[]>

- Defined in bitbybit-docs.d.ts:26958
Creates OpenCascade hexagons in grid

group

primitives

shortname

hexagons in grid

drawable

true

Parameters
- inputs: HexagonsInGridDto
  
  Hexagon parameters
Returns Promise<TopoDSFacePointer[]>

OpenCascade hexagons in grid

normalOnUV

normalOnUV(inputs: DataOnUVDto<TopoDSFacePointer>): Promise<Vector3>

- Defined in bitbybit-docs.d.ts:27111
Get normal on UV where U and V are described between 0 and 1. These will be mapped to real bounds.

group

extract

shortname

normal on uv

drawable

true

Parameters
- inputs: DataOnUVDto<TopoDSFacePointer>
  
  Face and params for subdivision
Returns Promise<Vector3>

normal vector

normalsOnUVs

normalsOnUVs(inputs: DataOnUVsDto<TopoDSFacePointer>): Promise<Vector3[]>

- Defined in bitbybit-docs.d.ts:27129
Get normals on UVs where U and V are described between 0 and 1 in two dimensional arrays. These will be mapped to real bounds.

group

extract

shortname

normals on uvs

drawable

true

Parameters
- inputs: DataOnUVsDto<TopoDSFacePointer>
  
  Face and params for subdivision
Returns Promise<Vector3[]>

normals

pointOnUV

pointOnUV(inputs: DataOnUVDto<TopoDSFacePointer>): Promise<Point3>

- Defined in bitbybit-docs.d.ts:27102
Get point on UV where U and V are described between 0 and 1. These will be mapped to real bounds.

group

extract

shortname

point on uv

drawable

true

Parameters
- inputs: DataOnUVDto<TopoDSFacePointer>
  
  Face and params for subdivision
Returns Promise<Point3>

point

pointsOnUVs

pointsOnUVs(inputs: DataOnUVsDto<TopoDSFacePointer>): Promise<Point3[]>

- Defined in bitbybit-docs.d.ts:27120
Get points on UVs where U and V are described between 0 and 1 in two dimensional arrays. These will be mapped to real bounds.

group

extract

shortname

points on uvs

drawable

true

Parameters
- inputs: DataOnUVsDto<TopoDSFacePointer>
  
  Face and params for subdivision
Returns Promise<Point3[]>

points

reversedFace

reversedFace(inputs: ShapeDto<TopoDSFacePointer>): Promise<TopoDSFacePointer>

- Defined in bitbybit-docs.d.ts:27012
Computes reversed face from input face

group

get

shortname

reversed

drawable

true

Parameters
- inputs: ShapeDto<TopoDSFacePointer>
  
  Face
Returns Promise<TopoDSFacePointer>

OpenCascade face

subdivideToHexagonHoles

subdivideToHexagonHoles(inputs: FaceSubdivideToHexagonHolesDto<TopoDSFacePointer>): Promise<TopoDSFacePointer[]>

- Defined in bitbybit-docs.d.ts:27066
Subdivides a face to hexagon holes

group

patterns

shortname

hexagon holes on face

drawable

true

Parameters
- inputs: FaceSubdivideToHexagonHolesDto<TopoDSFacePointer>
  
  Face and options for subdivision
Returns Promise<TopoDSFacePointer[]>

faces

subdivideToHexagonWires

subdivideToHexagonWires(inputs: FaceSubdivideToHexagonWiresDto<TopoDSFacePointer>): Promise<TopoDSWirePointer[]>

- Defined in bitbybit-docs.d.ts:27057
Subdivides a face to hexagon wires

group

patterns

shortname

hexagon wires on face

drawable

true

Parameters
- inputs: FaceSubdivideToHexagonWiresDto<TopoDSFacePointer>
  
  Face and options for subdivision
Returns Promise<TopoDSWirePointer[]>

wires

subdivideToNormals

subdivideToNormals(inputs: FaceSubdivisionDto<TopoDSFacePointer>): Promise<Vector3[]>

- Defined in bitbybit-docs.d.ts:27084
Subdivides a face to normals grid

group

extract

shortname

normals

drawable

true

Parameters
- inputs: FaceSubdivisionDto<TopoDSFacePointer>
  
  Face and params for subdivision
Returns Promise<Vector3[]>

normal vectors

subdivideToPoints

subdivideToPoints(inputs: FaceSubdivisionDto<TopoDSFacePointer>): Promise<Point3[]>

- Defined in bitbybit-docs.d.ts:27021
Subdivides a face to point grid

group

extract

shortname

points

drawable

true

Parameters
- inputs: FaceSubdivisionDto<TopoDSFacePointer>
  
  Face and options for subdivision
Returns Promise<Point3[]>

points

subdivideToPointsControlled

subdivideToPointsControlled(inputs: FaceSubdivisionControlledDto<TopoDSFacePointer>): Promise<Point3[]>

- Defined in bitbybit-docs.d.ts:27075
Subdivides a face to point grid with shifts and removals on nth uv rows or columns

group

extract

shortname

points nth

drawable

true

Parameters
- inputs: FaceSubdivisionControlledDto<TopoDSFacePointer>
  
  Face and params for subdivision
Returns Promise<Point3[]>

points

subdivideToPointsOnParam

subdivideToPointsOnParam(inputs: FaceLinearSubdivisionDto<TopoDSFacePointer>): Promise<Point3[]>

- Defined in bitbybit-docs.d.ts:27138
Subdivides a face to points along a line on parameter

group

extract

shortname

points on param

drawable

true

Parameters
- inputs: FaceLinearSubdivisionDto<TopoDSFacePointer>
  
  Face and params for subdivision
Returns Promise<Point3[]>

points

subdivideToRectangleHoles

subdivideToRectangleHoles(inputs: FaceSubdivideToRectangleHolesDto<TopoDSFacePointer>): Promise<TopoDSFacePointer[]>

- Defined in bitbybit-docs.d.ts:27048
Subdivides a face to rectangle wires

group

patterns

shortname

rectangle holes on face

drawable

true

Parameters
- inputs: FaceSubdivideToRectangleHolesDto<TopoDSFacePointer>
  
  Face and options for subdivision
Returns Promise<TopoDSFacePointer[]>

wires

subdivideToRectangleWires

subdivideToRectangleWires(inputs: FaceSubdivideToRectangleWiresDto<TopoDSFacePointer>): Promise<TopoDSWirePointer[]>

- Defined in bitbybit-docs.d.ts:27039
Subdivides a face to rectangle wires

group

patterns

shortname

rectangle wires on face

drawable

true

Parameters
- inputs: FaceSubdivideToRectangleWiresDto<TopoDSFacePointer>
  
  Face and options for subdivision
Returns Promise<TopoDSWirePointer[]>

wires

subdivideToUV

subdivideToUV(inputs: FaceSubdivisionDto<TopoDSFacePointer>): Promise<Point2[]>

- Defined in bitbybit-docs.d.ts:27093
Subdivides a face to uv grid

group

extract

shortname

uvs

drawable

true

Parameters
- inputs: FaceSubdivisionDto<TopoDSFacePointer>
  
  Face and params for subdivision
Returns Promise<Point2[]>

uv params in array

subdivideToWires

subdivideToWires(inputs: FaceSubdivisionToWiresDto<TopoDSFacePointer>): Promise<TopoDSWirePointer[]>

- Defined in bitbybit-docs.d.ts:27030
Subdivides a face to wires

group

extract

shortname

wires

drawable

true

Parameters
- inputs: FaceSubdivisionToWiresDto<TopoDSFacePointer>
  
  Face and options for subdivision
Returns Promise<TopoDSWirePointer[]>

wires

wireAlongParam

wireAlongParam(inputs: WireAlongParamDto<TopoDSFacePointer>): Promise<TopoDSWirePointer>

- Defined in bitbybit-docs.d.ts:27147
Gets the wire along the parameter on the face

group

extract

shortname

wire along param

drawable

true

Parameters
- inputs: WireAlongParamDto<TopoDSFacePointer>
  
  Face and param
Returns Promise<TopoDSWirePointer>

wire

wiresAlongParams

wiresAlongParams(inputs: WiresAlongParamsDto<TopoDSFacePointer>): Promise<TopoDSWirePointer[]>

- Defined in bitbybit-docs.d.ts:27156
Gets the wires along the parameters on the face

group

extract

shortname

wires along params

drawable

true

Parameters
- inputs: WiresAlongParamsDto<TopoDSFacePointer>
  
  Face and params
Returns Promise<TopoDSWirePointer[]>

wires

Generated using TypeDoc