src/Contap/Contap_Point.cdl

   1 -- File:      Contap_Point.cdl
   2 -- Created:   Thu Mar  4 17:22:45 1993
   3 -- Author:    Jacques GOUSSARD
   4 ---Copyright: Matra Datavision 1993
   5
   6 generic class Point from Contap
   7     (TheVertex as any;
   8      TheArc    as any)
   9
  10
  11         ---Purpose: Definition of a vertex on the contour line.
  12         --          Most of the time, such a point is an intersection
  13         --          between the contour and a restriction of the surface.
  14         --          When it is not tyhe method IsOnArc return False.
  15         --          Such a point is contains geometrical informations (see
  16         --          the Value method) and logical informations.
  17
  18
  19 uses Pnt        from gp,
  20      Transition from IntSurf
  21
  22
  23 raises DomainError from Standard
  24
  25 is
  26
  27
  28     Create
  29
  30         ---Purpose: Empty constructor.
  31
  32         returns Point from Contap;
  33
  34
  35     Create(Pt: Pnt from gp; U,V: Real from Standard)
  36
  37         ---Purpose: Creates a point.
  38
  39         returns Point from Contap;
  40
  41
  42     SetValue(me: in out; Pt: Pnt from gp; U,V: Real from Standard)
  43
  44         ---Purpose: Sets the values for a point.
  45
  46         ---C++: inline
  47
  48         is static;
  49
  50
  51     SetParameter(me: in out; Para: Real from Standard)
  52
  53         ---Purpose: Set the value of the parameter on the intersection line.
  54
  55         ---C++: inline
  56
  57         is static;
  58
  59
  60     SetVertex(me: in out; V: TheVertex)
  61
  62         ---Purpose: Sets the values of a point which is a vertex on
  63         --          the initial facet of restriction of one
  64         --          of the surface.
  65
  66         ---C++: inline
  67
  68         is static;
  69
  70
  71     SetArc(me: in out; A: TheArc; Param: Real from Standard;
  72                        TLine,TArc: Transition from IntSurf)
  73
  74         ---Purpose: Sets the value of the arc and of the parameter on
  75         --          this arc of the point.
  76
  77         ---C++: inline
  78
  79         is static;
  80
  81
  82     SetMultiple(me: in out)
  83
  84         ---C++: inline
  85
  86         is static;
  87
  88
  89     SetInternal(me : in out)
  90         ---C++: inline
  91         is static;
  92
  93     Value(me)
  94
  95         ---Purpose: Returns the intersection point (geometric information).
  96
  97         returns Pnt from gp
  98         ---C++: return const&
  99         ---C++: inline
 100
 101         is static;
 102
 103
 104     ParameterOnLine(me)
 105
 106         ---Purpose: This method returns the parameter of the point
 107         --          on the intersection line.
 108         --          If the points does not belong to an intersection line,
 109         --          the value returned does not have any sens.
 110
 111         returns Real from Standard
 112
 113         ---C++: inline
 114
 115         is static;
 116
 117
 118     Parameters(me; U1,V1: out Real from Standard)
 119
 120         ---Purpose: Returns the parameters on the surface of the point.
 121
 122         ---C++: inline
 123
 124         is static;
 125
 126
 127     IsOnArc(me)
 128
 129         ---Purpose: Returns True when the point is an intersection between
 130         --          the contour and a restriction.
 131
 132         returns Boolean from Standard
 133         ---C++: inline
 134
 135         is static;
 136
 137
 138     Arc(me)
 139
 140         ---Purpose: Returns the arc of restriction containing the
 141         --          vertex.
 142
 143         returns any TheArc
 144         ---C++: return const&
 145         ---C++: inline
 146
 147         raises DomainError from Standard
 148         --- The exception DomianError is raised when IsOnArc
 149         --  returns Standard_False.
 150         is static;
 151
 152
 153     ParameterOnArc(me)
 154
 155         ---Purpose: Returns the parameter of the point on the
 156         --          arc returned by the method Arc().
 157
 158         returns Real from Standard
 159         ---C++: inline
 160
 161         raises DomainError from Standard
 162         --- The exception DomianError is raised when IsOnArc
 163         --  returns Standard_False.
 164         is static;
 165
 166
 167     TransitionOnLine(me)
 168
 169         ---Purpose: Returns the transition of the point on the contour.
 170
 171         returns Transition from IntSurf
 172         ---C++: inline
 173         ---C++: return const&
 174
 175         raises DomainError from Standard
 176         --- The exception DomianError is raised when IsOnArc
 177         --  returns Standard_False.
 178         is static;
 179
 180
 181     TransitionOnArc(me)
 182
 183         ---Purpose: Returns the transition of the point on the arc.
 184
 185         returns Transition from IntSurf
 186         ---C++: inline
 187         ---C++: return const&
 188
 189         raises DomainError from Standard
 190         --- The exception DomianError is raised when IsOnArc
 191         --  returns Standard_False.
 192         is static;
 193
 194
 195     IsVertex(me)
 196
 197         ---Purpose: Returns TRUE if the point is a vertex on the initial
 198         --          restriction facet of the surface.
 199
 200         returns Boolean from Standard
 201         ---C++: inline
 202
 203         is static;
 204
 205
 206     Vertex(me)
 207
 208         ---Purpose: Returns the information about the point when it is
 209         --          on the domain of the patch, i-e when the function
 210         --          IsVertex returns True.
 211         --          Otherwise, an exception is raised.
 212
 213         returns any TheVertex
 214         ---C++: return const&
 215         ---C++: inline
 216
 217         raises DomainError from Standard
 218
 219         is static;
 220
 221
 222     IsMultiple(me)
 223
 224         ---Purpose: Returns True if the point belongs to several
 225         --          lines.
 226
 227         returns Boolean from Standard
 228         ---C++: inline
 229
 230         is static;
 231
 232     IsInternal(me)
 233
 234         ---Purpose: Returns True if the point  is an internal one, i.e
 235         --          if the  tangent to the line on  the point  and the
 236         --          eye direction are parallel.
 237
 238         returns Boolean from Standard
 239         ---C++: inline
 240
 241         is static;
 242
 243
 244 fields
 245
 246     pt         : Pnt         from gp;
 247     uparam     : Real        from Standard;
 248     vparam     : Real        from Standard;
 249     paraline   : Real        from Standard;
 250     onarc      : Boolean     from Standard;
 251     arc        : TheArc;
 252     traline    : Transition  from IntSurf;
 253     traarc     : Transition  from IntSurf;
 254     prmarc     : Real        from Standard;
 255     isvtx      : Boolean     from Standard;
 256     vtx        : TheVertex;
 257     ismult     : Boolean     from Standard;
 258     myInternal : Boolean     from Standard;
 259
 260 end Point;