src/Extrema/Extrema_GLocateExtCC2d.cdl

   1 -- Created on: 1994-07-06
   2 -- Created by: Laurent PAINNOT
   3 -- Copyright (c) 1994-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 generic class GLocateExtCC2d from Extrema (Curve1    as any;
  23                                            Tool1     as any;
  24                                            Curve2    as any;
  25                                            Tool2     as any)
  26
  27         ---Purpose: It calculates the distance between two curves with
  28         --          a close point; these distances can be maximum or
  29         --          minimum.
  30
  31 uses   POnCurv2d from Extrema,
  32        Pnt2d     from gp,
  33        Vec2d     from gp,
  34        HArray1OfPnt2d from TColgp
  35
  36 raises  DomainError  from Standard,
  37         NotDone      from StdFail
  38
  39
  40     class LCCache2d instantiates CurveCache from Extrema (Curve1, Pnt2d from gp, HArray1OfPnt2d from TColgp);
  41
  42     class ELCC2d    instantiates GenExtCC      from Extrema
  43         (Curve1,
  44          Tool1,
  45          Curve2,
  46          Tool2,
  47          LCCache2d,
  48          HArray1OfPnt2d from TColgp,
  49          POnCurv2d,
  50          Pnt2d,
  51          Vec2d);
  52
  53
  54     class LocECC2d    instantiates GenLocateExtCC      from Extrema
  55         (Curve1,
  56          Tool1,
  57          Curve2,
  58          Tool2,
  59          POnCurv2d,
  60          Pnt2d,
  61          Vec2d);
  62
  63
  64 is
  65     Create (C1: Curve1; C2: Curve2; U0,V0: Real)
  66         returns GLocateExtCC2d
  67         ---Purpose: Calculates the distance with a close point. The
  68         --          close point is defined by a parameter value on each
  69         --          curve.
  70         --          The function F(u,v)=distance(C1(u),C2(v)) has an
  71         --          extremun when gradient(f)=0. The algorithm searchs
  72         --          the zero near the close point.
  73         raises  DomainError;
  74                 -- if U0 and V0 are outside the definition ranges of the
  75                 -- curves.
  76
  77     IsDone (me) returns Boolean
  78         ---Purpose: Returns True if the distance is found.
  79         is static;
  80
  81     SquareDistance (me) returns Real
  82         ---Purpose: Returns the value of the extremum square distance.
  83         raises  NotDone from StdFail
  84                 -- if IsDone(me)=False.
  85         is static;
  86
  87     Point (me; P1,P2: out POnCurv2d)
  88         ---Purpose: Returns the points of the extremum distance.
  89         --          P1 is on the first curve, P2 on the second one.
  90         raises  NotDone from StdFail
  91                 -- if IsDone(me)=False.
  92         is static;
  93
  94 fields
  95     myDone  : Boolean;
  96     mySqDist: Real;
  97     myPoint1: POnCurv2d;
  98     myPoint2: POnCurv2d;
  99
 100 end GLocateExtCC2d;