src/GccAna/GccAna_LinPnt2dBisec.cdl

   1 -- Created on: 1991-04-03
   2 -- Created by: Remi GILET
   3 -- Copyright (c) 1991-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 LinPnt2dBisec
  18
  19 from GccAna
  20
  21         ---Purpose: Describes functions for building bisecting curves between a 2D line and a point.
  22         -- A bisecting curve between a line and a point is such a
  23         -- curve that each of its points is at the same distance from
  24         -- the circle and the point. It can be a parabola or a line,
  25         -- depending on the relative position of the line and the
  26         -- circle. There is always one unique solution.
  27         -- A LinPnt2dBisec object provides a framework for:
  28         -- - defining the construction of the bisecting curve,
  29         -- - implementing the construction algorithm, and
  30         -- - consulting the result.
  31
  32 --inherits Storable from Standard
  33
  34 uses Lin2d from gp,
  35      Pnt2d from gp,
  36      Bisec from GccInt
  37
  38 raises ConstructionError from Standard,
  39        NotDone           from StdFail
  40
  41 is
  42
  43 Create(Line1   : Lin2d from gp;
  44        Point2  : Pnt2d from gp) returns LinPnt2dBisec
  45 raises ConstructionError;
  46         ---Purpose: Constructs a bisecting curve between the line Line1 and the point Point2.
  47
  48 IsDone(me) returns Boolean from Standard
  49 is static;
  50         ---Purpose : Returns True if the algorithm succeeded.
  51
  52 ThisSolution(me) returns Bisec from GccInt
  53         ---Purpose : Returns the number of solutions.
  54 raises NotDone
  55 is static;
  56         ---Purpose: It raises NotDone if the construction algorithm didn't succeed.
  57
  58 fields
  59
  60     WellDone : Boolean from Standard;
  61         ---Purpose:  True if the algorithm succeeded.
  62
  63     bissol   : Bisec from GccInt;
  64         ---Purpose : The solutions.
  65
  66 end LinPnt2dBisec;