OpenCascade.js
API ReferenceModelingAlgorithmsTKFeat

BRepFeat

OCCT package BRepFeat: BRepFeat_Builder, BRepFeat_Form, BRepFeat_Gluer, BRepFeat_MakeCylindricalHole, and 9 more bound classes.

BRepFeat_Builder

Provides a basic tool to implement features topological operations. The main goal of the algorithm is to perform the result of the operation according to the kept parts of the tool. Input data: a) DS; b) The kept parts of the tool; If the map of the kept parts of the tool is not filled boolean operation of the given type will be performed; c) Operation required. Steps: a) Fill myShapes, myRemoved maps; b) Rebuild edges and faces; c) Build images of the object; d) Build the result of the operation. Result: Result shape of the operation required.

Constructors(1)

Instance methods(15)

  • Clear(): void

    Clears internal fields and arguments.

  • Init(theShape: TopoDS_Shape): void

    Initializes the object of local boolean operation.

    Parameters (1)
    • theShape
  • Init(theShape: TopoDS_Shape, theTool: TopoDS_Shape): void

    Initializes the arguments of local boolean operation.

    Parameters (2)
    • theShape
    • theTool
  • SetOperation(theFuse: number): void

    Sets the operation of local boolean operation. If theFuse = 0 than the operation is CUT, otherwise FUSE.

    Parameters (1)
    • theFuse
  • SetOperation(theFuse: number, theFlag: boolean): void

    Sets the operation of local boolean operation. If theFlag = TRUE it means that no selection of parts of the tool is needed, t.e. no second part. In that case if theFuse = 0 than operation is COMMON, otherwise CUT21. If theFlag = FALSE SetOperation(theFuse) function is called.

    Parameters (2)
    • theFuse
    • theFlag
  • SetOperation(theOperation: BOPAlgo_Operation): void

    Sets the operation of local boolean operation. If theFuse = 0 than the operation is CUT, otherwise FUSE.

    Parameters (1)
    • theOperation
  • Collects parts of the tool.

    Parameters (1)
    • theLT
      Mutated in place; read the updated value from this argument after the call.
  • Initializes parts of the tool for second step of algorithm. Collects shapes and all sub-shapes into myShapes map.

    Parameters (1)
    • theIm
  • KeepPart(theS: TopoDS_Shape): void

    Adds shape theS and all its sub-shapes into myShapes map.

    Parameters (1)
    • theS
  • Main function to build the result of the local operation required.

    Parameters (1)
    • theRange
  • RebuildFaces(): void

    Rebuilds faces in accordance with the kept parts of the tool.

  • Rebuilds edges in accordance with the kept parts of the tool.

    Parameters (4)
    • theE
    • theF
    • theME
    • aLEIm
      Mutated in place; read the updated value from this argument after the call.
  • Collects the images of the object, that contains in the images of the tool.

  • FillRemoved(): void

    Collects the removed parts of the tool into myRemoved map.

  • Adds the shape S and its sub-shapes into myRemoved map.

    Parameters (2)
    • theS
    • theM
      Mutated in place; read the updated value from this argument after the call.

BRepFeat_Form

Provides general functions to build form features. Form features can be depressions or protrusions and include the following types:

  • Cylinder
  • Draft Prism
  • Prism
  • Revolved feature
  • Pipe In each case, you have a choice of operation type between the following:
  • removing matter (a Boolean cut: Fuse setting 0)
  • adding matter (Boolean fusion: Fuse setting 1) The semantics of form feature creation is based on the construction of shapes:
  • along a length
  • up to a limiting face
  • from a limiting face to a height
  • above and/or below a plane The shape defining construction of the feature can be either the supporting edge or the concerned area of a face. In case of the supporting edge, this contour can be attached to a face of the basis shape by binding.
    When the contour is bound to this face, the information that the contour will slide on the face becomes available to the relevant class methods.
    In case of the concerned area of a face, you could, for example, cut it out and move it to a different height which will define the limiting face of a protrusion or depression.
    Topological definition with local operations of this sort makes calculations simpler and faster than a global operation. The latter would entail a second phase of removing unwanted matter to get the same result.

Instance methods(17)

BRepFeat_Gluer

One of the most significant aspects of BRepFeat functionality is the use of local operations as opposed to global ones.
In a global operation, you would first construct a form of the type you wanted in your final feature, and then remove matter so that it could fit into your initial basis object.
In a local operation, however, you specify the domain of the feature construction with aspects of the shape on which the feature is being created.
These semantics are expressed in terms of a member shape of the basis shape from which - or up to which - matter will be added or removed. As a result, local operations make calculations simpler and faster than global operations. Glueing uses wires or edges of a face in the basis shape. These are to become a part of the feature. They are first cut out and then projected to a plane outside or inside the basis shape.
By rebuilding the initial shape incorporating the edges and the faces of the tool, protrusion features can be constructed.

Constructors(2)

Instance methods(9)

  • Init(Snew: TopoDS_Shape, Sbase: TopoDS_Shape): void

    Initializes the new shape Snew and the basis shape Sbase for the local glueing operation.

    Parameters (2)
    • Snew
    • Sbase
  • Bind(Fnew: TopoDS_Face, Fbase: TopoDS_Face): void

    Defines a contact between Fnew on the new shape Snew and Fbase on the basis shape Sbase. Informs other methods that Fnew in the new shape Snew is connected to the face Fbase in the basis shape Sbase. The contact faces of the glued shape must not have parts outside the contact faces of the basis shape. This indicates that glueing is possible.

    Parameters (2)
    • Fnew
    • Fbase
  • Bind(Enew: TopoDS_Edge, Ebase: TopoDS_Edge): void

    nforms other methods that the edge Enew in the new shape is the same as the edge Ebase in the basis shape and is therefore attached to the basis shape. This indicates that glueing is possible.

    Parameters (2)
    • Enew
    • Ebase
  • Determine which operation type to use glueing or sliding.

  • Returns the basis shape of the compound shape.

  • Returns the resulting compound shape.

  • Build(theRange?: Message_ProgressRange): void

    This is called by Shape(). It does nothing but may be redefined.

    Parameters (1)
    • theRange
  • IsDeleted(S: TopoDS_Shape): boolean

    Returns the status of the Face after the shape creation.

    Parameters (1)
    • S
  • Returns the list of generated Faces.

    Parameters (1)
    • S

BRepFeat_MakeCylindricalHole

Provides a tool to make cylindrical holes on a shape.

Constructors(1)

Instance methods(12)

  • Init(Axis: gp_Ax1): void

    Sets the axis of the hole(s).

    Parameters (1)
    • Axis
  • Init(S: TopoDS_Shape, Axis: gp_Ax1): void

    Sets the shape and axis on which hole(s) will be performed.

    Parameters (2)
    • S
    • Axis
  • Init(theShape: TopoDS_Shape): void

    Sets the axis of the hole(s).

    Parameters (1)
    • theShape
  • Init(theShape: TopoDS_Shape, theTool: TopoDS_Shape): void

    Sets the shape and axis on which hole(s) will be performed.

    Parameters (2)
    • theShape
    • theTool
  • Perform(Radius: number): void

    Performs every hole of radius <Radius>. This command has the same effect as a cut operation with an infinite cylinder defined by the given axis and <Radius>.

    Parameters (1)
    • Radius
  • Perform(Radius: number, PFrom: number, PTo: number, WithControl: boolean): void

    Performs every hole of radius <Radius> located between PFrom and PTo on the given axis. If <WithControl> is set to false no control are done on the resulting shape after the operation is performed.

    Parameters (4)
    • Radius
    • PFrom
    • PTo
    • WithControl
  • Performs every hole of radius <Radius>. This command has the same effect as a cut operation with an infinite cylinder defined by the given axis and <Radius>.

    Parameters (1)
    • theRange
  • PerformThruNext(Radius: number, WithControl?: boolean): void

    Performs the first hole of radius <Radius>, in the direction of the defined axis. First hole signify first encountered after the origin of the axis. If <WithControl> is set to false no control are done on the resulting shape after the operation is performed.

    Parameters (2)
    • Radius
    • WithControl
  • PerformUntilEnd(Radius: number, WithControl?: boolean): void

    Performs every hole of radius <Radius> located after the origin of the given axis. If <WithControl> is set to false no control are done on the resulting shape after the operation is performed.

    Parameters (2)
    • Radius
    • WithControl
  • PerformBlind(Radius: number, Length: number, WithControl?: boolean): void

    Performs a blind hole of radius <Radius> and length <Length>. The length is measured from the origin of the given axis. If <WithControl> is set to false no control are done after the operation is performed.

    Parameters (3)
    • Radius
    • Length
    • WithControl
  • Returns the status after a hole is performed.

  • Build(): void

    Builds the resulting shape (redefined from MakeShape). Invalidates the given parts of tools if any, and performs the result of the local operation.

BRepFeat_MakeDPrism

Describes functions to build draft prism topologies from basis shape surfaces. These can be depressions or protrusions. The semantics of draft prism feature creation is based on the construction of shapes:

  • along a length
  • up to a limiting face
  • from a limiting face to a height. The shape defining construction of the draft prism feature can be either the supporting edge or the concerned area of a face. In case of the supporting edge, this contour can be attached to a face of the basis shape by binding. When the contour is bound to this face, the information that the contour will slide on the face becomes available to the relevant class methods. In case of the concerned area of a face, you could, for example, cut it out and move it to a different height which will define the limiting face of a protrusion or depression.

Constructors(2)

  • constructor(Sbase: TopoDS_Shape, Pbase: TopoDS_Face, Skface: TopoDS_Face, Angle: number, Fuse: number, Modify: boolean): BRepFeat_MakeDPrism

    A face Pbase is selected in the shape Sbase to serve as the basis for the draft prism. The draft will be defined by the angle Angle and Fuse offers a choice between:

    • removing matter with a Boolean cut using the setting 0
    • adding matter with Boolean fusion using the setting 1. The sketch face Skface serves to determine the type of operation. If it is inside the basis shape, a local operation such as glueing can be performed. Initializes the draft prism class
    Parameters (6)
    • Sbase
    • Pbase
    • Skface
    • Angle
    • Fuse
    • Modify

Instance methods(14)

  • Init(Sbase: TopoDS_Shape, Pbase: TopoDS_Face, Skface: TopoDS_Face, Angle: number, Fuse: number, Modify: boolean): void

    Initializes this algorithm for building draft prisms along surfaces. A face Pbase is selected in the basis shape Sbase to serve as the basis from the draft prism. The draft will be defined by the angle Angle and Fuse offers a choice between:

    • removing matter with a Boolean cut using the setting 0
    • adding matter with Boolean fusion using the setting 1. The sketch face Skface serves to determine the type of operation. If it is inside the basis shape, a local operation such as glueing can be performed.
    Parameters (6)
    • Sbase
    • Pbase
    • Skface
    • Angle
    • Fuse
    • Modify
  • Add(E: TopoDS_Edge, OnFace: TopoDS_Face): void

    Indicates that the edge <E> will slide on the face <OnFace>. Raises ConstructionError if the face does not belong to the basis shape, or the edge to the prismed shape.

    Parameters (2)
    • E
    • OnFace
  • Perform(Height: number): void
    Parameters (1)
    • Height
  • Perform(Until: TopoDS_Shape): void
    Parameters (1)
    • Until
  • Perform(From: TopoDS_Shape, Until: TopoDS_Shape): void

    Assigns one of the following semantics.

    • to a height Height
    • to a face Until
    • from a face From to a height Until. Reconstructs the feature topologically according to the semantic option chosen.
    Parameters (2)
    • From
    • Until
  • Realizes a semi-infinite prism, limited by the position of the prism base.

  • Realizes a semi-infinite prism, limited by the face Funtil.

    Parameters (1)
    • FUntil
  • Builds an infinite prism. The infinite descendants will not be kept in the result.

  • PerformUntilHeight(Until: TopoDS_Shape, Height: number): void

    Assigns both a limiting shape, Until from TopoDS_Shape, and a height, Height at which to stop generation of the prism feature.

    Parameters (2)
    • Until
    • Height
  • Parameters (1)
    • S
  • BossEdges(sig: number): void

    Determination of TopEdges and LatEdges. sig = 1 -> TopEdges = FirstShape of the DPrism sig = 2 -> TOpEdges = LastShape of the DPrism.

    Parameters (1)
    • sig
  • Returns the list of TopoDS Edges of the top of the boss.

  • Returns the list of TopoDS Edges of the bottom of the boss.

BRepFeat_MakePipe

Constructs compound shapes with pipe features. These can be depressions or protrusions. The semantics of pipe feature creation is based on the construction of shapes:

  • along a length
  • up to a limiting face
  • from a limiting face to a height. The shape defining construction of the pipe feature can be either the supporting edge or the concerned area of a face. In case of the supporting edge, this contour can be attached to a face of the basis shape by binding. When the contour is bound to this face, the information that the contour will slide on the face becomes available to the relevant class methods. In case of the concerned area of a face, you could, for example, cut it out and move it to a different height which will define the limiting face of a protrusion or depression.

Constructors(2)

  • initializes the pipe class.

  • constructor(Sbase: TopoDS_Shape, Pbase: TopoDS_Shape, Skface: TopoDS_Face, Spine: TopoDS_Wire, Fuse: number, Modify: boolean): BRepFeat_MakePipe

    A face Pbase is selected in the shape Sbase to serve as the basis for the pipe. It will be defined by the wire Spine. Fuse offers a choice between:

    • removing matter with a Boolean cut using the setting 0
    • adding matter with Boolean fusion using the setting 1. The sketch face Skface serves to determine the type of operation. If it is inside the basis shape, a local operation such as glueing can be performed.
    Parameters (6)
    • Sbase
    • Pbase
    • Skface
    • Spine
    • Fuse
    • Modify

Instance methods(7)

  • Init(Sbase: TopoDS_Shape, Pbase: TopoDS_Shape, Skface: TopoDS_Face, Spine: TopoDS_Wire, Fuse: number, Modify: boolean): void

    Initializes this algorithm for adding pipes to shapes. A face Pbase is selected in the shape Sbase to serve as the basis for the pipe. It will be defined by the wire Spine. Fuse offers a choice between:

    • removing matter with a Boolean cut using the setting 0
    • adding matter with Boolean fusion using the setting 1. The sketch face Skface serves to determine the type of operation. If it is inside the basis shape, a local operation such as glueing can be performed.
    Parameters (6)
    • Sbase
    • Pbase
    • Skface
    • Spine
    • Fuse
    • Modify
  • Add(E: TopoDS_Edge, OnFace: TopoDS_Face): void

    Indicates that the edge <E> will slide on the face <OnFace>. Raises ConstructionError if the face does not belong to the basis shape, or the edge to the prismed shape.

    Parameters (2)
    • E
    • OnFace
  • Perform(): void
  • Perform(Until: TopoDS_Shape): void
    Parameters (1)
    • Until
  • Perform(From: TopoDS_Shape, Until: TopoDS_Shape): void

    Assigns one of the following semantics.

    • to a face Until
    • from a face From to a height Until. Reconstructs the feature topologically according to the semantic option chosen.
    Parameters (2)
    • From
    • Until
  • Parameters (1)
    • S

BRepFeat_MakePrism

Describes functions to build prism features. These can be depressions or protrusions. The semantics of prism feature creation is based on the construction of shapes:

  • along a length
  • up to a limiting face
  • from a limiting face to a height. The shape defining construction of the prism feature can be either the supporting edge or the concerned area of a face. In case of the supporting edge, this contour can be attached to a face of the basis shape by binding. When the contour is bound to this face, the information that the contour will slide on the face becomes available to the relevant class methods. In case of the concerned area of a face, you could, for example, cut it out and move it to a different height which will define the limiting face of a protrusion or depression.

Constructors(2)

  • Builds a prism by projecting a wire along the face of a shape. Initializes the prism class.

  • constructor(Sbase: TopoDS_Shape, Pbase: TopoDS_Shape, Skface: TopoDS_Face, Direction: gp_Dir, Fuse: number, Modify: boolean): BRepFeat_MakePrism

    Builds a prism by projecting a wire along the face of a shape. a face Pbase is selected in the shape Sbase to serve as the basis for the prism. The orientation of the prism will be defined by the vector Direction. Fuse offers a choice between:

    • removing matter with a Boolean cut using the setting 0
    • adding matter with Boolean fusion using the setting 1. The sketch face Skface serves to determine the type of operation. If it is inside the basis shape, a local operation such as glueing can be performed. Exceptions Standard_ConstructionError if the face does not belong to the basis or the prism shape.
    Parameters (6)
    • Sbase
    • Pbase
    • Skface
    • Direction
    • Fuse
    • Modify

Instance methods(11)

  • Init(Sbase: TopoDS_Shape, Pbase: TopoDS_Shape, Skface: TopoDS_Face, Direction: gp_Dir, Fuse: number, Modify: boolean): void

    Initializes this algorithm for building prisms along surfaces. A face Pbase is selected in the shape Sbase to serve as the basis for the prism. The orientation of the prism will be defined by the vector Direction. Fuse offers a choice between:

    • removing matter with a Boolean cut using the setting 0
    • adding matter with Boolean fusion using the setting 1. The sketch face Skface serves to determine the type of operation. If it is inside the basis shape, a local operation such as glueing can be performed.
    Parameters (6)
    • Sbase
    • Pbase
    • Skface
    • Direction
    • Fuse
    • Modify
  • Add(E: TopoDS_Edge, OnFace: TopoDS_Face): void

    Indicates that the edge <E> will slide on the face <OnFace>. Raises ConstructionError if the face does not belong to the basis shape, or the edge to the prismed shape.

    Parameters (2)
    • E
    • OnFace
  • Perform(Length: number): void
    Parameters (1)
    • Length
  • Perform(Until: TopoDS_Shape): void
    Parameters (1)
    • Until
  • Perform(From: TopoDS_Shape, Until: TopoDS_Shape): void

    Assigns one of the following semantics.

    • to a height Length
    • to a face Until
    • from a face From to a height Until. Reconstructs the feature topologically according to the semantic option chosen.
    Parameters (2)
    • From
    • Until
  • Realizes a semi-infinite prism, limited by the position of the prism base. All other faces extend infinitely.

  • Realizes a semi-infinite prism, limited by the face Funtil.

    Parameters (1)
    • FUntil
  • Builds an infinite prism. The infinite descendants will not be kept in the result.

  • PerformUntilHeight(Until: TopoDS_Shape, Length: number): void

    Assigns both a limiting shape, Until from TopoDS_Shape, and a height, Length at which to stop generation of the prism feature.

    Parameters (2)
    • Until
    • Length
  • Returns the list of curves S parallel to the axis of the prism.

    Parameters (1)
    • S
      Mutated in place; read the updated value from this argument after the call.
  • Generates a curve along the center of mass of the primitive.

BRepFeat_MakeRevol

Describes functions to build revolved shells from basis shapes.

Constructors(2)

  • initializes the revolved shell class.

  • constructor(Sbase: TopoDS_Shape, Pbase: TopoDS_Shape, Skface: TopoDS_Face, Axis: gp_Ax1, Fuse: number, Modify: boolean): BRepFeat_MakeRevol

    a face Pbase is selected in the shape Sbase to serve as the basis for the revolved shell. The revolution will be defined by the axis Axis and Fuse offers a choice between:

    • removing matter with a Boolean cut using the setting 0
    • adding matter with Boolean fusion using the setting 1. The sketch face Skface serves to determine the type of operation. If it is inside the basis shape, a local operation such as glueing can be performed.
    Parameters (6)
    • Sbase
    • Pbase
    • Skface
    • Axis
    • Fuse
    • Modify

Instance methods(9)

BRepFeat_RibSlot

Provides functions to build mechanical features. Mechanical features include ribs - protrusions and grooves (or slots) - depressions along planar (linear) surfaces or revolution surfaces. The semantics of mechanical features is built around giving thickness to a contour. This thickness can either be unilateral - on one side of the contour - or bilateral - on both sides. As in the semantics of form features, the thickness is defined by construction of shapes in specific contexts. The development contexts differ, however,in case of mechanical features. Here they include extrusion:

  • to a limiting face of the basis shape
  • to or from a limiting plane
  • to a height.

Static methods(2)

Instance methods(9)

  • IsDeleted(S: TopoDS_Shape): boolean

    Returns true if F a TopoDS_Shape of type edge or face has been deleted.

    Parameters (1)
    • S
  • Returns the list of generated Faces F. This list may be empty.

    Parameters (1)
    • S
  • Returns a list NCollection_List<TopoDS_Shape> of the faces S created in the shape.

    Parameters (1)
    • S
  • Returns the list of shapes created at the bottom of the created form. It may be an empty list.

  • Returns the list of shapes created at the top of the created form. It may be an empty list.

  • Returns a list of the limiting and glueing faces generated by the feature. These faces did not originally exist in the basis shape. The list provides the information necessary for subsequent addition of a draft to a face. It may be an empty list. If a face has tangent edges, no draft is possible, and the tangent edges must subsequently be removed if you want to add a draft to the face.

  • Returns a list of the limiting and glueing edges generated by the feature. These edges did not originally exist in the basis shape. The list provides the information necessary for subsequent addition of fillets. It may be an empty list.

  • Returns a list of the tangent edges among the limiting and glueing edges generated by the feature. These edges did not originally exist in the basis shape and are tangent to the face against which the feature is built. The list provides the information necessary for subsequent addition of fillets. It may be an empty list. If an edge is tangent, no fillet is possible, and the edge must subsequently be removed if you want to add a fillet.

BRepFeat_SplitShape

One of the most significant aspects of BRepFeat functionality is the use of local operations as opposed to global ones.
In a global operation, you would first construct a form of the type you wanted in your final feature, and then remove matter so that it could fit into your initial basis object.
In a local operation, however, you specify the domain of the feature construction with aspects of the shape on which the feature is being created.
These semantics are expressed in terms of a member shape of the basis shape from which - or up to which - matter will be added or removed. As a result, local operations make calculations simpler and faster than global operations.
In BRepFeat, the semantics of local operations define features constructed from a contour or a part of the basis shape referred to as the tool.
In a SplitShape object, wires or edges of a face in the basis shape to be used as a part of the feature are cut out and projected to a plane outside or inside the basis shape.
By rebuilding the initial shape incorporating the edges and the faces of the tool, protrusion or depression features can be constructed.

Constructors(2)

Instance methods(13)

  • Add splitting edges or wires for whole initial shape without additional specification edge->face, edge->edge This method puts edge on the corresponding faces from initial shape.

    Parameters (1)
    • theEdges
  • Adds the wire <W> on the face <F>. Raises NoSuchObject if <F> does not belong to the original shape.

    Parameters (2)
    • W
    • F
  • Adds the edge <E> on the face <F>.

    Parameters (2)
    • E
    • F
  • Adds the compound <Comp> on the face <F>. The compound <Comp> must consist of edges lying on the face <F>. If edges are geometrically connected, they must be connected topologically, i.e. they must share common vertices.
    Raises NoSuchObject if <F> does not belong to the original shape.

    Parameters (2)
    • Comp
    • F
  • Add(E: TopoDS_Edge, EOn: TopoDS_Edge): void

    Adds the edge <E> on the existing edge <EOn>.

    Parameters (2)
    • E
    • EOn
  • Init(S: TopoDS_Shape): void

    Initializes the process on the shape .

    Parameters (1)
    • S
  • SetCheckInterior(ToCheckInterior: boolean): void

    Set the flag of check internal intersections default value is True (to check).

    Parameters (1)
    • ToCheckInterior
  • Returns the faces which are the left of the projected wires.

  • Returns the faces of the "left" part on the shape. (It is build from DirectLeft, with the faces connected to this set, and so on...). Raises NotDone if IsDone returns <false>.

  • Returns the faces of the "right" part on the shape.

  • Build(theRange?: Message_ProgressRange): void

    Builds the cut and the resulting faces and edges as well.

    Parameters (1)
    • theRange
  • IsDeleted(S: TopoDS_Shape): boolean

    Returns true if the shape has been deleted.

    Parameters (1)
    • S
  • Returns the list of generated Faces.

    Parameters (1)
    • S

BRepFeat_StatusError

Properties(28)