src/IntTools/IntTools_SurfaceRangeLocalizeData.cdl

   1 -- Created on: 2005-10-14
   2 -- Created by: Mikhail KLOKOV
   3 -- Copyright (c) 2005-2014 OPEN CASCADE SAS
   4 --
   5 -- This file is part of Open CASCADE Technology software library.
   6 --
   7 -- This library is free software; you can redistribute it and/or modify it under
   8 -- the terms of the GNU Lesser General Public License version 2.1 as published
   9 -- by the Free Software Foundation, with special exception defined in the file
  10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 -- distribution for complete text of the license and disclaimer of any warranty.
  12 --
  13 -- Alternatively, this file may be used under the terms of Open CASCADE
  14 -- commercial license or contractual agreement.
  15
  16 class SurfaceRangeLocalizeData from IntTools
  17 uses
  18     Box from Bnd,
  19     SurfaceRangeSample from IntTools,
  20     MapOfSurfaceSample from IntTools,
  21     ListOfSurfaceRangeSample from IntTools,
  22     DataMapOfSurfaceSampleBox from IntTools,
  23     Pnt                       from gp,
  24     HArray1OfReal             from TColStd,
  25     HArray2OfPnt              from TColgp
  26
  27 is
  28     Create
  29         returns SurfaceRangeLocalizeData from IntTools;
  30
  31     Create(theNbSampleU: Integer from Standard;
  32            theNbSampleV: Integer from Standard;
  33            theMinRangeU: Real from Standard;
  34            theMinRangeV: Real from Standard)
  35         returns SurfaceRangeLocalizeData from IntTools;
  36
  37     Create(Other: SurfaceRangeLocalizeData from IntTools)
  38         returns SurfaceRangeLocalizeData from IntTools;
  39
  40     Assign(me: in out; Other: SurfaceRangeLocalizeData from IntTools)
  41         returns SurfaceRangeLocalizeData from IntTools;
  42         ---C++:  alias  operator =
  43         ---C++:  return  &
  44
  45     GetNbSampleU(me)
  46         returns Integer from Standard;
  47         ---C++: inline
  48
  49     GetNbSampleV(me)
  50         returns Integer from Standard;
  51         ---C++: inline
  52
  53     GetMinRangeU(me)
  54         returns Real from Standard;
  55         ---C++: inline
  56
  57     GetMinRangeV(me)
  58         returns Real from Standard;
  59         ---C++: inline
  60
  61     AddOutRange(me: in out; theRange: SurfaceRangeSample from IntTools);
  62
  63     AddBox(me: in out; theRange: SurfaceRangeSample from IntTools;
  64                        theBox: Box from Bnd);
  65
  66     FindBox(me; theRange: SurfaceRangeSample from IntTools;
  67                 theBox: out Box from Bnd)
  68         returns Boolean from Standard;
  69
  70     IsRangeOut(me; theRange: SurfaceRangeSample from IntTools)
  71         returns Boolean from Standard;
  72
  73     ListRangeOut(me; theList: out ListOfSurfaceRangeSample from IntTools);
  74
  75     RemoveRangeOutAll(me: in out);
  76
  77 -- Modified by skv - Wed Nov  2 18:37:33 2005 Optimization Begin
  78     SetGridDeflection(me: in out; theDeflection: Real from Standard);
  79         ---Purpose: Set the grid deflection.
  80         ---C++: inline
  81
  82     GetGridDeflection(me)
  83         ---Purpose: Query the grid deflection.
  84         ---C++: inline
  85     returns Real from Standard;
  86
  87     SetRangeUGrid(me: in out; theNbUGrid: Integer from Standard);
  88         ---Purpose: Set the range U of the grid of points.
  89
  90     GetRangeUGrid(me)
  91         ---Purpose: Query the range U of the grid of points.
  92         ---C++: inline
  93     returns Integer from Standard;
  94
  95     SetUParam(me: in out; theIndex:  Integer from Standard;
  96                           theUParam: Real    from Standard);
  97         ---Purpose: Set the U parameter of the grid points at that index.
  98         ---C++: inline
  99
 100     GetUParam(me; theIndex: Integer from Standard)
 101         ---Purpose: Query the U parameter of the grid points at that index.
 102         ---C++: inline
 103     returns Real from Standard;
 104
 105     SetRangeVGrid(me: in out; theNbVGrid: Integer from Standard);
 106         ---Purpose: Set the range V of the grid of points.
 107
 108     GetRangeVGrid(me)
 109         ---Purpose: Query the range V of the grid of points.
 110         ---C++: inline
 111     returns Integer from Standard;
 112
 113     SetVParam(me: in out; theIndex:  Integer from Standard;
 114                           theVParam: Real    from Standard);
 115         ---Purpose: Set the V parameter of the grid points at that index.
 116         ---C++: inline
 117
 118     GetVParam(me; theIndex: Integer from Standard)
 119         ---Purpose: Query the V parameter of the grid points at that index.
 120         ---C++: inline
 121     returns Real from Standard;
 122
 123     SetGridPoint(me: in out; theUIndex: Integer from Standard;
 124                              theVIndex: Integer from Standard;
 125                              thePoint:  Pnt     from gp);
 126         ---Purpose: Set the grid point.
 127         ---C++: inline
 128
 129     GetGridPoint(me; theUIndex: Integer from Standard;
 130                      theVIndex: Integer from Standard)
 131         ---Purpose: Set the grid point.
 132         ---C++: inline
 133         ---C++: return const &
 134     returns Pnt from gp;
 135
 136     SetFrame(me: in out; theUMin: Real from Standard;
 137                          theUMax: Real from Standard;
 138                          theVMin: Real from Standard;
 139                          theVMax: Real from Standard);
 140         ---Purpose: Sets the frame area. Used to work with grid points.
 141
 142     GetNBUPointsInFrame(me)
 143         ---Purpose: Returns the number of grid points on U direction in frame.
 144         ---C++: inline
 145     returns Integer from Standard;
 146
 147     GetNBVPointsInFrame(me)
 148         ---Purpose: Returns the number of grid points on V direction in frame.
 149         ---C++: inline
 150     returns Integer from Standard;
 151
 152     GetPointInFrame(me; theUIndex: Integer from Standard;
 153                         theVIndex: Integer from Standard)
 154         ---Purpose: Returns the grid point in frame.
 155         ---C++: return const &
 156     returns Pnt from gp;
 157
 158     GetUParamInFrame(me; theIndex: Integer from Standard)
 159         ---Purpose: Query the U parameter of the grid points
 160         --          at that index in frame.
 161     returns Real from Standard;
 162
 163     GetVParamInFrame(me; theIndex: Integer from Standard)
 164         ---Purpose: Query the V parameter of the grid points
 165         --          at that index in frame.
 166     returns Real from Standard;
 167
 168     ClearGrid(me: in out);
 169         ---Purpose: Clears the grid of points.
 170
 171 -- Modified by skv - Wed Nov  2 18:37:33 2005 Optimization End
 172
 173 fields
 174     myNbSampleU: Integer from Standard;
 175     myNbSampleV: Integer from Standard;
 176     myMinRangeU: Real from Standard;
 177     myMinRangeV: Real from Standard;
 178     myMapRangeOut: MapOfSurfaceSample from IntTools;
 179     myMapBox     : DataMapOfSurfaceSampleBox from IntTools;
 180     myUParams    : HArray1OfReal from TColStd;
 181     myVParams    : HArray1OfReal from TColStd;
 182     myGridPoints : HArray2OfPnt  from TColgp;
 183     myUIndMin    : Integer       from Standard;
 184     myUIndMax    : Integer       from Standard;
 185     myVIndMin    : Integer       from Standard;
 186     myVIndMax    : Integer       from Standard;
 187     myDeflection : Real          from Standard;
 188
 189 end SurfaceRangeLocalizeData from IntTools;