src/IntRes2d/IntRes2d_IntersectionPoint.cdl

   1 -- Created on: 1992-04-03
   2 -- Created by: Laurent BUCHARD
   3 -- Copyright (c) 1992-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
  23 class IntersectionPoint from IntRes2d
  24
  25     ---Purpose: Definition of an intersection point between two
  26     --          2D curves.
  27
  28
  29 inherits Storable from Standard
  30
  31 uses Pnt2d      from gp,
  32      Transition from IntRes2d
  33 is
  34
  35     Create
  36
  37         ---Purpose: Empty constructor.
  38
  39         returns IntersectionPoint from IntRes2d;
  40
  41
  42     Create(P: Pnt2d from gp; Uc1,Uc2:Real from Standard;
  43            Trans1,Trans2: Transition from IntRes2d;
  44            ReversedFlag: Boolean from Standard)
  45
  46         ---Purpose: Creates an IntersectionPoint.
  47         --          if ReversedFlag is False, the parameter Uc1(resp. Uc2)
  48         --          and the Transition Trans1 (resp. Trans2) refer to
  49         --          the first curve (resp. second curve) otherwise Uc1
  50         --          and Trans1 (resp. Uc2 and Trans2) refer to the
  51         --          second curve (resp. the first curve).
  52
  53         ---C++: inline
  54
  55         returns IntersectionPoint from IntRes2d;
  56
  57
  58     SetValues(me:in out; P: Pnt2d from gp; Uc1,Uc2:Real from Standard;
  59               Trans1,Trans2: Transition from IntRes2d;
  60               ReversedFlag: Boolean from Standard)
  61
  62         ---Purpose: Sets the values for an existing intersection
  63         --          point. The meaning of the parameters are the same
  64         --          as for the Create.
  65
  66         ---C++: inline
  67
  68         is static;
  69
  70
  71
  72     Value(me)
  73
  74         ---Purpose: Returns the value of the coordinates of the
  75         --          intersection point in the 2D space.
  76
  77         ---C++: inline
  78         ---C++: return const &
  79
  80         returns Pnt2d from gp
  81         is static;
  82
  83
  84     ParamOnFirst(me)
  85
  86         ---Purpose: Returns the parameter on the first curve.
  87
  88         ---C++: inline
  89
  90         returns Real from Standard
  91         is static;
  92
  93
  94     ParamOnSecond(me)
  95
  96         ---Purpose: Returns the parameter on the second curve.
  97
  98         ---C++: inline
  99
 100         returns Real from Standard
 101         is static;
 102
 103
 104     TransitionOfFirst(me)
 105
 106         ---Purpose: Returns the transition of the 1st curve compared to
 107         --          the 2nd one.
 108
 109         ---C++: inline
 110         ---C++: return const &
 111         returns Transition from IntRes2d
 112         is static;
 113
 114
 115     TransitionOfSecond(me)
 116
 117         ---Purpose: returns the transition of the 2nd curve compared to
 118         --          the 1st one.
 119
 120         ---C++: inline
 121         ---C++: return const &
 122         returns Transition from IntRes2d
 123         is static;
 124
 125
 126 fields
 127
 128     pt       : Pnt2d      from gp;
 129     p1       : Real       from Standard;
 130     p2       : Real       from Standard;
 131     trans1   : Transition from IntRes2d;
 132     trans2   : Transition from IntRes2d;
 133
 134 end IntersectionPoint;
 135
 136