Files
OCCT/src/Blend/Blend_CSFunction.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

343 lines
9.6 KiB
Plaintext
Executable File

-- Created on: 1993-09-13
-- Created by: Jacques GOUSSARD
-- Copyright (c) 1993-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
deferred class CSFunction from Blend
inherits AppFunction from Blend
---Purpose: Deferred class for a function used to compute a blending
-- surface between a surface and a curve, using a guide line.
-- The vector <X> used in Value, Values and Derivatives methods
-- may be the vector of the parametric coordinates U,V,
-- W of the extremities of a section on the surface and
-- the curve.
uses Vector from math,
Matrix from math,
Vec from gp,
Vec2d from gp,
Pnt from gp,
Pnt2d from gp,
Point from Blend,
Array1OfPnt from TColgp,
Array1OfVec from TColgp,
Array1OfPnt2d from TColgp,
Array1OfVec2d from TColgp,
Array1OfReal from TColStd,
Array1OfInteger from TColStd
raises DomainError from Standard
is
NbVariables(me)
---Purpose: Returns 3 (default value). Can be redefined.
returns Integer from Standard
is virtual;
NbEquations(me)
---Purpose: returns the number of equations of the function.
returns Integer from Standard
is deferred;
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
is deferred;
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
is deferred;
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
is deferred;
Set(me: in out; Param: Real from Standard)
---Purpose: Sets the value of the parameter along the guide line.
-- This determines the plane in which the solution has
-- to be found.
is deferred;
Set(me: in out; First, Last: Real from Standard)
---Purpose: Sets the bounds of the parametric interval on
-- the guide line.
-- This determines the derivatives in these values if the
-- function is not Cn.
is deferred;
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.
is deferred;
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.
is deferred;
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.
-- The computation is made at the current value of
-- the parameter on the guide line.
returns Boolean from Standard
is deferred;
GetMinimalDistance(me)
---Purpose: Returns the minimal Distance beetween two
-- extremitys of calculed sections.
returns Real from Standard
is redefined;
--- TheFollowing methods are called only when
-- IsSolution returns Standard_True.
Pnt1(me)
---Purpose: Returns the point on the first support.
---See Also: PointOnC
---C++: return const &
returns Pnt from gp
is redefined static;
Pnt2(me)
---Purpose: Returns the point on the seconde support.
---See Also: PointOnS
---C++: return const &
returns Pnt from gp
is redefined static;
PointOnS(me)
---Purpose: Returns the point on the surface.
returns Pnt from gp
---C++: return const&
is deferred;
PointOnC(me)
---Purpose: Returns the point on the curve.
returns Pnt from gp
---C++: return const&
is deferred;
Pnt2d(me)
---Purpose: Returns U,V coordinates of the point on the surface.
returns Pnt2d from gp
---C++: return const&
is deferred;
ParameterOnC(me)
---Purpose: Returns parameter of the point on the curve.
returns Real from Standard
is deferred;
IsTangencyPoint(me)
---Purpose: Returns True when it is not possible to compute
-- the tangent vectors at PointOnS and/or PointOnC.
returns Boolean from Standard
is deferred;
TangentOnS(me)
---Purpose: Returns the tangent vector at PointOnS, in 3d space.
returns Vec from gp
---C++: return const&
raises DomainError from Standard
--- The exception is raised when IsTangencyPoint
-- returns Standard_True.
is deferred;
Tangent2d(me)
---Purpose: Returns the tangent vector at PointOnS, in the
-- parametric space of the first surface.
returns Vec2d from gp
---C++: return const&
raises DomainError from Standard
--- The exception is raised when IsTangencyPoint
-- returns Standard_True.
is deferred;
TangentOnC(me)
---Purpose: Returns the tangent vector at PointOnC, in 3d space.
returns Vec from gp
---C++: return const&
raises DomainError from Standard
--- The exception is raised when IsTangencyPoint
-- returns Standard_True.
is deferred;
Tangent(me; U,V: Real from Standard;
TgS,NormS: out Vec from gp)
---Purpose: Returns the tangent vector at the section,
-- at the beginning and the end of the section, and
-- returns the normal (of the surfaces) at
-- these points.
raises DomainError from Standard
--- The exception is raised when IsTangencyPoint
-- returns Standard_True.
is deferred;
-- Methods for the approximation
--
GetShape(me: in out;
NbPoles : out Integer from Standard;
NbKnots : out Integer from Standard;
Degree : out Integer from Standard;
NbPoles2d : out Integer from Standard)
is deferred;
GetTolerance(me;
BoundTol, SurfTol, AngleTol : Real;
Tol3d : out Vector;
Tol1D : out Vector )
---Purpose: Returns the tolerance to reach in approximation
-- to respecte
-- BoundTol error at the Boundary
-- AngleTol tangent error at the Boundary
-- SurfTol error inside the surface.
is deferred;
Knots(me: in out; TKnots: out Array1OfReal from TColStd)
is deferred;
Mults(me: in out; TMults: out Array1OfInteger from TColStd)
is deferred;
Section(me: in out; P: Point from Blend;
Poles : out Array1OfPnt from TColgp;
DPoles : out Array1OfVec from TColgp;
Poles2d : out Array1OfPnt2d from TColgp;
DPoles2d : out Array1OfVec2d from TColgp;
Weigths : out Array1OfReal from TColStd;
DWeigths : out Array1OfReal from TColStd)
---Purpose: Used for the first and last section
-- The method returns Standard_True if the derivatives
-- are computed, otherwise it returns Standard_False.
returns Boolean from Standard
is deferred;
Section(me: in out; P: Point from Blend;
Poles : out Array1OfPnt from TColgp;
Poles2d : out Array1OfPnt2d from TColgp;
Weigths : out Array1OfReal from TColStd)
is deferred;
Section(me: in out; P: Point from Blend;
Poles : out Array1OfPnt from TColgp;
DPoles : out Array1OfVec from TColgp;
D2Poles : out Array1OfVec from TColgp;
Poles2d : out Array1OfPnt2d from TColgp;
DPoles2d : out Array1OfVec2d from TColgp;
D2Poles2d : out Array1OfVec2d from TColgp;
Weigths : out Array1OfReal from TColStd;
DWeigths : out Array1OfReal from TColStd;
D2Weigths : out Array1OfReal from TColStd)
---Purpose: Used for the first and last section
-- The method returns Standard_True if the derivatives
-- are computed, otherwise it returns Standard_False.
returns Boolean from Standard
is redefined;
end CSFunction;