src/ShapeUpgrade/ShapeUpgrade_RemoveLocations.cdl

   1 -- Created on: 2002-11-13
   2 -- Created by: Galina KULIKOVA
   3 -- Copyright (c) 2002-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 class RemoveLocations from ShapeUpgrade inherits TShared from MMgt
  17
  18         ---Purpose: Removes all locations sub-shapes of specified shape
  19
  20 uses
  21     ShapeEnum from TopAbs,
  22     Shape from TopoDS,
  23     MapOfShape from TopTools,
  24     DataMapOfShapeShape from TopTools
  25 is
  26     Create returns RemoveLocations from ShapeUpgrade;
  27         ---Purpose:Empy constructor
  28
  29     Remove(me : mutable;theShape : Shape from TopoDS) returns Boolean;
  30         ---Purpose:Removes all location correspodingly to RemoveLevel.
  31
  32     MakeNewShape(me : mutable;theShape , theAncShape: Shape from TopoDS;
  33                  theNewShape:in out Shape from TopoDS;theRemoveLoc : Boolean)
  34                      returns Boolean is private;
  35
  36     GetResult(me) returns Shape from TopoDS;
  37         ---Purpose:Returns shape with removed locatins.
  38         ---C++: inline
  39
  40     SetRemoveLevel(me: mutable; theLevel : ShapeEnum from TopAbs);
  41         ---Purpose:sets level starting with that location will be removed,
  42         --         by default TopAbs_SHAPE. In this case locations will be kept for specified shape
  43         --         and if specified shape is TopAbs_COMPOUND for sub-shapes of first level.
  44         ---C++: inline
  45
  46     RemoveLevel(me) returns ShapeEnum from TopAbs;
  47         ---Purpose:sets level starting with that location will be removed.Value of level can be set to
  48         --         TopAbs_SHAPE,TopAbs_COMPOUND,TopAbs_SOLID,TopAbs_SHELL,TopAbs_FACE.By default TopAbs_SHAPE.
  49         --         In this case location will be removed for all shape types for exception of compound.
  50         ---C++: inline
  51
  52
  53     ModifiedShape (me; theInitShape : Shape from TopoDS) returns Shape from TopoDS;
  54         ---Purpose: Returns modified shape obtained from initial shape.
  55         ---C++: inline
  56
  57 fields
  58     myLevelRemoving : ShapeEnum from TopAbs;
  59     myShape : Shape from TopoDS;
  60     myMapNewShapes : DataMapOfShapeShape from TopTools;
  61
  62 end RemoveLocations;