EIC code displayed by LXR master/​include/​opencascade/​BRepTools_ReShape.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2026-09-13 09:15:59

 // Created on: 1998-06-03
 // Created by: data exchange team
 // Copyright (c) 1998-1999 Matra Datavision
 // Copyright (c) 1999-2014 OPEN CASCADE SAS
 //
 // This file is part of Open CASCADE Technology software library.
 //
 // This library is free software; you can redistribute it and/or modify it under
 // the terms of the GNU Lesser General Public License version 2.1 as published
 // by the Free Software Foundation, with special exception defined in the file
 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
 // distribution for complete text of the license and disclaimer of any warranty.
 //
 // Alternatively, this file may be used under the terms of Open CASCADE
 // commercial license or contractual agreement.
 
 #ifndef _BRepTools_ReShape_HeaderFile
 #define _BRepTools_ReShape_HeaderFile
 
 #include <BRepTools_History.hxx>
 
 #include <TopoDS_Shape.hxx>
 #include <TopoDS_TShape.hxx>
 #include <TopTools_ShapeMapHasher.hxx>
 #include <NCollection_DataMap.hxx>
 #include <NCollection_Map.hxx>
 #include <Standard_Integer.hxx>
 #include <Standard_Transient.hxx>
 #include <TopAbs_ShapeEnum.hxx>
 
 class TopoDS_Vertex;
 
 // resolve name collisions with X11 headers
 #ifdef Status
   #undef Status
 #endif
 
 //! 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
 //!
 //! Supports the 'BRepTools_History' history by method 'History'.
 class BRepTools_ReShape : public Standard_Transient
 {
 public:
   //! Returns an empty Reshape
   Standard_EXPORT BRepTools_ReShape();
 
   //! Clears all substitutions requests
   Standard_EXPORT virtual void Clear();
 
   //! Sets a request to Remove a Shape whatever the orientation
   Standard_EXPORT virtual void Remove(const TopoDS_Shape& shape);
 
   //! Sets a request to Replace a Shape by a new one.
   virtual void Replace(const TopoDS_Shape& shape, const TopoDS_Shape& newshape)
   {
     replace(shape, newshape, TReplacementKind_Modify);
   }
 
   //! 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.
   template <typename TCollection>
   void Merge(const TCollection& theParts, const TopoDS_Shape& theProduct)
   {
     typename TCollection::Iterator aPIt(theParts);
 
     if (aPIt.More())
     {
       replace(aPIt.Value(), theProduct, TReplacementKind_Merge_Main);
 
       aPIt.Next();
     }
 
     const TReplacementKind aKind = TReplacementKind_Merge_Ordinary;
     for (; aPIt.More(); aPIt.Next())
     {
       replace(aPIt.Value(), theProduct, aKind);
     }
   }
 
   //! Tells if a shape is recorded for Replace/Remove
   Standard_EXPORT virtual bool IsRecorded(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
   Standard_EXPORT virtual TopoDS_Shape Value(const TopoDS_Shape& shape) const;
 
   //! Follows the replacement chain for @p 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).
   //! @return the final replacement, or the original shape if not recorded,
   //!         or a Null shape if the chain terminates in a Remove.
   Standard_EXPORT TopoDS_Shape ValueLeaf(const TopoDS_Shape& theShape) const;
 
   //! 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.
   Standard_EXPORT virtual int Status(const TopoDS_Shape& shape,
                                      TopoDS_Shape&       newsh,
                                      const bool          last = false);
 
   //! Applies the substitutions requests to a shape.
   //!
   //! theUntil 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.
   Standard_EXPORT virtual TopoDS_Shape Apply(const TopoDS_Shape&    theShape,
                                              const TopAbs_ShapeEnum theUntil = TopAbs_SHAPE);
 
   //! Returns (modifiable) the flag which defines whether Location of shape take into account
   //! during replacing shapes.
   virtual bool& ModeConsiderLocation() { return myConsiderLocation; }
 
   //! Returns modified copy of vertex if original one is not recorded or returns modified original
   //! vertex otherwise.
   //@param theV - original vertex.
   //@param theTol - new tolerance of vertex, optional.
   Standard_EXPORT 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.
   //@param theV - original vertex.
   //@param theNewPos - new position for vertex copy.
   //@param theTol - new tolerance of vertex.
   Standard_EXPORT TopoDS_Vertex CopyVertex(const TopoDS_Vertex& theV,
                                            const gp_Pnt&        theNewPos,
                                            const double         aTol);
 
   //! Checks if shape has been recorded by reshaper as a value
   //@param theShape is the given shape
   Standard_EXPORT bool IsNewShape(const TopoDS_Shape& theShape) const;
 
   //! Returns the history of the substituted shapes.
   Standard_EXPORT occ::handle<BRepTools_History> History() const;
 
   DEFINE_STANDARD_RTTIEXT(BRepTools_ReShape, Standard_Transient)
 
 protected:
   //! The kinds of the replacements.
   enum TReplacementKind
   {
     TReplacementKind_Remove         = 1,
     TReplacementKind_Modify         = 2,
     TReplacementKind_Merge_Main     = 4,
     TReplacementKind_Merge_Ordinary = 8
   };
 
   //! Replaces the first shape by the second one
   //! after the following reorientation.
   //!
   //! If the first shape has the reversed orientation
   //! then the both shapes are reversed.
   //! If the first shape has the internal or external orientation then:
   //! - the second shape is oriented forward (reversed) if it's orientation
   //!   is equal (not equal) to the orientation of the first shape;
   //! - the first shape is oriented forward.
   Standard_EXPORT virtual void replace(const TopoDS_Shape&    shape,
                                        const TopoDS_Shape&    newshape,
                                        const TReplacementKind theKind);
 
   //! 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).
   Standard_EXPORT TopoDS_Shape applyImpl(const TopoDS_Shape&                          theShape,
                                          const TopAbs_ShapeEnum                       theUntil,
                                          NCollection_Map<occ::handle<TopoDS_TShape>>& theInFlight);
 
 private:
   //! Returns 'true' if the kind of a replacement is an ordinary merging.
   static bool isOrdinaryMerged(const TReplacementKind theKind)
   {
     return (theKind == TReplacementKind_Merge_Ordinary);
   }
 
   //! A replacement of an initial shape.
   struct TReplacement
   {
   public:
     //! The default constructor.
     TReplacement()
         : myKind(TReplacementKind_Remove)
     {
     }
 
     //! The initializing constructor.
     TReplacement(const TopoDS_Shape& theResult, const TReplacementKind theKind)
         : myResult(theResult),
           myKind(theKind)
     {
     }
 
     //! Returns the result of the replacement.
     TopoDS_Shape Result() const
     {
       return (myKind != TReplacementKind_Merge_Ordinary) ? myResult : TopoDS_Shape();
     }
 
     //! Returns the result of the relation.
     const TopoDS_Shape& RelationResult() const { return myResult; }
 
     //! Returns the kind of the relation
     //! between an initial shape and the result of the replacement.
     BRepTools_History::TRelationType RelationKind() const
     {
       return (myKind == TReplacementKind_Remove) ? BRepTools_History::TRelationType_Removed
                                                  : BRepTools_History::TRelationType_Modified;
     }
 
   private:
     TopoDS_Shape     myResult; //!< The result of the replacement.
     TReplacementKind myKind;   //!< The kind of the replacement.
   };
 
   typedef NCollection_DataMap<TopoDS_Shape, TReplacement, TopTools_ShapeMapHasher>
     TShapeToReplacement;
 
 private:
   //! Maps each shape to its replacement.
   //! If a shape is not bound to the map then the shape is replaced by itself.
   TShapeToReplacement myShapeToReplacement;
 
 protected:
   NCollection_Map<TopoDS_Shape, TopTools_ShapeMapHasher> myNewShapes;
   int                                                    myStatus;
 
 private:
   bool myConsiderLocation;
 };
 
 #endif // _BRepTools_ReShape_HeaderFile

This page was automatically generated by the 2.3.7 LXR engine. The LXR team