src/AppDef/AppDef_MyLineTool.cdl

   1 -- Created on: 1993-01-20
   2 -- Created by: Laurent PAINNOT
   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
   9 -- under the terms of the GNU Lesser General Public 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 MyLineTool from AppDef
  18
  19 uses MultiLine     from AppDef,
  20      Pnt           from gp,
  21      Pnt2d         from gp,
  22      Vec           from gp,
  23      Vec2d         from gp,
  24      Array1OfPnt   from TColgp,
  25      Array1OfPnt2d from TColgp,
  26      Array1OfVec   from TColgp,
  27      Array1OfVec2d from TColgp,
  28      Status        from Approx
  29
  30 is
  31
  32
  33     FirstPoint(myclass; ML: MultiLine) returns Integer;
  34         ---Purpose: Returns the first index of multipoints of the MultiLine.
  35
  36
  37     LastPoint(myclass; ML: MultiLine) returns Integer;
  38         ---Purpose: Returns the last index of multipoints of the MultiLine.
  39
  40
  41
  42     NbP2d(myclass; ML: MultiLine) returns Integer;
  43         ---Purpose: Returns the number of 2d points of a MultiLine.
  44
  45
  46     NbP3d(myclass; ML: MultiLine) returns Integer;
  47         ---Purpose: Returns the number of 3d points of a MultiLine.
  48
  49
  50     Value(myclass; ML: MultiLine; MPointIndex: Integer;
  51           tabPt: out Array1OfPnt);
  52         ---Purpose: returns the 3d points of the multipoint <MPointIndex>
  53         --          when only 3d points exist.
  54
  55
  56     Value(myclass; ML: MultiLine; MPointIndex: Integer;
  57           tabPt2d: out Array1OfPnt2d);
  58         ---Purpose: returns the 2d points of the multipoint <MPointIndex>
  59         --          when only 2d points exist.
  60
  61
  62     Value(myclass; ML: MultiLine; MPointIndex: Integer;
  63           tabPt: out Array1OfPnt; tabPt2d: out Array1OfPnt2d);
  64         ---Purpose: returns the 3d and 2d points of the multipoint
  65         --          <MPointIndex>.
  66
  67
  68     Tangency(myclass; ML: MultiLine; MPointIndex: Integer;
  69              tabV: out Array1OfVec) returns Boolean;
  70         ---Purpose: returns the 3d points of the multipoint <MPointIndex>
  71         --          when only 3d points exist.
  72
  73
  74     Tangency(myclass; ML: MultiLine; MPointIndex: Integer;
  75           tabV2d: out Array1OfVec2d) returns Boolean;
  76         ---Purpose: returns the 2d tangency points of the multipoint
  77         --          <MPointIndex> only when 2d points exist.
  78
  79
  80     Tangency(myclass; ML: MultiLine; MPointIndex: Integer;
  81              tabV: out Array1OfVec; tabV2d: out Array1OfVec2d)
  82     returns Boolean;
  83         ---Purpose: returns the 3d and 2d points of the multipoint
  84         --          <MPointIndex>.
  85
  86
  87     Curvature(myclass; ML: MultiLine; MPointIndex: Integer;
  88              tabV: out Array1OfVec) returns Boolean;
  89         ---Purpose: returns the 3d curvatures of the multipoint <MPointIndex>
  90         --          when only 3d points exist.
  91
  92
  93     Curvature(myclass; ML: MultiLine; MPointIndex: Integer;
  94           tabV2d: out Array1OfVec2d) returns Boolean;
  95         ---Purpose: returns the 2d curvatures of the multipoint
  96         --          <MPointIndex> only when 2d points exist.
  97
  98
  99     Curvature(myclass; ML: MultiLine; MPointIndex: Integer;
 100              tabV: out Array1OfVec; tabV2d: out Array1OfVec2d)
 101     returns Boolean;
 102         ---Purpose: returns the 3d and 2d curvatures of the multipoint
 103         --          <MPointIndex>.
 104
 105
 106
 107     WhatStatus(myclass; ML: MultiLine; I1, I2: Integer)
 108     returns Status from Approx;
 109         ---Purpose:  returns NoPointsAdded
 110
 111     MakeMLBetween(myclass; ML: MultiLine; I1, I2: Integer;
 112                   NbPMin: Integer)
 113     returns MultiLine;
 114         ---Purpose: Is never called in the algorithms.
 115         --          Nothing is done.
 116         ---C++: return &
 117
 118
 119 end MyLineTool;