src/QANewBRepNaming/QANewBRepNaming_Loader.cdl

   1 -- Created on: 1999-10-25
   2 -- Created by: Sergey ZARITCHNY <szy@philipox.nnov.matra-dtv.fr>
   3 -- Copyright (c) 1999 Matra Datavision
   4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21 class Loader from QANewBRepNaming
  22
  23         ---Purpose:
  24
  25 uses MakeShape      from BRepBuilderAPI,
  26      Shape          from TopoDS,
  27      Edge           from TopoDS,
  28      ShapeEnum      from TopAbs,
  29      Builder        from TNaming,
  30      DataMapOfShapeShape from TopTools,
  31      MapOfShape     from TopTools,
  32      Label          from TDF,
  33      TagSource      from TDF
  34
  35 is
  36
  37     LoadGeneratedShapes (myclass;
  38                          MakeShape          : in out MakeShape from BRepBuilderAPI;
  39                          ShapeIn       : in     Shape     from TopoDS;
  40                          GeneratedFrom : in     ShapeEnum from TopAbs;
  41                          Buider        : in out Builder   from TNaming);
  42         ---Purpose :  Load in   the naming data-structure   the  shape
  43         --          generated  from FACE,  EDGE, VERTEX,..., after the
  44         --          MakeShape   operation.  <ShapeIn>  is  the initial
  45         --          shape.   <GeneratedFrom>   defines  the   kind  of
  46         --          shape generation    to    record  in   the  naming
  47         --          data-structure. The <builder> is used to store the
  48         --          set of evolutions in the data-framework of TDF.
  49
  50
  51     LoadModifiedShapes (myclass;
  52                         MakeShape          : in out MakeShape from BRepBuilderAPI;
  53                         ShapeIn      : in     Shape     from TopoDS;
  54                         ModifiedFrom : in     ShapeEnum from TopAbs;
  55                         Buider       : in out Builder   from TNaming;
  56                         theBool      : Boolean from Standard = Standard_False);
  57         ---Purpose  : Load in the naming data-structure the shape
  58         --              modified from FACE, EDGE, VERTEX,...,
  59         --              after the MakeShape operation.
  60         --            <ShapeIn> is the initial shape.
  61         --            <ModifiedFrom> defines the kind of shape modification
  62         --              to record in the naming data-structure.
  63         --            The <builder> is used to store the set of evolutions
  64         --              in the data-framework of TDF.
  65
  66    LoadDeletedShapes (myclass;
  67                       MakeShape          : in out MakeShape from BRepBuilderAPI;
  68                       ShapeIn            : in     Shape     from TopoDS;
  69                       KindOfDeletedShape : in     ShapeEnum from TopAbs;
  70                       Buider             : in out Builder   from TNaming);
  71         ---Purpose : Load in the naming data-structure the shape
  72         --             deleted after the MakeShape operation.
  73         --           <ShapeIn> is the initial shape.
  74         --           <KindOfDeletedShape> defines the kind of
  75         --             deletion to record in the naming data-structure.
  76         --           The <builder> is used to store the set of evolutions
  77         --             in the data-framework of TDF.
  78
  79     LoadAndOrientGeneratedShapes (myclass;
  80       MakeShape          : in out MakeShape from BRepBuilderAPI;
  81       ShapeIn            : in     Shape               from TopoDS;
  82       GeneratedFrom      : in     ShapeEnum           from TopAbs;
  83       Buider             : in out Builder             from TNaming;
  84       SubShapesOfResult  : in     DataMapOfShapeShape from TopTools);
  85       ---Purpose  : The same as LoadGeneratedShapes plus performs orientation of
  86       --           loaded shapes according orientation of SubShapes
  87
  88
  89     LoadAndOrientModifiedShapes (myclass;
  90       MakeShape          : in out MakeShape from BRepBuilderAPI;
  91       ShapeIn            : in     Shape               from TopoDS;
  92       ModifiedFrom       : in     ShapeEnum           from TopAbs;
  93       Buider             : in out Builder             from TNaming;
  94       SubShapesOfResult  : in     DataMapOfShapeShape from TopTools);
  95       ---Purpose  : The same as LoadModifiedShapes plus performs orientation of
  96       --            loaded shapes according orientation of SubShapes
  97
  98
  99     ModifyPart (myclass;
 100                 PartShape  : in     Shape    from TopoDS;
 101                 Primitive  : in     Shape    from TopoDS;
 102                 Label      : in     Label    from TDF);
 103         ---Category: Tool
 104         ---Level: Internal
 105
 106     HasDangleShapes(myclass; ShapeIn : in Shape from TopoDS)
 107     returns Boolean from Standard;
 108
 109     LoadGeneratedDangleShapes(myclass;
 110                               ShapeIn       : in     Shape from TopoDS;
 111                               GeneratedFrom : in     ShapeEnum from TopAbs;
 112                               GenBuider     : in out Builder from TNaming);
 113
 114     LoadGeneratedDangleShapes(myclass;
 115                               ShapeIn       : in     Shape from TopoDS;
 116                               GeneratedFrom : in     ShapeEnum from TopAbs;
 117                               OnlyThese     : in     MapOfShape from TopTools;
 118                               GenBuider     : in out Builder from TNaming);
 119
 120     LoadModifiedDangleShapes(myclass;
 121                              MakeShape     : in out MakeShape from BRepBuilderAPI;
 122                              ShapeIn       : in     Shape from TopoDS;
 123                              GeneratedFrom : in     ShapeEnum from TopAbs;
 124                              GenBuider     : in out Builder from TNaming);
 125
 126     LoadDeletedDangleShapes(myclass;
 127                             MakeShape     : in out MakeShape from BRepBuilderAPI;
 128                             ShapeIn       : in     Shape from TopoDS;
 129                             ShapeType     : in     ShapeEnum from TopAbs;
 130                             DelBuider     : in out Builder from TNaming);
 131
 132     LoadDangleShapes(myclass;
 133                      theShape : Shape from TopoDS;
 134                      theLabelGenerator : Label from TDF);
 135
 136     LoadDangleShapes(myclass;
 137                      theShape : Shape from TopoDS;
 138                      ignoredShape : Shape from TopoDS;
 139                      theLabelGenerator : Label from TDF);
 140
 141     GetDangleShapes(myclass;
 142                     ShapeIn : Shape from TopoDS;
 143                     GeneratedFrom : ShapeEnum from TopAbs;
 144                     Dangles : out DataMapOfShapeShape from TopTools)
 145     ---Purpose: Returns dangle sub shapes Generator - Dangle.
 146     returns Boolean from Standard;
 147
 148     GetDangleShapes(myclass;
 149                     ShapeIn : Shape from TopoDS;
 150                     GeneratedFrom : ShapeEnum from TopAbs;
 151                     Dangles : out MapOfShape from TopTools)
 152     ---Purpose: Returns dangle sub shapes.
 153     returns Boolean from Standard;
 154
 155     IsDangle(myclass;
 156              theDangle : Shape from TopoDS;
 157              theShape : Shape from TopoDS)
 158     ---Warning!: Don't use this method inside an iteration process!
 159     returns Boolean from Standard;
 160
 161 end Loader;