src/ShapeUpgrade/ShapeUpgrade_RemoveInternalWires.hxx

   1 // Created on: 2006-08-10
   2 // Created by: Galina KULIKOVA
   3 // Copyright (c) 2006-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef _ShapeUpgrade_RemoveInternalWires_HeaderFile
  17 #define _ShapeUpgrade_RemoveInternalWires_HeaderFile
  18
  19 #include <Standard.hxx>
  20 #include <Standard_Type.hxx>
  21
  22 #include <TopoDS_Shape.hxx>
  23 #include <Standard_Real.hxx>
  24 #include <Standard_Boolean.hxx>
  25 #include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
  26 #include <TopTools_DataMapOfShapeListOfShape.hxx>
  27 #include <TopTools_SequenceOfShape.hxx>
  28 #include <Standard_Integer.hxx>
  29 #include <ShapeUpgrade_Tool.hxx>
  30 #include <ShapeExtend_Status.hxx>
  31 class TopoDS_Shape;
  32
  33
  34 class ShapeUpgrade_RemoveInternalWires;
  35 DEFINE_STANDARD_HANDLE(ShapeUpgrade_RemoveInternalWires, ShapeUpgrade_Tool)
  36
  37 //! Removes all internal wires having area less than specified min area
  38 class ShapeUpgrade_RemoveInternalWires : public ShapeUpgrade_Tool
  39 {
  40
  41 public:
  42
  43
  44   //! Creates empty  constructor.
  45   Standard_EXPORT ShapeUpgrade_RemoveInternalWires();
  46
  47   Standard_EXPORT ShapeUpgrade_RemoveInternalWires(const TopoDS_Shape& theShape);
  48
  49   //! Initialize by a Shape.
  50   Standard_EXPORT void Init (const TopoDS_Shape& theShape);
  51
  52   //! Removes all internal wires having area less than area specified as minimal allowed area
  53   Standard_EXPORT Standard_Boolean Perform();
  54
  55   //! If specified sequence of shape contains -
  56   //! 1.wires then these wires will be removed if they have area less than allowed min area.
  57   //! 2.faces than internal wires from these faces will be removed if they have area less than allowed min area.
  58   Standard_EXPORT Standard_Boolean Perform (const TopTools_SequenceOfShape& theSeqShapes);
  59
  60   //! Get result shape
  61     TopoDS_Shape GetResult() const;
  62
  63   //! Set min area allowed for holes( all holes having area less than mi area will be removed)
  64     Standard_Real& MinArea();
  65
  66   //! Set mode which manage removing faces which have outer wires consisting only from edges
  67   //! belonginig to removed internal wires.
  68   //! By default it is equal to true.
  69     Standard_Boolean& RemoveFaceMode();
  70
  71   //! Returns sequence of removed faces.
  72     const TopTools_SequenceOfShape& RemovedFaces() const;
  73
  74   //! Returns sequence of removed faces.
  75     const TopTools_SequenceOfShape& RemovedWires() const;
  76
  77   //! Queries status of last call to Perform()
  78   //! : OK - nothing was done
  79   //! :DONE1 - internal wires were removed
  80   //! :DONE2 - small faces were removed.
  81   //! :FAIL1 - initial shape is not specified
  82   //! :FAIL2 - specified sub-shape is not belonged to inotial shape.
  83     Standard_Boolean Status (const ShapeExtend_Status theStatus) const;
  84
  85
  86
  87
  88   DEFINE_STANDARD_RTTIEXT(ShapeUpgrade_RemoveInternalWires,ShapeUpgrade_Tool)
  89
  90 protected:
  91
  92
  93   //! Clear all sequences and temporary map;
  94   Standard_EXPORT void Clear();
  95
  96   Standard_Integer myStatus;
  97
  98
  99 private:
 100
 101
 102   //! Removes internal wires having area of contour less than specified MinArea
 103   Standard_EXPORT void removeSmallWire (const TopoDS_Shape& theFace, const TopoDS_Shape& theWire);
 104
 105   //! Removes faces having outer wire consisting
 106   //! from removed edges(belonging small internal wires)
 107   Standard_EXPORT void removeSmallFaces();
 108
 109   TopoDS_Shape myShape;
 110   TopoDS_Shape myResult;
 111   Standard_Real myMinArea;
 112   Standard_Boolean myRemoveFacesMode;
 113   TopTools_IndexedDataMapOfShapeListOfShape myEdgeFaces;
 114   TopTools_DataMapOfShapeListOfShape myRemoveEdges;
 115   TopTools_SequenceOfShape myRemovedFaces;
 116   TopTools_SequenceOfShape myRemoveWires;
 117
 118
 119 };
 120
 121
 122 #include <ShapeUpgrade_RemoveInternalWires.lxx>
 123
 124
 125
 126
 127
 128 #endif // _ShapeUpgrade_RemoveInternalWires_HeaderFile