src/GEOMAlgo/GEOMAlgo_ShapeInfo.cdl

   1 --  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
   2 --
   3 --  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 --  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 --
   6 --  This library is free software; you can redistribute it and/or
   7 --  modify it under the terms of the GNU Lesser General Public
   8 --  License as published by the Free Software Foundation; either
   9 --  version 2.1 of the License.
  10 --
  11 --  This library is distributed in the hope that it will be useful,
  12 --  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 --  Lesser General Public License for more details.
  15 --
  16 --  You should have received a copy of the GNU Lesser General Public
  17 --  License along with this library; if not, write to the Free Software
  18 --  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 --
  20 --  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 --
  22 --  File:       GEOMAlgo_ShapeInfo.cdl
  23 --  Created:    Mon Apr  2 14:04:24 2007
  24 --  Author:     Peter KURNEV
  25 --
  26 class ShapeInfo from GEOMAlgo
  27
  28         ---Purpose:
  29
  30 uses
  31     Pnt from gp,
  32     Dir from gp,
  33     Ax2 from gp,
  34     Ax3 from gp,
  35
  36     ShapeEnum from TopAbs,
  37     Shape from TopoDS,
  38
  39     KindOfShape   from GEOMAlgo,
  40     KindOfBounds  from GEOMAlgo,
  41     KindOfClosed  from GEOMAlgo,
  42     KindOfName from GEOMAlgo
  43 --raises
  44
  45 is
  46     Create
  47         returns ShapeInfo from GEOMAlgo;
  48     ---C++: alias "Standard_EXPORT virtual ~GEOMAlgo_ShapeInfo();"
  49
  50     Reset(me:out);
  51
  52     SetType(me:out;
  53             aType:ShapeEnum from TopAbs);
  54
  55     Type(me)
  56         returns ShapeEnum from TopAbs;
  57
  58     SetNbSubShapes(me:out;
  59             aType:ShapeEnum from TopAbs;
  60             aNb  :Integer from Standard);
  61
  62     NbSubShapes(me;
  63             aType:ShapeEnum from TopAbs)
  64         returns Integer from Standard;
  65
  66     SetKindOfShape (me:out;
  67             aT:KindOfShape from GEOMAlgo);
  68
  69     KindOfShape (me)
  70          returns KindOfShape from GEOMAlgo;
  71
  72     SetKindOfName (me:out;
  73             aT: KindOfName from GEOMAlgo);
  74
  75     KindOfName(me)
  76          returns KindOfName from GEOMAlgo;
  77
  78     SetKindOfBounds (me:out;
  79             aT:KindOfBounds from GEOMAlgo);
  80
  81     KindOfBounds (me)
  82          returns KindOfBounds from GEOMAlgo;
  83
  84     SetKindOfClosed (me:out;
  85             aT:KindOfClosed from GEOMAlgo);
  86
  87     KindOfClosed(me)
  88          returns KindOfClosed from GEOMAlgo;
  89
  90     SetLocation (me:out;
  91             aP: Pnt from gp);
  92
  93     Location (me)
  94          returns Pnt from gp;
  95     ---C++: return const&
  96
  97     SetDirection  (me:out;
  98             aD:Dir from gp);
  99
 100     Direction  (me)
 101          returns Dir from gp;
 102     ---C++: return const&
 103
 104     SetPosition (me:out;
 105             aAx2 : Ax2 from gp);
 106
 107     SetPosition (me:out;
 108             aAx3 : Ax3 from gp);
 109
 110     Position (me)
 111         returns Ax3 from gp;
 112     ---C++: return const&
 113
 114     SetPnt1 (me:out;
 115             aP: Pnt from gp);
 116
 117     Pnt1 (me)
 118          returns Pnt from gp;
 119     ---C++: return const&
 120
 121     SetPnt2 (me:out;
 122             aP: Pnt from gp);
 123
 124     Pnt2 (me)
 125          returns Pnt from gp;
 126     ---C++: return const&
 127
 128     SetRadius1 (me:out;
 129             aR: Real from Standard);
 130
 131     Radius1(me)
 132          returns Real from Standard;
 133
 134     SetRadius2 (me:out;
 135             aR: Real from Standard);
 136
 137     Radius2(me)
 138          returns Real from Standard;
 139
 140     SetLength(me:out;
 141             aL: Real from Standard);
 142
 143     Length(me)
 144          returns Real from Standard;
 145
 146     SetWidth(me:out;
 147             aW: Real from Standard);
 148
 149     Width(me)
 150          returns Real from Standard;
 151
 152     SetHeight(me:out;
 153             aH: Real from Standard);
 154
 155     Height(me)
 156          returns Real from Standard;
 157     --
 158     -- Dump
 159     --
 160     Dump(me);
 161
 162     DumpVertex(me)
 163         is protected;
 164
 165     DumpEdge(me)
 166         is protected;
 167
 168     DumpWire(me)
 169         is protected;
 170
 171     DumpFace(me)
 172         is protected;
 173
 174     DumpShell(me)
 175         is protected;
 176
 177     DumpSolid(me)
 178         is protected;
 179
 180     DumpCompSolid(me)
 181         is protected;
 182
 183     DumpCompound(me)
 184         is protected;
 185
 186 fields
 187     myType          : ShapeEnum from TopAbs      is protected;
 188     myNbSubShapes   : Integer from Standard[9]   is protected;
 189     myKindOfShape   : KindOfShape from GEOMAlgo  is protected;
 190     myKindOfName    : KindOfName from GEOMAlgo   is protected;
 191     myKindOfBounds  : KindOfBounds from GEOMAlgo is protected;
 192     myKindOfClosed  : KindOfClosed from GEOMAlgo is protected;
 193     --
 194     myLocation      : Pnt from gp is protected;
 195     myDirection     : Dir from gp is protected;
 196     myPosition      : Ax3 from gp is protected;
 197     --
 198     myRadius1       : Real from Standard is protected;
 199     myRadius2       : Real from Standard is protected;
 200     myLength        : Real from Standard is protected;
 201     myWidth         : Real from Standard is protected;
 202     myHeight        : Real from Standard is protected;
 203     --
 204     myPnt1          : Pnt from gp is protected;
 205     myPnt2          : Pnt from gp is protected;
 206     --
 207     myNbTypes       : Integer from Standard is protected;
 208 end ShapeInfo;