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 --              <pkv@irinox>
  26
  27 class ShapeInfo from GEOMAlgo
  28
  29         ---Purpose:
  30
  31 uses
  32     Pnt from gp,
  33     Dir from gp,
  34     Ax2 from gp,
  35     Ax3 from gp,
  36
  37     ShapeEnum from TopAbs,
  38     Shape from TopoDS,
  39
  40     KindOfShape   from GEOMAlgo,
  41     KindOfBounds  from GEOMAlgo,
  42     KindOfClosed  from GEOMAlgo,
  43     KindOfName from GEOMAlgo
  44 --raises
  45
  46 is
  47     Create
  48         returns ShapeInfo from GEOMAlgo;
  49     ---C++: alias "Standard_EXPORT virtual ~GEOMAlgo_ShapeInfo();"
  50
  51     Reset(me:out);
  52
  53     SetType(me:out;
  54             aType:ShapeEnum from TopAbs);
  55
  56     Type(me)
  57         returns ShapeEnum from TopAbs;
  58
  59     SetNbSubShapes(me:out;
  60             aType:ShapeEnum from TopAbs;
  61             aNb  :Integer from Standard);
  62
  63     NbSubShapes(me;
  64             aType:ShapeEnum from TopAbs)
  65         returns Integer from Standard;
  66
  67     SetKindOfShape (me:out;
  68             aT:KindOfShape from GEOMAlgo);
  69
  70     KindOfShape (me)
  71          returns KindOfShape from GEOMAlgo;
  72
  73     SetKindOfName (me:out;
  74             aT: KindOfName from GEOMAlgo);
  75
  76     KindOfName(me)
  77          returns KindOfName from GEOMAlgo;
  78
  79     SetKindOfBounds (me:out;
  80             aT:KindOfBounds from GEOMAlgo);
  81
  82     KindOfBounds (me)
  83          returns KindOfBounds from GEOMAlgo;
  84
  85     SetKindOfClosed (me:out;
  86             aT:KindOfClosed from GEOMAlgo);
  87
  88     KindOfClosed(me)
  89          returns KindOfClosed from GEOMAlgo;
  90
  91     SetLocation (me:out;
  92             aP: Pnt from gp);
  93
  94     Location (me)
  95          returns Pnt from gp;
  96     ---C++: return const&
  97
  98     SetDirection  (me:out;
  99             aD:Dir from gp);
 100
 101     Direction  (me)
 102          returns Dir from gp;
 103     ---C++: return const&
 104
 105     SetPosition (me:out;
 106             aAx2 : Ax2 from gp);
 107
 108     SetPosition (me:out;
 109             aAx3 : Ax3 from gp);
 110
 111     Position (me)
 112         returns Ax3 from gp;
 113     ---C++: return const&
 114
 115     SetPnt1 (me:out;
 116             aP: Pnt from gp);
 117
 118     Pnt1 (me)
 119          returns Pnt from gp;
 120     ---C++: return const&
 121
 122     SetPnt2 (me:out;
 123             aP: Pnt from gp);
 124
 125     Pnt2 (me)
 126          returns Pnt from gp;
 127     ---C++: return const&
 128
 129     SetRadius1 (me:out;
 130             aR: Real from Standard);
 131
 132     Radius1(me)
 133          returns Real from Standard;
 134
 135     SetRadius2 (me:out;
 136             aR: Real from Standard);
 137
 138     Radius2(me)
 139          returns Real from Standard;
 140
 141     SetLength(me:out;
 142             aL: Real from Standard);
 143
 144     Length(me)
 145          returns Real from Standard;
 146
 147     SetWidth(me:out;
 148             aW: Real from Standard);
 149
 150     Width(me)
 151          returns Real from Standard;
 152
 153     SetHeight(me:out;
 154             aH: Real from Standard);
 155
 156     Height(me)
 157          returns Real from Standard;
 158     --
 159     -- Dump
 160     --
 161     Dump(me);
 162
 163     DumpVertex(me)
 164         is protected;
 165
 166     DumpEdge(me)
 167         is protected;
 168
 169     DumpWire(me)
 170         is protected;
 171
 172     DumpFace(me)
 173         is protected;
 174
 175     DumpShell(me)
 176         is protected;
 177
 178     DumpSolid(me)
 179         is protected;
 180
 181     DumpCompSolid(me)
 182         is protected;
 183
 184     DumpCompound(me)
 185         is protected;
 186
 187 fields
 188     myType          : ShapeEnum from TopAbs      is protected;
 189     myNbSubShapes   : Integer from Standard[9]   is protected;
 190     myKindOfShape   : KindOfShape from GEOMAlgo  is protected;
 191     myKindOfName    : KindOfName from GEOMAlgo   is protected;
 192     myKindOfBounds  : KindOfBounds from GEOMAlgo is protected;
 193     myKindOfClosed  : KindOfClosed from GEOMAlgo is protected;
 194     --
 195     myLocation      : Pnt from gp is protected;
 196     myDirection     : Dir from gp is protected;
 197     myPosition      : Ax3 from gp is protected;
 198     --
 199     myRadius1       : Real from Standard is protected;
 200     myRadius2       : Real from Standard is protected;
 201     myLength        : Real from Standard is protected;
 202     myWidth         : Real from Standard is protected;
 203     myHeight        : Real from Standard is protected;
 204     --
 205     myPnt1          : Pnt from gp is protected;
 206     myPnt2          : Pnt from gp is protected;
 207     --
 208     myNbTypes       : Integer from Standard is protected;
 209 end ShapeInfo;