OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    BRepBuilderAPI_ModifyShape Class Reference

    Implements the methods of MakeShape for the constant topology modifications. The methods are implemented when the modification uses a Modifier from BRepTools. Some of them have to be redefined if the modification is implemented with another tool (see Transform from BRepBuilderAPI for example). The BRepBuilderAPI package provides the following frameworks to perform modifications of this sort: More...

    #include <BRepBuilderAPI_ModifyShape.hxx>

    Inheritance diagram for BRepBuilderAPI_ModifyShape:

    Public Member Functions

    const NCollection_List< TopoDS_Shape > & Modified (const TopoDS_Shape &S) override
     Returns the list of shapes modified from the shape .
    virtual TopoDS_Shape ModifiedShape (const TopoDS_Shape &S) const
     Returns the modified shape corresponding to . S can correspond to the entire initial shape or to its subshape. Exceptions Standard_NoSuchObject if S is not the initial shape or a subshape of the initial shape to which the transformation has been applied. Raises NoSuchObject from Standard if S is not the initial shape or a sub-shape of the initial shape.
    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_ShapeShape ()
     Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built.
     operator TopoDS_Shape ()
    virtual const NCollection_List< TopoDS_Shape > & Generated (const TopoDS_Shape &S)
     Returns the list of shapes generated from the shape .
    virtual bool IsDeleted (const TopoDS_Shape &S)
     Returns true if the shape S has been deleted.
    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

     BRepBuilderAPI_ModifyShape ()
     Empty constructor.
     BRepBuilderAPI_ModifyShape (const TopoDS_Shape &S)
     Initializes the modifier with the Shape , and set the field <myInitialShape> to .
     BRepBuilderAPI_ModifyShape (const occ::handle< BRepTools_Modification > &M)
     Set the field <myModification> with <M>.
     BRepBuilderAPI_ModifyShape (const TopoDS_Shape &S, const occ::handle< BRepTools_Modification > &M)
     Initializes the modifier with the Shape , and set the field <myInitialShape> to , and set the field <myModification> with <M>, the performs the modification.
    void DoModif (const TopoDS_Shape &S)
     Performs the previously given modification on the shape .
    void DoModif (const occ::handle< BRepTools_Modification > &M)
     Performs the modification <M> on a previously given shape.
    void DoModif (const TopoDS_Shape &S, const occ::handle< BRepTools_Modification > &M)
     Performs the modification <M> on the shape .
    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

    BRepTools_Modifier myModifier
    TopoDS_Shape myInitialShape
    occ::handle< BRepTools_ModificationmyModification
    Protected Attributes inherited from BRepBuilderAPI_MakeShape
    TopoDS_Shape myShape
    NCollection_List< TopoDS_ShapemyGenerated

    Detailed Description

    Implements the methods of MakeShape for the constant topology modifications. The methods are implemented when the modification uses a Modifier from BRepTools. Some of them have to be redefined if the modification is implemented with another tool (see Transform from BRepBuilderAPI for example). The BRepBuilderAPI package provides the following frameworks to perform modifications of this sort:

    Constructor & Destructor Documentation

    ◆ BRepBuilderAPI_ModifyShape() [1/4]

    BRepBuilderAPI_ModifyShape::BRepBuilderAPI_ModifyShape ( )
    protected

    Empty constructor.

    ◆ BRepBuilderAPI_ModifyShape() [2/4]

    BRepBuilderAPI_ModifyShape::BRepBuilderAPI_ModifyShape ( const TopoDS_Shape & S)
    protected

    Initializes the modifier with the Shape , and set the field <myInitialShape> to .

    ◆ BRepBuilderAPI_ModifyShape() [3/4]

    BRepBuilderAPI_ModifyShape::BRepBuilderAPI_ModifyShape ( const occ::handle< BRepTools_Modification > & M)
    protected

    Set the field <myModification> with <M>.

    ◆ BRepBuilderAPI_ModifyShape() [4/4]

    BRepBuilderAPI_ModifyShape::BRepBuilderAPI_ModifyShape ( const TopoDS_Shape & S,
    const occ::handle< BRepTools_Modification > & M )
    protected

    Initializes the modifier with the Shape , and set the field <myInitialShape> to , and set the field <myModification> with <M>, the performs the modification.

    Member Function Documentation

    ◆ DoModif() [1/3]

    void BRepBuilderAPI_ModifyShape::DoModif ( const occ::handle< BRepTools_Modification > & M)
    protected

    Performs the modification <M> on a previously given shape.

    ◆ DoModif() [2/3]

    void BRepBuilderAPI_ModifyShape::DoModif ( const TopoDS_Shape & S)
    protected

    Performs the previously given modification on the shape .

    ◆ DoModif() [3/3]

    void BRepBuilderAPI_ModifyShape::DoModif ( const TopoDS_Shape & S,
    const occ::handle< BRepTools_Modification > & M )
    protected

    Performs the modification <M> on the shape .

    ◆ Modified()

    const NCollection_List< TopoDS_Shape > & BRepBuilderAPI_ModifyShape::Modified ( const TopoDS_Shape & S)
    overridevirtual

    Returns the list of shapes modified from the shape .

    Reimplemented from BRepBuilderAPI_MakeShape.

    Reimplemented in BRepBuilderAPI_NurbsConvert, BRepBuilderAPI_Transform, and BRepOffsetAPI_DraftAngle.

    ◆ ModifiedShape()

    virtual TopoDS_Shape BRepBuilderAPI_ModifyShape::ModifiedShape ( const TopoDS_Shape & S) const
    virtual

    Returns the modified shape corresponding to . S can correspond to the entire initial shape or to its subshape. Exceptions Standard_NoSuchObject if S is not the initial shape or a subshape of the initial shape to which the transformation has been applied. Raises NoSuchObject from Standard if S is not the initial shape or a sub-shape of the initial shape.

    Reimplemented in BRepBuilderAPI_GTransform, BRepBuilderAPI_NurbsConvert, BRepBuilderAPI_Transform, and BRepOffsetAPI_DraftAngle.

    Field Documentation

    ◆ myInitialShape

    TopoDS_Shape BRepBuilderAPI_ModifyShape::myInitialShape
    protected

    ◆ myModification

    occ::handle<BRepTools_Modification> BRepBuilderAPI_ModifyShape::myModification
    protected

    ◆ myModifier

    BRepTools_Modifier BRepBuilderAPI_ModifyShape::myModifier
    protected

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