Files
OCCT/src/BRepBlend/BRepBlend_SurfCurvEvolRadInv.cdl
ski ff8178ef85 0024784: Move documentation in CDL files to proper location
Mostly duplicated comments were removed and missing ones were moved
into dedicated class CDL files.
Some more duplicated comments were removed from CDL files.
Correction of merge
2014-05-29 16:06:49 +04:00

112 lines
4.1 KiB
Plaintext

-- Created on: 1997-07-29
-- Created by: Jerome LEMONIER
-- Copyright (c) 1997-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and/or modify it under
-- the terms of the GNU Lesser General Public License version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.
class SurfCurvEvolRadInv from BRepBlend
inherits SurfCurvFuncInv from Blend
---Purpose: Function of reframing between a surface restriction
-- of the surface and a curve.
-- Class used to compute a solution of the
-- surfRstConstRad problem on a done restriction of the
-- surface.
-- The vector <X> used in Value, Values and Derivatives
-- methods has to be the vector of the parametric
-- coordinates wguide, wcurv, wrst where wguide is the
-- parameter on the guide line, wcurv is the parameter on
-- the curve, wrst is the parameter on the restriction on
-- the surface.
uses
HCurve2d from Adaptor2d,
HCurve from Adaptor3d,
HSurface from Adaptor3d,
Vector from math,
Matrix from math,
Function from Law
is
Create(S : HSurface from Adaptor3d;
C : HCurve from Adaptor3d;
Cg : HCurve from Adaptor3d;
Evol : Function from Law)
returns SurfCurvEvolRadInv from BRepBlend;
Set(me: in out;Choix: Integer from Standard)
is static;
NbEquations(me)
---Purpose: returns 3.
returns Integer from Standard;
Value(me: in out; X: Vector; F: out Vector)
---Purpose: computes the values <F> of the Functions for the
-- variable <X>.
-- Returns True if the computation was done successfully,
-- False otherwise.
returns Boolean from Standard;
Derivatives(me: in out; X: Vector; D: out Matrix)
---Purpose: returns the values <D> of the derivatives for the
-- variable <X>.
-- Returns True if the computation was done successfully,
-- False otherwise.
returns Boolean from Standard;
Values(me: in out; X: Vector; F: out Vector; D: out Matrix)
---Purpose: returns the values <F> of the functions and the derivatives
-- <D> for the variable <X>.
-- Returns True if the computation was done successfully,
-- False otherwise.
returns Boolean from Standard;
Set(me: in out; Rst : HCurve2d from Adaptor2d);
---Purpose: Set the restriction on which a solution has to be found.
GetTolerance(me; Tolerance: out Vector from math; Tol: Real from Standard);
---Purpose: Returns in the vector Tolerance the parametric tolerance
-- for each of the 3 variables;
-- Tol is the tolerance used in 3d space.
GetBounds(me; InfBound,SupBound: out Vector from math);
---Purpose: Returns in the vector InfBound the lowest values allowed
-- for each of the 3 variables.
-- Returns in the vector SupBound the greatest values allowed
-- for each of the 3 variables.
IsSolution(me: in out; Sol: Vector from math; Tol: Real from Standard)
---Purpose: Returns Standard_True if Sol is a zero of the function.
-- Tol is the tolerance used in 3d space.
returns Boolean from Standard;
fields
surf : HSurface from Adaptor3d;
curv : HCurve from Adaptor3d;
guide : HCurve from Adaptor3d;
rst : HCurve2d from Adaptor2d;
ray : Real from Standard;
choix : Integer from Standard;
tevol : Function from Law;
sg1 : Real from Standard;
end SurfCurvEvolRadInv;