OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    BRepFeat_Form Class Referenceabstract

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

    #include <BRepFeat_Form.hxx>

    Inheritance diagram for BRepFeat_Form:

    Public Member Functions

    const NCollection_List< TopoDS_Shape > & Modified (const TopoDS_Shape &F) override
     returns the list of generated Faces.
    const NCollection_List< TopoDS_Shape > & Generated (const TopoDS_Shape &S) override
     returns a list of the created faces from the shape .
    bool IsDeleted (const TopoDS_Shape &S) override
     Returns true if the shape S has been deleted.
    const NCollection_List< TopoDS_Shape > & FirstShape () const
     Returns the list of shapes created at the bottom of the created form. It may be an empty list.
    const NCollection_List< TopoDS_Shape > & LastShape () const
     Returns the list of shapes created at the top of the created form. It may be an empty list.
    const NCollection_List< TopoDS_Shape > & NewEdges () const
     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.
    const NCollection_List< TopoDS_Shape > & TgtEdges () const
     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.
    void BasisShapeValid ()
     Initializes the topological construction if the basis shape is present.
    void GeneratedShapeValid ()
     Initializes the topological construction if the generated shape S is present.
    void ShapeFromValid ()
     Initializes the topological construction if the shape is present from the specified integer on.
    void ShapeUntilValid ()
     Initializes the topological construction if the shape is present until the specified integer.
    void GluedFacesValid ()
     Initializes the topological construction if the glued face is present.
    void SketchFaceValid ()
     Initializes the topological construction if the sketch face is present. If the sketch face is inside the basis shape, local operations such as glueing can be performed.
    void PerfSelectionValid ()
     Initializes the topological construction if the selected face is present.
    virtual void Curves (NCollection_Sequence< occ::handle< Geom_Curve > > &S)=0
    virtual occ::handle< Geom_Curve > BarycCurve ()=0
    BRepFeat_StatusError CurrentStatusError () const
    Public Member Functions inherited from BRepBuilderAPI_MakeShape
    virtual void Build (const Message_ProgressRange &theRange=Message_ProgressRange())
     This is called by Shape(). It does nothing but may be redefined.
    virtual const TopoDS_Shape & Shape ()
     Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built.
     operator TopoDS_Shape ()
    Public Member Functions inherited from BRepBuilderAPI_Command
    virtual ~BRepBuilderAPI_Command ()
    virtual bool IsDone () const
    void Check () const
     Raises NotDone if done is false.

    Protected Member Functions

     BRepFeat_Form ()
     Redefines the empty constructor.
    void GlobalPerform ()
     General perform method...
    void UpdateDescendants (const LocOpe_Gluer &G)
    void UpdateDescendants (const BRepAlgoAPI_BooleanOperation &aBOP, const TopoDS_Shape &SResult, const bool SkipFace=false)
    bool TransformShapeFU (const int flag)
    Protected Member Functions inherited from BRepBuilderAPI_MakeShape
     BRepBuilderAPI_MakeShape ()
    Protected Member Functions inherited from BRepBuilderAPI_Command
     BRepBuilderAPI_Command ()
     Set done to False.
    void Done ()
     Set done to true.
    void NotDone ()
     Set done to false.

    Protected Attributes

    bool myFuse
    bool myModify
    NCollection_DataMap< TopoDS_Shape, NCollection_List< TopoDS_Shape >, TopTools_ShapeMapHasher > myMap
    TopoDS_Shape myFShape
    TopoDS_Shape myLShape
    NCollection_List< TopoDS_Shape > myNewEdges
    NCollection_List< TopoDS_Shape > myTgtEdges
    BRepFeat_PerfSelection myPerfSelection
    bool myJustGluer
    bool myJustFeat
    TopoDS_Shape mySbase
    TopoDS_Face mySkface
    TopoDS_Shape myGShape
    TopoDS_Shape mySFrom
    TopoDS_Shape mySUntil
    NCollection_DataMap< TopoDS_Shape, TopoDS_Shape, TopTools_ShapeMapHasher > myGluedF
    Protected Attributes inherited from BRepBuilderAPI_MakeShape
    TopoDS_Shape myShape
    NCollection_List< TopoDS_Shape > myGenerated

    Detailed Description

    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.

    Constructor & Destructor Documentation

    ◆ BRepFeat_Form()

    BRepFeat_Form::BRepFeat_Form ( )
    protected

    Redefines the empty constructor.

    Member Function Documentation

    ◆ BarycCurve()

    virtual occ::handle< Geom_Curve > BRepFeat_Form::BarycCurve ( )
    pure virtual

    ◆ BasisShapeValid()

    void BRepFeat_Form::BasisShapeValid ( )

    Initializes the topological construction if the basis shape is present.

    ◆ CurrentStatusError()

    BRepFeat_StatusError BRepFeat_Form::CurrentStatusError ( ) const

    ◆ Curves()

    virtual void BRepFeat_Form::Curves ( NCollection_Sequence< occ::handle< Geom_Curve > > & S)
    pure virtual

    ◆ FirstShape()

    const NCollection_List< TopoDS_Shape > & BRepFeat_Form::FirstShape ( ) const

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

    ◆ Generated()

    const NCollection_List< TopoDS_Shape > & BRepFeat_Form::Generated ( const TopoDS_Shape & S)
    overridevirtual

    returns a list of the created faces from the shape .

    Reimplemented from BRepBuilderAPI_MakeShape.

    ◆ GeneratedShapeValid()

    void BRepFeat_Form::GeneratedShapeValid ( )

    Initializes the topological construction if the generated shape S is present.

    ◆ GlobalPerform()

    void BRepFeat_Form::GlobalPerform ( )
    protected

    General perform method...

    ◆ GluedFacesValid()

    void BRepFeat_Form::GluedFacesValid ( )

    Initializes the topological construction if the glued face is present.

    ◆ IsDeleted()

    bool BRepFeat_Form::IsDeleted ( const TopoDS_Shape & S)
    overridevirtual

    Returns true if the shape S has been deleted.

    Reimplemented from BRepBuilderAPI_MakeShape.

    ◆ LastShape()

    const NCollection_List< TopoDS_Shape > & BRepFeat_Form::LastShape ( ) const

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

    ◆ Modified()

    const NCollection_List< TopoDS_Shape > & BRepFeat_Form::Modified ( const TopoDS_Shape & F)
    overridevirtual

    returns the list of generated Faces.

    Reimplemented from BRepBuilderAPI_MakeShape.

    ◆ NewEdges()

    const NCollection_List< TopoDS_Shape > & BRepFeat_Form::NewEdges ( ) const

    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.

    ◆ PerfSelectionValid()

    void BRepFeat_Form::PerfSelectionValid ( )

    Initializes the topological construction if the selected face is present.

    ◆ ShapeFromValid()

    void BRepFeat_Form::ShapeFromValid ( )

    Initializes the topological construction if the shape is present from the specified integer on.

    ◆ ShapeUntilValid()

    void BRepFeat_Form::ShapeUntilValid ( )

    Initializes the topological construction if the shape is present until the specified integer.

    ◆ SketchFaceValid()

    void BRepFeat_Form::SketchFaceValid ( )

    Initializes the topological construction if the sketch face is present. If the sketch face is inside the basis shape, local operations such as glueing can be performed.

    ◆ TgtEdges()

    const NCollection_List< TopoDS_Shape > & BRepFeat_Form::TgtEdges ( ) const

    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.

    ◆ TransformShapeFU()

    bool BRepFeat_Form::TransformShapeFU ( const int flag)
    protected

    ◆ UpdateDescendants() [1/2]

    void BRepFeat_Form::UpdateDescendants ( const BRepAlgoAPI_BooleanOperation & aBOP,
    const TopoDS_Shape & SResult,
    const bool SkipFace = false )
    protected

    ◆ UpdateDescendants() [2/2]

    void BRepFeat_Form::UpdateDescendants ( const LocOpe_Gluer & G)
    protected

    Field Documentation

    ◆ myFShape

    TopoDS_Shape BRepFeat_Form::myFShape
    protected

    ◆ myFuse

    bool BRepFeat_Form::myFuse
    protected

    ◆ myGluedF

    ◆ myGShape

    TopoDS_Shape BRepFeat_Form::myGShape
    protected

    ◆ myJustFeat

    bool BRepFeat_Form::myJustFeat
    protected

    ◆ myJustGluer

    bool BRepFeat_Form::myJustGluer
    protected

    ◆ myLShape

    TopoDS_Shape BRepFeat_Form::myLShape
    protected

    ◆ myMap

    ◆ myModify

    bool BRepFeat_Form::myModify
    protected

    ◆ myNewEdges

    NCollection_List<TopoDS_Shape> BRepFeat_Form::myNewEdges
    protected

    ◆ myPerfSelection

    BRepFeat_PerfSelection BRepFeat_Form::myPerfSelection
    protected

    ◆ mySbase

    TopoDS_Shape BRepFeat_Form::mySbase
    protected

    ◆ mySFrom

    TopoDS_Shape BRepFeat_Form::mySFrom
    protected

    ◆ mySkface

    TopoDS_Face BRepFeat_Form::mySkface
    protected

    ◆ mySUntil

    TopoDS_Shape BRepFeat_Form::mySUntil
    protected

    ◆ myTgtEdges

    NCollection_List<TopoDS_Shape> BRepFeat_Form::myTgtEdges
    protected

    The documentation for this class was generated from the following file: