src/IntPatch/IntPatch_Point.cdl

   1 -- File:        IntPatch_Point.cdl
   2 -- Created:     Wed May  6 14:01:12 1992
   3 -- Author:      Jacques GOUSSARD
   4 ---Copyright:   OPEN CASCADE 1992
   5
   6
   7 class Point from IntPatch
   8
   9         ---Purpose: Definition of an intersection point between two surfaces.
  10         --          Such a point is contains geometrical informations (see
  11         --          the Value method) and logical informations.
  12
  13 uses
  14      HVertex    from Adaptor3d,
  15      HCurve2d   from Adaptor2d,
  16      PntOn2S    from IntSurf,
  17      Line       from IntPatch,
  18      Transition from IntSurf,
  19      Pnt        from gp
  20
  21 raises DomainError from Standard
  22
  23 is
  24
  25
  26     Create
  27
  28         ---Purpose: Empty constructor.
  29         ---C++: inline
  30         returns Point from IntPatch;
  31
  32
  33     SetValue(me: in out; Pt: Pnt from gp; Tol: Real from Standard;
  34                          Tangent: Boolean from Standard)
  35
  36         ---Purpose: Sets the values of a point which is on no domain,
  37         --          when both surfaces are implicit ones.
  38         --          If Tangent is True, the point is a point of tangency
  39         --          between the surfaces.
  40
  41         is static;
  42
  43
  44     SetValue(me: in out; Pt: Pnt from gp)
  45         ---C++: inline
  46         is static;
  47
  48
  49     SetTolerance(me: in out; Tol: Real from Standard)
  50         ---C++: inline
  51         is static;
  52
  53
  54     SetParameters(me: in out; U1,V1,U2,V2: Real from Standard)
  55
  56         ---Purpose: Sets the values of the parameters of the point
  57         --          on each surface.
  58         ---C++: inline
  59         is static;
  60
  61
  62     SetParameter(me: in out; Para: Real from Standard)
  63
  64         ---Purpose: Set the value of the parameter on the intersection line.
  65         ---C++: inline
  66         is static;
  67
  68
  69     SetVertex(me: in out; OnFirst: Boolean from Standard; V: HVertex from Adaptor3d)
  70
  71         ---Purpose: Sets the values of a point which is a vertex on
  72         --          the initial facet of restriction of one
  73         --          of the surface.
  74         --          If OnFirst is True, the point is on the domain of the
  75         --          first patch, otherwise the point is on the domain of the
  76         --          second surface.
  77
  78         is static;
  79
  80
  81     SetArc(me: in out; OnFirst: Boolean from Standard;
  82                        A: HCurve2d from Adaptor2d; Param: Real from Standard;
  83                        TLine, TArc: Transition from IntSurf)
  84
  85         ---Purpose: Sets the values of a point which is on one of the domain,
  86         --          when both surfaces are implicit ones.
  87         --          If OnFirst is True, the point is on the domain of the
  88         --          first patch, otherwise the point is on the domain of the
  89         --          second surface.
  90
  91         is static;
  92
  93
  94     SetMultiple(me: in out; IsMult: Boolean from Standard)
  95
  96         ---Purpose: Sets (or unsets) the point as a point on several
  97         --          intersection line.
  98         ---C++: inline
  99         is static;
 100
 101
 102     Value(me)
 103
 104         ---Purpose: Returns the intersection point (geometric information).
 105
 106         returns Pnt from gp
 107         ---C++: return const&
 108         ---C++: inline
 109
 110         is static;
 111
 112
 113     ParameterOnLine(me)
 114
 115         ---Purpose: This method returns the parameter of the point
 116         --          on the intersection line.
 117         --          If the points does not belong to an intersection line,
 118         --          the value returned does not have any sens.
 119
 120         returns Real from Standard
 121         ---C++: inline
 122
 123         is static;
 124
 125
 126     Tolerance(me)
 127
 128         ---Purpose: This method returns the fuzziness on the point.
 129
 130         returns Real from Standard
 131         ---C++: inline
 132
 133         is static;
 134
 135
 136     IsTangencyPoint(me)
 137
 138         ---Purpose: Returns True if the Point is a tangency point between
 139         --          the surfaces.
 140         --          If the Point is on one of the domain (IsOnDomS1 returns
 141         --          True or IsOnDomS2 returns True), an exception is raised.
 142
 143         returns Boolean from Standard
 144         ---C++: inline
 145
 146         raises DomainError from Standard
 147
 148         is static;
 149
 150
 151     ParametersOnS1(me; U1,V1: out Real from Standard)
 152
 153         ---Purpose: Returns the parameters on the first surface of the point.
 154
 155         raises DomainError from Standard
 156         ---C++: inline
 157
 158         is static;
 159
 160
 161     ParametersOnS2(me; U2,V2: out Real from Standard)
 162
 163         ---Purpose: Returns the parameters on the second surface of the point.
 164
 165         raises DomainError from Standard
 166         ---C++: inline
 167
 168         is static;
 169
 170
 171     IsMultiple(me)
 172
 173         ---Purpose: Returns True if the point belongs to several intersection
 174         --          lines.
 175
 176         returns Boolean from Standard
 177         ---C++: inline
 178
 179         is static;
 180
 181
 182     IsOnDomS1(me)
 183
 184         ---Purpose: Returns TRUE if the point is on a boundary of the domain
 185         --          of the first patch.
 186
 187         returns Boolean from Standard
 188         ---C++: inline
 189
 190         is static;
 191
 192
 193     IsVertexOnS1(me)
 194
 195         ---Purpose: Returns TRUE if the point is a vertex on the initial
 196         --          restriction facet of the first surface.
 197
 198         returns Boolean from Standard
 199         ---C++: inline
 200
 201         is static;
 202
 203
 204     VertexOnS1(me)
 205
 206         ---Purpose: Returns the information about the point when it is
 207         --          on the domain of the first patch, i-e when the function
 208         --          IsVertexOnS1 returns True.
 209         --          Otherwise, an exception is raised.
 210
 211         returns HVertex from Adaptor3d
 212         ---C++: return const&
 213         ---C++: inline
 214
 215         raises DomainError from Standard
 216
 217         is static;
 218
 219
 220     ArcOnS1(me)
 221
 222         ---Purpose: Returns the arc of restriction containing the
 223         --          vertex.
 224         --          The exception DomainError is raised if
 225         --          IsOnDomS1 returns False.
 226
 227         returns HCurve2d from Adaptor2d
 228         ---C++: return const&
 229         ---C++: inline
 230
 231         raises DomainError from Standard
 232
 233         is static;
 234
 235
 236     TransitionLineArc1(me)
 237
 238         ---Purpose: Returns the transition of the point on the
 239         --          intersection line with the arc on S1.
 240         --          The exception DomainError is raised if IsOnDomS1
 241         --          returns False.
 242
 243         returns Transition from IntSurf
 244         ---C++: return const&
 245         ---C++: inline
 246
 247         raises DomainError from Standard
 248
 249         is static;
 250
 251
 252     TransitionOnS1(me)
 253
 254         ---Purpose: Returns the transition between the intersection line
 255         --          returned by the method Line and the arc on S1 returned
 256         --          by ArcOnS1().
 257         --          The exception DomainError is raised if
 258         --          IsOnDomS1 returns False.
 259
 260         returns Transition from IntSurf
 261         ---C++: return const&
 262         ---C++: inline
 263
 264         raises DomainError from Standard
 265
 266         is static;
 267
 268
 269     ParameterOnArc1(me)
 270
 271         ---Purpose: Returns the parameter of the point on the
 272         --          arc returned by the method ArcOnS2.
 273         --          The exception DomainError is raised if
 274         --          IsOnDomS1 returns False.
 275
 276         returns Real from Standard
 277         ---C++: inline
 278
 279         raises DomainError from Standard
 280
 281         is static;
 282
 283
 284     IsOnDomS2(me)
 285
 286         ---Purpose: Returns TRUE if the point is on a boundary of the domain
 287         --          of the second patch.
 288
 289         returns Boolean from Standard
 290         ---C++: inline
 291
 292         is static;
 293
 294
 295     IsVertexOnS2(me)
 296
 297         ---Purpose: Returns TRUE if the point is a vertex on the initial
 298         --          restriction facet of the first surface.
 299
 300         returns Boolean from Standard
 301         ---C++: inline
 302
 303         is static;
 304
 305
 306     VertexOnS2(me)
 307
 308         ---Purpose: Returns the information about the point when it is
 309         --          on the domain of the second patch, i-e when the function
 310         --          IsVertexOnS2 returns True.
 311         --          Otherwise, an exception is raised.
 312
 313         returns HVertex from Adaptor3d
 314         ---C++: return const&
 315         ---C++: inline
 316
 317         raises DomainError from Standard
 318
 319         is static;
 320
 321
 322     ArcOnS2(me)
 323
 324         ---Purpose: Returns the arc of restriction containing the
 325         --          vertex.
 326         --          The exception DomainError is raised if
 327         --          IsOnDomS2 returns False.
 328
 329         returns HCurve2d from Adaptor2d
 330         ---C++: return const&
 331         ---C++: inline
 332
 333         raises DomainError from Standard
 334
 335         is static;
 336
 337
 338     TransitionLineArc2(me)
 339
 340         ---Purpose: Returns the transition of the point on the
 341         --          intersection line with the arc on S2.
 342         --          The exception DomainError is raised if IsOnDomS2
 343         --          returns False.
 344
 345         returns Transition from IntSurf
 346         ---C++: return const&
 347         ---C++: inline
 348
 349         raises DomainError from Standard
 350
 351         is static;
 352
 353
 354     TransitionOnS2(me)
 355
 356         ---Purpose: Returns the transition between the intersection line
 357         --          returned by the method Line and the arc on S2 returned
 358         --          by ArcOnS2.
 359         --          The exception DomainError is raised if
 360         --          IsOnDomS2 returns False.
 361
 362         returns Transition from IntSurf
 363         ---C++: return const&
 364         ---C++: inline
 365
 366         raises DomainError from Standard
 367
 368         is static;
 369
 370
 371     ParameterOnArc2(me)
 372
 373         ---Purpose: Returns the parameter of the point on the
 374         --          arc returned by the method ArcOnS2.
 375         --          The exception DomainError is raised if
 376         --          IsOnDomS2 returns False.
 377
 378         returns Real from Standard
 379         ---C++: inline
 380
 381         raises DomainError from Standard
 382
 383         is static;
 384
 385
 386     PntOn2S(me)
 387
 388         ---Purpose: Returns the PntOn2S
 389         --          (geometric Point and the parameters)
 390         --
 391         ---C++: inline
 392         ---C++: return const &
 393
 394         returns PntOn2S from IntSurf
 395         is static;
 396
 397     Parameters(me; U1,V1,U2,V2: out Real from Standard)
 398         ---Purpose: Returns the parameters on the first and on the
 399         --          second surface of the point.
 400         raises DomainError from Standard
 401         ---C++: inline
 402
 403         is static;
 404
 405
 406     ReverseTransition(me: in out)
 407         is static;
 408
 409     Dump(me)
 410
 411         is static;
 412
 413 fields
 414
 415     pt        : PntOn2S    from IntSurf;
 416     para      : Real       from Standard;
 417     tol       : Real       from Standard;
 418     tgt       : Boolean    from Standard;
 419     mult      : Boolean    from Standard;
 420
 421     onS1      : Boolean    from Standard;
 422     vtxonS1   : Boolean    from Standard;
 423     vS1       : HVertex    from Adaptor3d;
 424     arcS1     : HCurve2d   from Adaptor2d;
 425     traline1  : Transition from IntSurf;
 426     tra1      : Transition from IntSurf;
 427     prm1      : Real       from Standard;
 428
 429     onS2      : Boolean    from Standard;
 430     vtxonS2   : Boolean    from Standard;
 431     vS2       : HVertex    from Adaptor3d;
 432     arcS2     : HCurve2d   from Adaptor2d;
 433     traline2  : Transition from IntSurf;
 434     tra2      : Transition from IntSurf;
 435     prm2      : Real       from Standard;
 436
 437 end Point;