src/BRepMesh/BRepMesh_ShapeTool.cdl

   1 -- Created on: 1993-09-30
   2 -- Created by: Isabelle GRIGNON
   3 -- Copyright (c) 1993-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 class ShapeTool from BRepMesh
  23
  24         ---Purpose:
  25
  26 uses Shape from TopoDS,
  27      Face from TopoDS,
  28      Edge from TopoDS,
  29      Vertex from TopoDS,
  30      Explorer from TopExp,
  31      Pnt2d from gp,
  32      Pnt from gp,
  33      Box from Bnd,
  34      Curve from BRepAdaptor,
  35      Orientation from TopAbs,
  36      Triangulation from Poly,
  37      HArray1OfInteger from TColStd
  38
  39 raises NoSuchObject from Standard
  40
  41 is
  42         Create  returns ShapeTool ;
  43
  44         Init(me : in out ; S : Shape from TopoDS)
  45         ---C++: inline
  46         is static;
  47
  48         MoreFace(me: in out ) returns Boolean from Standard
  49         ---C++: inline
  50         is static;
  51
  52         NextFace(me : in out)
  53         ---C++: inline
  54         is static;
  55
  56         CurrentFace( me : in out) returns Face from TopoDS
  57         ---C++:return const &
  58         ---C++: inline
  59         is static;
  60
  61         Init(me : in out ; F: Face from TopoDS)
  62         ---C++: inline
  63         is static;
  64
  65         MoreEdge(me: in out ) returns Boolean from Standard
  66         ---C++: inline
  67         is static;
  68
  69         NextEdge(me : in out)
  70         ---C++: inline
  71         is static;
  72
  73         CurrentEdge(me     : in out)
  74             ---C++: return const &
  75             ---C++: inline
  76             returns Edge from TopoDS
  77         is static;
  78
  79         Init(me : in out ; E : Edge from TopoDS)
  80         ---C++: inline
  81         is static;
  82
  83         MoreInternalVertex(me: in out ) returns Boolean from Standard
  84
  85         is static;
  86
  87         NextInternalVertex(me : in out)
  88         ---C++: inline
  89         is static;
  90
  91         CurrentInternalVertex( me : in out) returns Vertex from TopoDS
  92         ---C++: return const &
  93         ---C++: inline
  94         is static;
  95
  96         Orientation(myclass; F :Face from TopoDS )
  97         ---C++: inline
  98             returns Orientation from TopAbs;
  99
 100         Orientation(myclass; E : Edge from TopoDS )
 101         ---C++: inline
 102             returns Orientation from TopAbs;
 103
 104         Bound(myclass; F :Face from TopoDS )
 105             returns Box from Bnd;
 106
 107         Bound(myclass; E : Edge from TopoDS )
 108             returns Box from Bnd;
 109
 110         FirstVertex(myclass; E : Edge from TopoDS )
 111             returns Vertex from TopoDS
 112         raises NoSuchObject;
 113         --if there is not first vertex (semi-infinite edge)
 114
 115         LastVertex(myclass; E : Edge from TopoDS)
 116             returns Vertex from TopoDS
 117         raises NoSuchObject;
 118         --if there is not last vertex (semi-infinite edge)
 119
 120         Vertices(myclass; E : Edge from TopoDS;
 121                  Vfirst, Vlast : out Vertex from TopoDS);
 122         ---Purpose: If there is  not First or Last vertex (infinite or
 123         --          semi-infinite edge) return null shapes.
 124
 125         Range(myclass; E : Edge from TopoDS;
 126                        F : Face from TopoDS;
 127                        wFirst, wLast : in out Real from Standard);
 128         ---C++: inline
 129
 130         UVPoints(myclass; E : Edge from TopoDS;
 131                           F : Face from TopoDS;
 132                           uvFirst, uvLast : out Pnt2d from gp);
 133         ---C++: inline
 134
 135         Degenerated(myclass; E : Edge from TopoDS)
 136         ---C++: inline
 137             returns Boolean from Standard;
 138
 139         Tolerance(myclass; V : Vertex from TopoDS)
 140         ---C++: inline
 141             returns Real from Standard;
 142
 143         Parameter(myclass; V : Vertex from TopoDS;
 144                   E : Edge from TopoDS;
 145                   F : Face from TopoDS) returns Real from Standard;
 146         ---C++: inline
 147
 148         Parameters (myclass;
 149                     E  : Edge from TopoDS;
 150                     F  : Face from TopoDS;
 151                     W  : Real;
 152                     UV : out Pnt2d);
 153
 154         Locate     (myclass;
 155                     C  : Curve from BRepAdaptor;
 156                     W  : in Real; WFound : in out Real;
 157                     p3d : Pnt from gp;
 158                     UV : out Pnt2d);
 159
 160         Pnt(myclass; V : Vertex from TopoDS)
 161         ---C++: inline
 162             returns Pnt from gp;
 163
 164
 165         AddInFace(myclass;
 166                   F : Face                 from TopoDS;
 167                   T : in out Triangulation from Poly);
 168
 169
 170
 171
 172 fields
 173
 174     theFIterator : Explorer from TopExp;
 175     theEIterator : Explorer from TopExp;
 176     theVIterator : Explorer from TopExp;
 177
 178 end ShapeTool;
 179