src/MAT2d/MAT2d_Connexion.cdl

   1 -- Created on: 1993-10-07
   2 -- Created by: Yves FRICAUD
   3 -- Copyright (c) 1993-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 Connexion from MAT2d
  18
  19 inherits
  20
  21     TShared from MMgt
  22
  23         ---Purpose: A Connexion links two lines of items  in a set
  24         --          of  lines. It s contains two  points and their paramatric
  25         --          definitions on the lines.
  26         --          The items can be points or curves.
  27
  28 uses
  29     Pnt2d from gp
  30
  31 is
  32
  33     Create returns Connexion from MAT2d;
  34
  35     Create(LineA        : Integer;
  36            LineB        : Integer;
  37            ItemA        : Integer;
  38            ItemB        : Integer;
  39            Distance     : Real;
  40            ParameterOnA : Real;
  41            ParameterOnB : Real;
  42            PointA       : Pnt2d from gp;
  43            PointB       : Pnt2d from gp)
  44     returns Connexion from MAT2d;
  45
  46     IndexFirstLine(me) returns Integer
  47         ---Purpose:  Returns the Index on the first line.
  48     is static;
  49
  50     IndexSecondLine(me) returns Integer
  51         ---Purpose:  Returns the Index on the Second line.
  52     is static;
  53
  54     IndexItemOnFirst(me) returns Integer
  55         ---Purpose: Returns the Index of the item on the first line.
  56     is static;
  57
  58     IndexItemOnSecond(me) returns Integer
  59         ---Purpose: Returns the Index of the item on the second line.
  60     is static;
  61
  62     ParameterOnFirst(me) returns Real
  63         ---Purpose: Returns the parameter of the point on the firstline.
  64     is static;
  65
  66     ParameterOnSecond(me) returns Real
  67         ---Purpose: Returns the parameter of the point on the secondline.
  68     is static;
  69
  70     PointOnFirst(me) returns Pnt2d from gp
  71         ---Purpose: Returns the point on the firstline.
  72     is static;
  73
  74     PointOnSecond(me) returns Pnt2d from gp
  75         ---Purpose: Returns the point on the secondline.
  76     is static;
  77
  78     Distance (me) returns Real
  79         ---Purpose: Returns the distance between the two points.
  80     is static;
  81
  82     IndexFirstLine(me : mutable ; anIndex : Integer)
  83     is static;
  84
  85     IndexSecondLine(me : mutable ; anIndex : Integer)
  86     is static;
  87
  88     IndexItemOnFirst(me : mutable ; anIndex : Integer)
  89     is static;
  90
  91     IndexItemOnSecond(me : mutable ; anIndex : Integer)
  92     is static;
  93
  94     ParameterOnFirst(me : mutable ; aParameter : Real)
  95     is static;
  96
  97     ParameterOnSecond(me : mutable ; aParameter : Real)
  98     is static;
  99
 100     PointOnFirst(me : mutable ; aPoint : Pnt2d from gp)
 101     is static;
 102
 103     PointOnSecond(me : mutable ; aPoint : Pnt2d from gp)
 104     is static;
 105
 106     Distance (me : mutable ; aDistance : Real)
 107     is static;
 108
 109     Reverse(me)
 110        ---Purpose: Returns the reverse connexion of <me>.
 111        --          the firstpoint  is the secondpoint.
 112        --          the secondpoint is the firstpoint.
 113     returns Connexion from MAT2d
 114     is static;
 115
 116     IsAfter(me ; aConnexion : Connexion from MAT2d ; aSense : Real)
 117        ---Purpose: Returns <True> if my firstPoint is on the same line
 118        --          than the firstpoint of <aConnexion> and my firstpoint
 119        --          is after the firstpoint of <aConnexion> on the line.
 120        --          <aSense> = 1 if <aConnexion> is on the Left of its
 121        --          firstline, else <aSense> = -1.
 122     returns Boolean from Standard
 123     is static;
 124
 125     Dump (me; Deep : Integer = 0; Offset : Integer = 0)
 126         ---Purpose: Print <me>.
 127     is static;
 128
 129 fields
 130
 131     lineA        : Integer;
 132     lineB        : Integer;
 133     itemA        : Integer;
 134     itemB        : Integer;
 135     distance     : Real;
 136     parameterOnA : Real;
 137     parameterOnB : Real;
 138     pointA       : Pnt2d from gp;
 139     pointB       : Pnt2d from gp;
 140
 141 end Connexion;