src/TopOpeBRepTool/TopOpeBRepTool_CLASSI.cdl

   1 -- Created on: 1999-01-13
   2 -- Created by: Xuan PHAM PHU
   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
  22 class CLASSI from TopOpeBRepTool
  23 uses
  24     Shape from TopoDS,
  25     Face from TopoDS,
  26     Box2d from Bnd,
  27     ListOfShape from TopTools,
  28     DataMapOfShapeListOfShape from TopTools,
  29     face from TopOpeBRepTool,
  30     IndexedDataMapOfShapeBox2d from TopOpeBRepTool,
  31     DataMapOfShapeface from TopOpeBRepTool
  32 is
  33     Create returns CLASSI from TopOpeBRepTool;
  34
  35     Init2d(me : in out; Fref : Face from TopoDS);
  36     -- prequesitory : <Fref> is oriented FORWARD
  37
  38     HasInit2d(me) returns Boolean;
  39
  40     Add2d(me : in out; S : Shape from TopoDS)
  41     returns Boolean;
  42     -- Compute of 2d  bounding boxe for  shape <S>, stores the box in
  43     -- the map
  44
  45     GetBox2d(me : in out; S : Shape from TopoDS; Box2d : out Box2d from Bnd)
  46     returns Boolean;
  47     -- Compute of <Box2d> 2d bounding boxe for shape <S> if necessary (then
  48     -- stores it in the map).
  49
  50     ClassiBnd2d(me : in out; S1,S2 : Shape from TopoDS; tol: Real; checklarge: Boolean)
  51     returns Integer;
  52     -- Classification of 2drep(S1) with 2drep(S2) using their 2d bounding boxes
  53     -- if shapes are not stored in <mymapsbox2d>, compute the bounding boxes
  54     -- then stores them.
  55     -- Returns state :  0 : unknown
  56     --                 -1 : same
  57     --                 -2 : disjoints
  58     --                  1 : <S1> IN <S2>
  59     --                  2 : <S2> IN <S1>
  60
  61     Classip2d(me : in out; S1,S2 : Shape from TopoDS; stabnd2d12 : Integer)
  62     returns Integer;
  63     -- prequesitory : <S1> and <S2> are disjoint or connexed by
  64     --                vertices or edges,
  65     --                and classify(<S1>,<S2>) is in {0,-2,1,2}
  66     -- Classification of 2drep(S1) with 2drep(S2), using <stabnd2d12>
  67     -- (from ClassiBnd2d)
  68     -- update for <mymapsface>
  69
  70     Getface(me; S : Shape from TopoDS; fa : out face from TopOpeBRepTool)
  71     returns Boolean;
  72     -- Returns false if <S> is not bound in <mymapsface>
  73
  74     Classilist(me : in out; lS : ListOfShape from TopTools;
  75                mapgreasma : out DataMapOfShapeListOfShape from TopTools)
  76     returns Boolean;
  77     -- prequesitory : <lS> contains a list of wires built on <myFref>
  78     --
  79     -- Classification of wires of <lS>, filling up map <mapgreasma>
  80     -- <mapgreasma> = {(s,los) / shapes of los are IN s}
  81
  82 fields
  83     myFref       : Face from TopoDS;
  84     mymapsbox2d  : IndexedDataMapOfShapeBox2d from TopOpeBRepTool;
  85     mymapsface   : DataMapOfShapeface from TopOpeBRepTool;
  86
  87 end CLASSI;