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

    Rebuilds a Shape by making pre-defined substitutions on some of its components. More...

    #include <ShapeBuild_ReShape.hxx>

    Inheritance diagram for ShapeBuild_ReShape:

    Public Member Functions

     ShapeBuild_ReShape ()
     Returns an empty Reshape.
    virtual TopoDS_Shape Apply (const TopoDS_Shape &shape, const TopAbs_ShapeEnum until, const int buildmode)
     Applies the substitutions requests to a shape.
    TopoDS_Shape Apply (const TopoDS_Shape &shape, const TopAbs_ShapeEnum until=TopAbs_SHAPE) override
     Applies the substitutions requests to a shape.
    int Status (const TopoDS_Shape &shape, TopoDS_Shape &newsh, const bool last=false) override
     Returns a complete substitution status for a shape 0 : not recorded, <newsh> = original <shape> < 0: to be removed, <newsh> is NULL.
    virtual bool Status (const ShapeExtend_Status status) const
     Queries the status of last call to Apply(shape,enum) OK : no (sub)shapes replaced or removed DONE1: source (starting) shape replaced DONE2: source (starting) shape removed DONE3: some subshapes replaced DONE4: some subshapes removed FAIL1: some replacements not done because of bad type of subshape.
    Public Member Functions inherited from BRepTools_ReShape
     BRepTools_ReShape ()
     Returns an empty Reshape.
    virtual void Clear ()
     Clears all substitutions requests.
    virtual void Remove (const TopoDS_Shape &shape)
     Sets a request to Remove a Shape whatever the orientation.
    virtual void Replace (const TopoDS_Shape &shape, const TopoDS_Shape &newshape)
     Sets a request to Replace a Shape by a new one.
    template<typename TCollection>
    void Merge (const TCollection &theParts, const TopoDS_Shape &theProduct)
     Merges the parts to the single product. The first part is replaced by the product. The other parts are removed. The history of the merged shapes is presented by equal ways.
    virtual bool IsRecorded (const TopoDS_Shape &shape) const
     Tells if a shape is recorded for Replace/Remove.
    virtual TopoDS_Shape Value (const TopoDS_Shape &shape) const
     Returns the new value for an individual shape If not recorded, returns the original shape itself If to be Removed, returns a Null Shape Else, returns the replacing item.
    TopoDS_Shape ValueLeaf (const TopoDS_Shape &theShape) const
     Follows the replacement chain for theShape to its leaf without descending into sub-shapes. Iterates Value() until a fixpoint is reached. Unlike Apply(), this does not rebuild the shape from its children, so it is safe to call on edges/wires whose sub-shapes have their own pending replacements (avoids cascading sub-shape re-expansion).
    virtual bool & ModeConsiderLocation ()
     Returns (modifiable) the flag which defines whether Location of shape take into account during replacing shapes.
    TopoDS_Vertex CopyVertex (const TopoDS_Vertex &theV, const double theTol=-1.0)
     Returns modified copy of vertex if original one is not recorded or returns modified original vertex otherwise.
    TopoDS_Vertex CopyVertex (const TopoDS_Vertex &theV, const gp_Pnt &theNewPos, const double aTol)
     Returns modified copy of vertex if original one is not recorded or returns modified original vertex otherwise.
    bool IsNewShape (const TopoDS_Shape &theShape) const
     Checks if shape has been recorded by reshaper as a value.
    occ::handle< BRepTools_HistoryHistory () const
     Returns the history of the substituted shapes.
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transientoperator= (const Standard_Transient &)
     Assignment operator, needed to avoid copying reference counter.
    virtual ~Standard_Transient ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool IsKind (const opencascade::handle< Standard_Type > &theType) const
     Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    bool IsKind (const char *const theTypeName) const
     Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    Standard_TransientThis () const
     Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    static constexpr const char * get_type_name ()
     Returns a type descriptor about this object.
    static const opencascade::handle< Standard_Type > & get_type_descriptor ()
     Returns type descriptor of Standard_Transient class.
    Protected Types inherited from BRepTools_ReShape
    enum  TReplacementKind { TReplacementKind_Remove = 1 , TReplacementKind_Modify = 2 , TReplacementKind_Merge_Main = 4 , TReplacementKind_Merge_Ordinary = 8 }
     The kinds of the replacements. More...
    Protected Member Functions inherited from BRepTools_ReShape
    virtual void replace (const TopoDS_Shape &shape, const TopoDS_Shape &newshape, const TReplacementKind theKind)
     Replaces the first shape by the second one after the following reorientation.
    TopoDS_Shape applyImpl (const TopoDS_Shape &theShape, const TopAbs_ShapeEnum theUntil, NCollection_Map< occ::handle< TopoDS_TShape > > &theInFlight)
     Recursive worker for Apply with a DFS in-flight set keyed by TShape handle. Prevents unbounded descent when a replacement is a compound that transitively contains the original shape as a sub-shape (cyclic containment, distinct from cycles in the replacement map itself).
    Protected Attributes inherited from BRepTools_ReShape
    NCollection_Map< TopoDS_Shape, TopTools_ShapeMapHashermyNewShapes
    int myStatus

    Detailed Description

    Rebuilds a Shape by making pre-defined substitutions on some of its components.

    In a first phase, it records requests to replace or remove some individual shapes For each shape, the last given request is recorded Requests may be applied "Oriented" (i.e. only to an item with the SAME orientation) or not (the orientation of replacing shape is respectful of that of the original one)

    Then, these requests may be applied to any shape which may contain one or more of these individual shapes

    Constructor & Destructor Documentation

    ◆ ShapeBuild_ReShape()

    ShapeBuild_ReShape::ShapeBuild_ReShape ( )

    Returns an empty Reshape.

    Member Function Documentation

    ◆ Apply() [1/2]

    virtual TopoDS_Shape ShapeBuild_ReShape::Apply ( const TopoDS_Shape & shape,
    const TopAbs_ShapeEnum until,
    const int buildmode )
    virtual

    Applies the substitutions requests to a shape.

    <until> gives the level of type until which requests are taken into account. For subshapes of the type <until> no rebuild and further exploring are done. ACTUALLY, NOT IMPLEMENTED BELOW TopAbs_FACE

    <buildmode> says how to do on a SOLID,SHELL ... if one of its sub-shapes has been changed: 0: at least one Replace or Remove -> COMPOUND, else as such 1: at least one Remove (Replace are ignored) -> COMPOUND 2: Replace and Remove are both ignored If Replace/Remove are ignored or absent, the result as same type as the starting shape

    ◆ Apply() [2/2]

    TopoDS_Shape ShapeBuild_ReShape::Apply ( const TopoDS_Shape & shape,
    const TopAbs_ShapeEnum until = TopAbs_SHAPE )
    overridevirtual

    Applies the substitutions requests to a shape.

    <until> gives the level of type until which requests are taken into account. For subshapes of the type <until> no rebuild and further exploring are done.

    NOTE: each subshape can be replaced by shape of the same type or by shape containing only shapes of that type (for example, TopoDS_Edge can be replaced by TopoDS_Edge, TopoDS_Wire or TopoDS_Compound containing TopoDS_Edges). If incompatible shape type is encountered, it is ignored and flag FAIL1 is set in Status.

    Reimplemented from BRepTools_ReShape.

    ◆ Status() [1/2]

    virtual bool ShapeBuild_ReShape::Status ( const ShapeExtend_Status status) const
    virtual

    Queries the status of last call to Apply(shape,enum) OK : no (sub)shapes replaced or removed DONE1: source (starting) shape replaced DONE2: source (starting) shape removed DONE3: some subshapes replaced DONE4: some subshapes removed FAIL1: some replacements not done because of bad type of subshape.

    ◆ Status() [2/2]

    int ShapeBuild_ReShape::Status ( const TopoDS_Shape & shape,
    TopoDS_Shape & newsh,
    const bool last = false )
    overridevirtual

    Returns a complete substitution status for a shape 0 : not recorded, <newsh> = original <shape> < 0: to be removed, <newsh> is NULL.

    0: to be replaced, <newsh> is a new item If <last> is False, returns status and new shape recorded in the map directly for the shape, if True and status > 0 then recursively searches for the last status and new shape.

    Reimplemented from BRepTools_ReShape.


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