src/IntSurf/IntSurf_LineOn2S.cdl

   1 -- Created on: 1993-02-22
   2 -- Created by: Jacques GOUSSARD
   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
  23 class LineOn2S from IntSurf
  24
  25         ---Purpose:
  26
  27 inherits TShared from MMgt
  28
  29
  30 uses Allocator         from IntSurf,
  31      PntOn2S           from IntSurf,
  32      SequenceOfPntOn2S from IntSurf
  33
  34 raises OutOfRange from Standard
  35
  36 is
  37
  38     Create (theAllocator: Allocator from IntSurf = 0)
  39
  40         returns mutable LineOn2S from IntSurf;
  41
  42
  43     Add(me: mutable; P: PntOn2S from IntSurf)
  44
  45         ---Purpose: Adds a point in the line.
  46
  47         ---C++: inline
  48
  49         is static;
  50
  51
  52     NbPoints(me)
  53
  54         ---Purpose: Returns the number of points in the line.
  55
  56         returns Integer from Standard
  57         ---C++: inline
  58
  59         is static;
  60
  61
  62     Value(me; Index: Integer from Standard)
  63
  64         ---Purpose: Returns the point of range Index in the line.
  65
  66         returns PntOn2S from IntSurf
  67         ---C++: inline
  68         ---C++: return const&
  69
  70         raises OutOfRange from Standard
  71         --- The exception OutOfRange is raised when Index <= 0 or
  72         --  Index > NbPoints.
  73
  74         is static;
  75
  76
  77     Reverse(me: mutable)
  78
  79         ---Purpose: Reverses the order of points of the line.
  80
  81         ---C++: inline
  82
  83         is static;
  84
  85
  86
  87     Split(me: mutable;Index: Integer from Standard)
  88
  89         ---Purpose: Keeps in <me> the points 1 to Index-1, and returns
  90         --          the items Index to the end.
  91
  92         returns mutable LineOn2S from IntSurf
  93
  94         raises OutOfRange from Standard
  95         --- The exception OutOfRange is raised when Index <= 0 or
  96         --  Index > NbPoints.
  97
  98         is static;
  99
 100
 101     Value(me: mutable; Index: Integer from Standard; P: PntOn2S from IntSurf)
 102
 103         ---Purpose: Replaces the point of range Index in the line.
 104
 105         raises OutOfRange from Standard
 106         --- The exception OutOfRange is raised when Index <= 0 or
 107         --  Index > NbPoints.
 108
 109         ---C++: inline
 110
 111         is static;
 112
 113
 114     SetUV(me: mutable; Index: Integer from Standard;
 115                        OnFirst: Boolean from Standard;
 116                        U,V: Real from Standard)
 117
 118         ---Purpose: Sets the parametric coordinates on one of the surfaces
 119         --          of the point of range Index in the line.
 120
 121         ---C++: inline
 122
 123         raises OutOfRange from Standard
 124         --- The exception OutOfRange is raised when Index <= 0 or
 125         --  Index > NbPoints.
 126
 127         is static;
 128
 129
 130     Clear(me: mutable)
 131
 132         ---C++: inline
 133
 134         is static;
 135
 136
 137     InsertBefore(me:mutable; I: Integer from Standard; P: PntOn2S from IntSurf)
 138
 139         is static;
 140
 141     RemovePoint(me:mutable; I: Integer from Standard)
 142
 143         is static;
 144
 145
 146 fields
 147
 148     mySeq: SequenceOfPntOn2S from IntSurf;
 149
 150 end LineOn2S;