src/BRepBlend/BRepBlend_CurvPointRadInv.cdl

   1 -- Created on: 1997-02-12
   2 -- Created by: Laurent BOURESCHE
   3 -- Copyright (c) 1997-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 class CurvPointRadInv from BRepBlend
  23
  24 inherits CurvPointFuncInv from Blend
  25
  26     ---Purpose: This function  is used  to find a  solution on  a done
  27     --          point   of   the curve 1 when   using  RstRstConsRad or
  28     --          CSConstRad...
  29     --          The vector <X>  used in Value, Values and  Derivatives
  30     --          methods  has  to   be the  vector   of the  parametric
  31     --          coordinates w, U where w is  the parameter  on the
  32     --          guide line, U   are the parametric coordinates of  a
  33     --          point on the partner curve 2.
  34
  35 uses
  36     Pnt      from gp,
  37     Vector   from math,
  38     Matrix   from math,
  39     HCurve   from Adaptor3d
  40
  41
  42 is
  43     Create(C1 : HCurve from Adaptor3d; C2  : HCurve from Adaptor3d)
  44     returns CurvPointRadInv from BRepBlend;
  45
  46     Set(me: in out; Choix: Integer from Standard)
  47     is static;
  48
  49     NbEquations(me)
  50     ---Purpose: returns 2.
  51     returns Integer from Standard;
  52
  53     Value(me: in out; X: Vector; F: out Vector)
  54     ---Purpose: computes the values <F> of the Functions for the
  55     --          variable <X>.
  56     --          Returns True if the computation was done successfully,
  57     --          False otherwise.
  58     returns Boolean from Standard;
  59
  60     Derivatives(me: in out; X: Vector; D: out Matrix)
  61     ---Purpose: returns the values <D> of the derivatives for the
  62     --          variable <X>.
  63     --          Returns True if the computation was done successfully,
  64     --          False otherwise.
  65     returns Boolean from Standard;
  66
  67     Values(me: in out; X: Vector; F: out Vector; D: out Matrix)
  68     ---Purpose: returns the values <F> of the functions and the derivatives
  69     --          <D> for the variable <X>.
  70     --          Returns True if the computation was done successfully,
  71     --          False otherwise.
  72     returns Boolean from Standard;
  73
  74     Set(me: in out; P : Pnt from gp);
  75     ---Purpose: Set the Point on which a solution has to be found.
  76
  77     GetTolerance(me; Tolerance: out Vector from math; Tol: Real from Standard);
  78     ---Purpose: Returns in the vector Tolerance the parametric tolerance
  79     --          for each of the 3 variables;
  80     --          Tol is the tolerance used in 3d space.
  81
  82     GetBounds(me; InfBound,SupBound: out Vector from math);
  83     ---Purpose: Returns in the vector InfBound the lowest values allowed
  84     --          for each of the 3 variables.
  85     --          Returns in the vector SupBound the greatest values allowed
  86     --          for each of the 3 variables.
  87
  88     IsSolution(me: in out; Sol: Vector from math; Tol: Real from Standard)
  89     ---Purpose: Returns Standard_True if Sol is a zero of the function.
  90     --          Tol is the tolerance used in 3d space.
  91     returns Boolean from Standard;
  92
  93 fields
  94
  95     curv1 : HCurve   from Adaptor3d;
  96     curv2 : HCurve   from Adaptor3d;
  97     point : Pnt      from gp;
  98     choix : Integer  from Standard;
  99
 100 end CurvPointRadInv;