src/HatchGen/HatchGen_IntersectionPoint.cdl

   1 -- Created on: 1993-10-29
   2 -- Created by: Jean Marc LACHAUME
   3 -- Copyright (c) 1993-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 deferred class IntersectionPoint from HatchGen
  23
  24 uses
  25     Orientation       from TopAbs ,
  26     State             from TopAbs ,
  27     IntersectionPoint from IntRes2d
  28
  29 is
  30
  31
  32     Initialize
  33
  34         ---Purpose: Creates an empty intersection point.
  35
  36         ---Category: IntersectionPoint
  37
  38         is protected ;
  39
  40
  41     SetIndex (me : in out ; Index : Integer from Standard)
  42
  43         ---Purpose: Sets the index of the supporting curve.
  44
  45         ---Category: IntersectionPoint
  46
  47         is static ;
  48
  49
  50     Index (me)
  51
  52         ---Purpose: Returns the index of the supporting curve.
  53
  54         ---Category: IntersectionPoint
  55
  56         returns Integer from Standard
  57         is static ;
  58
  59
  60     SetParameter (me : in out ; Parameter : Real from Standard)
  61
  62         ---Purpose: Sets the parameter on the curve.
  63
  64         ---Category: IntersectionPoint
  65
  66         is static ;
  67
  68
  69     Parameter (me)
  70
  71         ---Purpose: Returns the parameter on the curve.
  72
  73         ---Category: IntersectionPoint
  74
  75         returns Real from Standard
  76         is static ;
  77
  78
  79     SetPosition (me : in out ; Position : Orientation from TopAbs)
  80
  81         ---Purpose: Sets the position of the point on the curve.
  82
  83         ---Category: IntersectionPoint
  84
  85         is static ;
  86
  87
  88     Position (me)
  89
  90         ---Purpose: Returns the position of the point on the curve.
  91
  92         ---Category: IntersectionPoint
  93
  94         returns Orientation from TopAbs
  95         is static ;
  96
  97
  98     SetStateBefore (me : in out ; State : State from TopAbs)
  99
 100         ---Purpose: Sets the transition state before the intersection.
 101
 102         ---Category: IntersectionPoint
 103
 104         is static ;
 105
 106
 107     StateBefore (me)
 108
 109         ---Purpose: Returns the transition state before the intersection.
 110
 111         ---Category: IntersectionPoint
 112
 113         returns State from TopAbs
 114         is static ;
 115
 116
 117     SetStateAfter (me : in out ; State : State from TopAbs)
 118
 119         ---Purpose: Sets the transition state after the intersection.
 120
 121         ---Category: IntersectionPoint
 122
 123         is static ;
 124
 125
 126     StateAfter (me)
 127
 128         ---Purpose: Returns the transition state after of the intersection.
 129
 130         ---Category: IntersectionPoint
 131
 132         returns State from TopAbs
 133         is static ;
 134
 135
 136     SetSegmentBeginning (me : in out ; State : Boolean from Standard = Standard_True)
 137
 138         ---Purpose: Sets the flag that the point is the beginning of a segment.
 139
 140         ---Category: IntersectionPoint
 141
 142         is static ;
 143
 144
 145     SegmentBeginning (me)
 146
 147         ---Purpose: Returns the flag that the point is the beginning of a segment.
 148
 149         ---Category: IntersectionPoint
 150
 151         returns Boolean from Standard
 152         is static ;
 153
 154
 155     SetSegmentEnd (me : in out ; State : Boolean from Standard = Standard_True)
 156
 157         ---Purpose: Sets the flag that the point is the end of a segment.
 158
 159         ---Category: IntersectionPoint
 160
 161         is static ;
 162
 163
 164     SegmentEnd (me)
 165
 166         ---Purpose: Returns the flag that the point is the end of a segment.
 167
 168         ---Category: IntersectionPoint
 169
 170         returns Boolean from Standard
 171         is static ;
 172
 173
 174     Dump (me; Index : Integer from Standard = 0)
 175
 176         ---Purpose: Dump of the point on element.
 177
 178         is deferred ;
 179
 180
 181 fields
 182
 183     myIndex  : Integer         from Standard is protected ;
 184     myParam  : Real            from Standard is protected ;
 185     myPosit  : Orientation     from TopAbs   is protected ;
 186     myBefore : State           from TopAbs   is protected ;
 187     myAfter  : State           from TopAbs   is protected ;
 188     mySegBeg : Boolean         from Standard is protected ;
 189     mySegEnd : Boolean         from Standard is protected ;
 190
 191 end IntersectionPoint from HatchGen ;