src/BRepFilletAPI/BRepFilletAPI_LocalOperation.cdl

   1 -- Created on: 1998-01-29
   2 -- Created by: Laurent BOURESCHE
   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 deferred class LocalOperation from BRepFilletAPI inherits MakeShape from BRepBuilderAPI
  23
  24         ---Purpose: Construction of fillets on the edges of a Shell.
  25
  26 uses
  27
  28     Shape             from TopoDS,
  29     Edge              from TopoDS,
  30     Vertex            from TopoDS,
  31     ListOfShape       from TopTools,
  32     SecHArray1        from ChFiDS
  33
  34 is
  35
  36     ------------------------------------------------------------------
  37     --- Add d contour
  38     ------------------------------------------------------------------
  39
  40     Add(me : in out; E : Edge from TopoDS)
  41         ---Purpose: Adds a  contour in  the  builder  (builds a
  42         --          contour  of tangent edges).
  43         ---Level: Public
  44     is deferred;
  45
  46     ResetContour(me     : in out;
  47                  IC     : Integer from Standard)
  48         ---Purpose: Reset the contour of index IC, there is nomore
  49         --          information in the contour.
  50         ---Level: Public
  51     is deferred;
  52
  53     NbContours(me)
  54         ---Purpose: Number of contours.
  55         ---Level: Advanced
  56     returns Integer from Standard is deferred;
  57
  58     Contour(me; E : Edge from TopoDS)
  59         ---Purpose: Returns the index of  the  contour containing the edge
  60         --          E, returns 0 if E doesn't belong to any contour.
  61         ---Level: Public
  62     returns Integer from Standard is deferred;
  63
  64     NbEdges(me; I : Integer from Standard)
  65         ---Purpose: Number of Edges in the contour I.
  66         --
  67         ---Level: Advanced
  68     returns Integer from Standard
  69     is deferred;
  70
  71     Edge(me; I,J : Integer from Standard)
  72         ---Purpose: Returns the Edge J in the contour I.
  73         --
  74         ---C++: return const &
  75         ---Level: Advanced
  76     returns Edge from TopoDS
  77     is deferred;
  78
  79     Remove(me : in out; E : Edge from TopoDS)
  80         ---Purpose: remove the contour containing the Edge E.
  81         ---Level: Advanced
  82     is deferred;
  83
  84     Length(me; IC : Integer from Standard) returns Real from Standard
  85     ---Purpose: returns the length the contour of index IC.
  86     is deferred;
  87
  88     FirstVertex(me; IC : Integer from Standard) returns Vertex from TopoDS
  89         ---Purpose: Returns the first Vertex of the contour of index IC.
  90         ---Level: Advanced
  91     is deferred;
  92
  93     LastVertex(me; IC : Integer from Standard) returns Vertex from TopoDS
  94         ---Purpose: Returns the last Vertex of the contour of index IC.
  95         ---Level: Advanced
  96     is deferred;
  97
  98     Abscissa(me;
  99              IC : Integer from Standard;
 100              V  : Vertex  from TopoDS)
 101     returns Real from Standard
 102     ---Purpose: returns the abscissa of the vertex V on
 103     --          the contour of index IC.
 104     is deferred;
 105
 106     RelativeAbscissa(me;
 107                      IC : Integer from Standard;
 108                      V  : Vertex  from TopoDS)
 109     returns Real from Standard
 110     ---Purpose: returns the relative abscissa([0.,1.]) of the
 111     --          vertex V on the contour of index IC.
 112     is deferred;
 113
 114     ClosedAndTangent(me; IC : Integer from Standard)
 115     returns Boolean from Standard
 116     ---Purpose: returns true if the contour of index IC is closed
 117     --          an tangent.
 118     is deferred;
 119
 120     Closed(me; IC : Integer from Standard)
 121     returns Boolean from Standard
 122     ---Purpose: returns true if the contour of index IC is closed
 123     is deferred;
 124
 125     Reset(me : in out)
 126     ---Purpose: Reset all the fields updated   by Build operation  and
 127     --          leave the  algorithm in  the  same state  than  before
 128     --          build    call.  It   allows   contours    and   radius
 129     --          modifications  to build the result another time.
 130     ---Level: Advanced
 131     is deferred;
 132
 133     -------------------------------
 134     ---Methods for quick simulation
 135     -------------------------------
 136
 137     Simulate(me : in out; IC : Integer from Standard)
 138     is deferred;
 139
 140     NbSurf(me; IC : Integer from Standard)
 141     returns Integer from Standard
 142     is deferred;
 143
 144     Sect(me; IC, IS : Integer from Standard)
 145     returns mutable SecHArray1 from ChFiDS
 146     is deferred;
 147
 148 end LocalOperation;