src/BOPTools/BOPTools_PaveBlock.cdl

   1 -- Created on: 2001-02-15
   2 -- Created by: Peter KURNEV
   3 -- Copyright (c) 2001-2012 OPEN CASCADE SAS
   4 --
   5 -- The content of this file is subject to the Open CASCADE Technology Public
   6 -- License Version 6.5 (the "License"). You may not use the content of this file
   7 -- except in compliance with the License. Please obtain a copy of the License
   8 -- at http://www.opencascade.org and read it completely before using this file.
   9 --
  10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  12 --
  13 -- The Original Code and all software distributed under the License is
  14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  15 -- Initial Developer hereby disclaims all such warranties, including without
  16 -- limitation, any warranties of merchantability, fitness for a particular
  17 -- purpose or non-infringement. Please see the License for the specific terms
  18 -- and conditions governing the rights and limitations under the License.
  19
  20
  21
  22 class PaveBlock from BOPTools
  23
  24         ---Purpose:
  25         --  Class for storing info about a couple
  26         --- of neighbouring paves on an edge
  27
  28 uses
  29     Pave from BOPTools,
  30     PointBetween from BOPTools,
  31     Range        from IntTools,
  32     ShrunkRange  from IntTools,
  33     Curve        from IntTools
  34
  35
  36
  37 is
  38     Create
  39         returns PaveBlock from BOPTools;
  40         ---Purpose:
  41         --- Empty constructor
  42         ---
  43     Create (anEdge:  Integer from Standard;
  44             aPave1:  Pave from BOPTools;
  45             aPave2:  Pave from BOPTools);
  46         ---Purpose:
  47         --- Constructor
  48         --- Index  - DS-index of the edge
  49         --- aPave1 - one pave
  50         --- aPave2 - other pave
  51         ---
  52     SetEdge (me:out;
  53              anEdge:Integer from Standard);
  54         ---Purpose:
  55         --- Modifier
  56         --- Sets DS-index for the edge that is between aPave1 and aPave2
  57         ---
  58     SetOriginalEdge  (me:out;
  59                       anEdge:Integer from Standard);
  60         ---Purpose:
  61         --- Modifier
  62         --- Sets DS-index for the edge from which this pave block comes from
  63         ---
  64     SetPave1(me:out;
  65              aPave: Pave from BOPTools);
  66         ---Purpose:
  67         --- Modifier
  68         ---
  69     SetPave2(me:out;
  70              aPave: Pave from BOPTools);
  71         ---Purpose:
  72         --- Modifier
  73         ---
  74     SetShrunkRange  (me:out;
  75                      aSR:ShrunkRange from IntTools);
  76         ---Purpose:
  77         --- Modifier
  78         --- Sets the Shrunk Range for the pave block
  79         ---
  80     SetPointBetween (me:out;
  81                      aP: PointBetween from BOPTools);
  82         ---Purpose:
  83         --- Modifier
  84         --- Sets the point between the paves for the pave block
  85         ---
  86
  87     ---  Case  of  Face/Face Pave  Block
  88     ---
  89     SetCurve        (me:out;
  90                      aC:Curve from IntTools);
  91         ---Purpose:
  92         --- Modifier
  93         --- Sets the intersection curve to which the pave block belongs to
  94         ---
  95     SetFace1        (me:out;
  96                      nF1:Integer from Standard);
  97         ---Purpose:
  98         --- Modifier
  99         --- Sets the DS-index of the first face
 100         ---
 101     SetFace2        (me:out;
 102                      nF2:Integer from Standard);
 103         ---Purpose:
 104         --- Modifier
 105         --- Sets the DS-index of the second face
 106         ---
 107     Edge    (me)
 108         returns Integer from Standard;
 109         ---Purpose:
 110         --- Selector
 111         ---
 112     OriginalEdge(me)
 113         returns Integer from Standard;
 114         ---Purpose:
 115         --- Selector
 116         ---
 117     Pave1(me)
 118         returns Pave from BOPTools;
 119         ---C++:  return const &
 120         ---Purpose:
 121         --- Selector
 122         ---
 123     Pave2(me)
 124         returns Pave from BOPTools;
 125         ---C++:  return const &
 126         ---Purpose:
 127         --- Selector
 128         ---
 129     IsValid(me)
 130         returns Boolean from Standard;
 131         ---Purpose:
 132         --- Returns  TRUE if both paves have vertex index !=0
 133         ---
 134     IsEqual(me;
 135             Other:PaveBlock from BOPTools)
 136         returns Boolean from Standard;
 137         ---Purpose:
 138         --- Returns  TRUE if <Other> is  equal to me
 139         ---
 140     Parameters   (me;
 141                   aT1:out Real from Standard;
 142                   aT2:out Real from Standard);
 143         ---Purpose:
 144         --- Returns values for paves' parameters
 145         ---
 146     Range  (me)
 147         returns Range from IntTools;
 148         ---C++:  return const &
 149         ---Purpose:
 150         --- Returns parmetric range for paves' parameters
 151         ---
 152     ShrunkRange(me)
 153         returns ShrunkRange from IntTools;
 154         ---C++:  return const &
 155         ---Purpose:
 156         --- Selector
 157         ---
 158     PointBetween  (me)
 159         returns  PointBetween from BOPTools;
 160         ---C++:  return const &
 161         ---Purpose:
 162         --- Selector
 163         ---
 164     Curve(me)
 165         returns Curve from IntTools;
 166         ---C++:  return const &
 167         ---Purpose:
 168         --- Selector
 169         ---
 170     Face1(me)
 171         returns Integer from Standard;
 172         ---Purpose:
 173         --- Selector
 174         ---
 175     Face2(me)
 176         returns Integer from Standard;
 177         ---Purpose:
 178         --- Selector
 179         ---
 180     IsInBlock(me;
 181            aPaveX:  Pave from BOPTools)
 182         returns Boolean  from Standard;
 183
 184 fields
 185
 186     myEdge         :  Integer from Standard;
 187     myOriginalEdge :  Integer from Standard;
 188     myPave1        :  Pave from BOPTools;
 189     myPave2        :  Pave from BOPTools;
 190     myRange        :  Range from IntTools;
 191     myShrunkRange  :  ShrunkRange from IntTools;
 192     myCurve        :  Curve from IntTools;
 193     myFace1        :  Integer from Standard;
 194     myFace2        :  Integer from Standard;
 195     myPointBetween :  PointBetween from BOPTools;
 196
 197 end PaveBlock;