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_MakeDPrism Class Reference

    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: More...

    #include <BRepFeat_MakeDPrism.hxx>

    Inheritance diagram for BRepFeat_MakeDPrism:

    Public Member Functions

     BRepFeat_MakeDPrism (const TopoDS_Shape &Sbase, const TopoDS_Face &Pbase, const TopoDS_Face &Skface, const double Angle, const int Fuse, const bool Modify)
     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:
     BRepFeat_MakeDPrism ()
    void Init (const TopoDS_Shape &Sbase, const TopoDS_Face &Pbase, const TopoDS_Face &Skface, const double Angle, const int Fuse, const bool Modify)
     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:
    void Add (const TopoDS_Edge &E, const TopoDS_Face &OnFace)
     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.
    void Perform (const double Height)
    void Perform (const TopoDS_Shape &Until)
    void Perform (const TopoDS_Shape &From, const TopoDS_Shape &Until)
     Assigns one of the following semantics.
    void PerformUntilEnd ()
     Realizes a semi-infinite prism, limited by the position of the prism base.
    void PerformFromEnd (const TopoDS_Shape &FUntil)
     Realizes a semi-infinite prism, limited by the face Funtil.
    void PerformThruAll ()
     Builds an infinite prism. The infinite descendants will not be kept in the result.
    void PerformUntilHeight (const TopoDS_Shape &Until, const double Height)
     Assigns both a limiting shape, Until from TopoDS_Shape, and a height, Height at which to stop generation of the prism feature.
    void Curves (NCollection_Sequence< occ::handle< Geom_Curve > > &S) override
    occ::handle< Geom_Curve > BarycCurve () override
    void BossEdges (const int sig)
     Determination of TopEdges and LatEdges. sig = 1 -> TopEdges = FirstShape of the DPrism sig = 2 -> TOpEdges = LastShape of the DPrism.
    const NCollection_List< TopoDS_Shape > & TopEdges ()
     Returns the list of TopoDS Edges of the top of the boss.
    const NCollection_List< TopoDS_Shape > & LatEdges ()
     Returns the list of TopoDS Edges of the bottom of the boss.
    Public Member Functions inherited from BRepFeat_Form
    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.
    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.

    Additional Inherited Members

    Protected Member Functions inherited from BRepFeat_Form
     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 inherited from BRepFeat_Form
    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

    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.

    Constructor & Destructor Documentation

    ◆ BRepFeat_MakeDPrism() [1/2]

    BRepFeat_MakeDPrism::BRepFeat_MakeDPrism ( const TopoDS_Shape & Sbase,
    const TopoDS_Face & Pbase,
    const TopoDS_Face & Skface,
    const double Angle,
    const int Fuse,
    const bool Modify )
    inline

    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

    ◆ BRepFeat_MakeDPrism() [2/2]

    BRepFeat_MakeDPrism::BRepFeat_MakeDPrism ( )
    inline

    Member Function Documentation

    ◆ Add()

    void BRepFeat_MakeDPrism::Add ( const TopoDS_Edge & E,
    const TopoDS_Face & OnFace )

    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.

    ◆ BarycCurve()

    occ::handle< Geom_Curve > BRepFeat_MakeDPrism::BarycCurve ( )
    overridevirtual

    Implements BRepFeat_Form.

    ◆ BossEdges()

    void BRepFeat_MakeDPrism::BossEdges ( const int sig)

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

    ◆ Curves()

    void BRepFeat_MakeDPrism::Curves ( NCollection_Sequence< occ::handle< Geom_Curve > > & S)
    overridevirtual

    Implements BRepFeat_Form.

    ◆ Init()

    void BRepFeat_MakeDPrism::Init ( const TopoDS_Shape & Sbase,
    const TopoDS_Face & Pbase,
    const TopoDS_Face & Skface,
    const double Angle,
    const int Fuse,
    const bool Modify )

    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.

    ◆ LatEdges()

    const NCollection_List< TopoDS_Shape > & BRepFeat_MakeDPrism::LatEdges ( )

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

    ◆ Perform() [1/3]

    void BRepFeat_MakeDPrism::Perform ( const double Height)

    ◆ Perform() [2/3]

    void BRepFeat_MakeDPrism::Perform ( const TopoDS_Shape & From,
    const TopoDS_Shape & Until )

    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.

    ◆ Perform() [3/3]

    void BRepFeat_MakeDPrism::Perform ( const TopoDS_Shape & Until)

    ◆ PerformFromEnd()

    void BRepFeat_MakeDPrism::PerformFromEnd ( const TopoDS_Shape & FUntil)

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

    ◆ PerformThruAll()

    void BRepFeat_MakeDPrism::PerformThruAll ( )

    Builds an infinite prism. The infinite descendants will not be kept in the result.

    ◆ PerformUntilEnd()

    void BRepFeat_MakeDPrism::PerformUntilEnd ( )

    Realizes a semi-infinite prism, limited by the position of the prism base.

    ◆ PerformUntilHeight()

    void BRepFeat_MakeDPrism::PerformUntilHeight ( const TopoDS_Shape & Until,
    const double Height )

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

    ◆ TopEdges()

    const NCollection_List< TopoDS_Shape > & BRepFeat_MakeDPrism::TopEdges ( )

    Returns the list of TopoDS Edges of the top of the boss.


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