src/Contap/Contap_Line.cdl

   1 -- Created on: 1993-02-05
   2 -- Created by: Jacques GOUSSARD
   3 -- Copyright (c) 1993-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 class Line from Contap
  18
  19         ---Purpose:
  20
  21 uses Pnt            from gp,
  22      LineOn2S       from IntSurf,
  23      PntOn2S        from IntSurf,
  24      TypeTrans      from IntSurf,
  25      Lin            from gp,
  26      Circ           from gp,
  27      Dir            from gp,
  28      IType          from Contap, -- duplique IntPatch_IType. Mettre ds  IntSurf
  29      HVertex        from Adaptor3d,
  30      HCurve2d       from Adaptor2d,
  31      Point          from Contap,
  32      TheHSequenceOfPoint from Contap
  33
  34 raises DomainError from Standard,
  35        OutOfRange  from Standard
  36
  37 is
  38
  39     Create
  40
  41         returns Line from Contap;
  42
  43
  44     SetLineOn2S(me: in out; L: LineOn2S from IntSurf)
  45
  46         is static;
  47
  48     Clear(me: in out)
  49
  50         is static;
  51
  52     LineOn2S(me)
  53
  54         returns LineOn2S from IntSurf
  55         ---C++: inline
  56         ---C++: return const&
  57         is static;
  58
  59     ResetSeqOfVertex(me: in out)
  60
  61         is static;
  62
  63     Add(me: in out; P: PntOn2S from IntSurf)
  64
  65         ---C++: inline
  66         is static;
  67
  68     SetValue(me: in out; L: Lin from gp)
  69
  70         is static;
  71
  72
  73     SetValue(me: in out; C: Circ from gp)
  74
  75         is static;
  76
  77
  78     SetValue(me: in out; A: HCurve2d from Adaptor2d)
  79
  80         is static;
  81
  82
  83     Add(me: in out; P: Point from Contap)
  84
  85         is static;
  86
  87
  88     NbVertex(me)
  89
  90         returns Integer from Standard
  91         ---C++: inline
  92
  93         is static;
  94
  95
  96     Vertex(me; Index: Integer from Standard)
  97
  98         returns Point from Contap
  99         ---C++: return &
 100         ---C++: inline
 101
 102         raises OutOfRange from Standard
 103
 104         is static;
 105
 106
 107     TypeContour(me)
 108
 109         ---Purpose: Returns Contap_Lin for a line, Contap_Circle for
 110         --          a circle, and Contap_Walking for a Walking line,
 111         --          Contap_Restriction for a part of  boundarie.
 112
 113         returns IType from Contap
 114         ---C++: inline
 115
 116         is static;
 117
 118
 119     NbPnts(me)
 120
 121         returns Integer from Standard
 122         ---C++: inline
 123
 124         raises DomainError from Standard
 125         -- The exception DomainError is raised if TypeContour does not return
 126         -- Contap_Walking.
 127
 128         is static;
 129
 130
 131     Point(me; Index: Integer from Standard)
 132
 133         returns PntOn2S from IntSurf
 134         ---C++: return const&
 135         ---C++: inline
 136
 137         raises DomainError from Standard,
 138                OutOfRange  from Standard
 139         -- The exception DomainError is raised if TypeContour does not return
 140         -- Contap_Walking.
 141         -- The exception OutOfRange is raised if Index<=0 or Index>NbPoints.
 142
 143         is static;
 144
 145
 146     Line(me)
 147
 148         returns Lin from gp
 149         ---C++: inline
 150
 151         raises DomainError from Standard
 152         -- The exception DomainError is raised if TypeContour does not return
 153         -- Contap_Lin.
 154
 155         is static;
 156
 157
 158     Circle(me)
 159
 160         returns Circ from gp
 161         ---C++: inline
 162
 163         raises DomainError from Standard
 164         -- The exception DomainError is raised if TypeContour does not return
 165         -- Contap_Circle.
 166
 167         is static;
 168
 169
 170
 171     Arc(me)
 172
 173         returns any HCurve2d from Adaptor2d
 174         ---C++: return const&
 175
 176         raises DomainError from Standard
 177         -- The exception DomainError is raised if TypeContour does not return
 178         -- Contap_Restriction.
 179
 180         is static;
 181
 182
 183     SetTransitionOnS(me: in out; T: TypeTrans from IntSurf)
 184
 185         ---Purpose: Set The Tansition of the line.
 186         --
 187         is static;
 188
 189
 190
 191     TransitionOnS(me)
 192
 193         ---Purpose: returns IN if at the "left" of the line, the normale of the
 194         --          surface is oriented to the observator.
 195
 196
 197         returns TypeTrans from IntSurf
 198         is static;
 199
 200
 201 fields
 202
 203     Trans   : TypeTrans            from IntSurf;
 204     curv    : LineOn2S             from IntSurf;
 205     svtx    : TheHSequenceOfPoint  from Contap;
 206     thearc  : HCurve2d             from Adaptor2d;
 207     typL    : IType                from Contap;
 208     pt      : Pnt                  from gp;
 209     dir1    : Dir                  from gp;
 210     dir2    : Dir                  from gp;
 211     rad     : Real                 from Standard;
 212
 213 end Line;