src/IntSurf/IntSurf_PntOn2S.cdl

   1 -- Created on: 1992-05-06
   2 -- Created by: Jacques GOUSSARD
   3 -- Copyright (c) 1992-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 PntOn2S from IntSurf
  18
  19         ---Purpose: This class defines the geometric informations
  20         --          for an intersection point between 2 surfaces :
  21         --          The coordinates ( Pnt from gp ), and two
  22         --          parametric coordinates.
  23
  24
  25 uses Pnt from gp
  26
  27 is
  28
  29
  30     Create
  31
  32         ---Purpose: Empty constructor.
  33
  34         returns PntOn2S from IntSurf;
  35
  36
  37     SetValue(me: in out; Pt: Pnt from gp)
  38
  39         ---Purpose: Sets the value of the point in 3d space.
  40
  41         ---C++: inline
  42
  43         is static;
  44
  45
  46     SetValue(me: in out; Pt: Pnt from gp; OnFirst: Boolean from Standard;
  47              U,V: Real from Standard)
  48
  49         ---Purpose: Sets the values of the point in 3d space, and
  50         --          in the parametric space of one of the surface.
  51
  52         is static;
  53
  54
  55     SetValue(me: in out; Pt: Pnt from gp; U1,V1,U2,V2: Real from Standard)
  56
  57         ---Purpose: Sets the values of the point in 3d space, and
  58         --          in the parametric space of each surface.
  59
  60         ---C++: inline
  61
  62         is static;
  63
  64
  65     SetValue(me: in out; OnFirst: Boolean from Standard;
  66                          U,V: Real from Standard)
  67
  68         ---Purpose: Set the values of the point in the parametric
  69         --          space of one of the surface.
  70
  71         is static;
  72
  73
  74     SetValue(me: in out; U1,V1, U2, V2: Real from Standard)
  75
  76         ---Purpose: Set the values of the point in the parametric
  77         --          space of one of the surface.
  78
  79         ---C++: inline
  80
  81         is static;
  82
  83
  84     Value(me)
  85
  86         ---Purpose: Returns the point in 3d space.
  87
  88         returns Pnt from gp
  89         ---C++: return const&
  90         ---C++: inline
  91
  92         is static;
  93
  94
  95
  96     ParametersOnS1(me; U1,V1: out Real from Standard)
  97
  98         ---Purpose: Returns the parameters of the point on the first surface.
  99
 100         ---C++: inline
 101
 102         is static;
 103
 104
 105     ParametersOnS2(me; U2,V2: out Real from Standard)
 106
 107         ---Purpose: Returns the parameters of the point on the second surface.
 108
 109         ---C++: inline
 110
 111         is static;
 112
 113
 114     Parameters(me; U1,V1,U2,V2: out Real from Standard)
 115
 116         ---Purpose: Returns the parameters of the point on both surfaces.
 117
 118         ---C++: inline
 119
 120         is static;
 121
 122     IsSame(me; theOterPoint : PntOn2S from IntSurf;
 123             theTol3D, theTol2D: Real from Standard = 0.0)
 124
 125   ---Purpose: Returns TRUE if 2D- and 3D-coordinates of theOterPoint are equal to
 126    --         corresponding coordinates of me (with given tolerance).
 127    --         If theTol2D == 0.0 we will compare 3D-points only.
 128
 129         returns Boolean from Standard;
 130
 131
 132 fields
 133
 134     pt  : Pnt     from gp;
 135     u1  : Real    from Standard;
 136     v1  : Real    from Standard;
 137     u2  : Real    from Standard;
 138     v2  : Real    from Standard;
 139
 140 end PntOn2S;