src/ShapeFix/ShapeFix_ShapeTolerance.cdl

   1 -- Created on: 1998-07-22
   2 -- Created by: data exchange team
   3 -- Copyright (c) 1998-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
  23 class ShapeTolerance from ShapeFix
  24
  25         ---Purpose: Modifies tolerances of sub-shapes (vertices, edges, faces)
  26
  27 uses
  28
  29     Shape     from TopoDS,
  30     ShapeEnum from TopAbs
  31
  32 is
  33
  34     Create returns ShapeTolerance from ShapeFix;
  35
  36     LimitTolerance (me; shape: Shape from TopoDS;
  37                         tmin  : Real;
  38                         tmax  : Real = 0.0;
  39                         styp : ShapeEnum from TopAbs = TopAbs_SHAPE)
  40     returns Boolean;
  41         ---Purpose: Limits tolerances in a shape as follows :
  42         --          tmin = tmax -> as SetTolerance (forces)
  43         --          tmin = 0   -> maximum tolerance will be <tmax>
  44         --          tmax = 0 or not given (more generally, tmax < tmin) ->
  45         --             <tmax> ignored, minimum will be <tmin>
  46         --          else, maximum will be <max> and minimum will be <min>
  47         --          styp = VERTEX : only vertices are set
  48         --          styp = EDGE   : only edges are set
  49         --          styp = FACE   : only faces are set
  50         --          styp = WIRE   : to have edges and their vertices set
  51         --          styp = other value : all (vertices,edges,faces) are set
  52         --          Returns True if at least one tolerance of the sub-shape has
  53         --          been modified
  54
  55     SetTolerance (me; shape: Shape from TopoDS;
  56                       preci: Real;
  57                       styp : ShapeEnum from TopAbs = TopAbs_SHAPE);
  58         ---Purpose: Sets (enforces) tolerances in a shape to the given value
  59         --          styp = VERTEX : only vertices are set
  60         --          styp = EDGE   : only edges are set
  61         --          styp = FACE   : only faces are set
  62         --          styp = WIRE   : to have edges and their vertices set
  63         --          styp = other value : all (vertices,edges,faces) are set
  64
  65 end ShapeTolerance;