include/opencascade/Blend_CSFunction.hxx

0001 // Created on: 1993-09-13
0002 // Created by: Jacques GOUSSARD
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Blend_CSFunction_HeaderFile
0018 #define _Blend_CSFunction_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Blend_AppFunction.hxx>
0025 #include <Standard_Boolean.hxx>
0026 #include <math_Vector.hxx>
0027 #include <TColStd_Array1OfReal.hxx>
0028 #include <TColStd_Array1OfInteger.hxx>
0029 #include <TColgp_Array1OfPnt.hxx>
0030 #include <TColgp_Array1OfVec.hxx>
0031 #include <TColgp_Array1OfPnt2d.hxx>
0032 #include <TColgp_Array1OfVec2d.hxx>
0033 class math_Matrix;
0034 class gp_Pnt;
0035 class gp_Pnt2d;
0036 class gp_Vec;
0037 class gp_Vec2d;
0038 class Blend_Point;
0039
0040
0041 //! Deferred class for a function used to compute a blending
0042 //! surface between a surface and a curve, using a guide line.
0043 //! The vector <X> used in Value, Values and Derivatives methods
0044 //! may be the vector of the parametric coordinates U,V,
0045 //! W of the extremities of a section on the surface  and
0046 //! the curve.
0047 class Blend_CSFunction  : public Blend_AppFunction
0048 {
0049 public:
0050
0051   DEFINE_STANDARD_ALLOC
0052
0053
0054   //! Returns 3 (default value). Can be redefined.
0055   Standard_EXPORT virtual Standard_Integer NbVariables() const Standard_OVERRIDE;
0056
0057   //! returns the number of equations of the function.
0058   Standard_EXPORT virtual Standard_Integer NbEquations() const Standard_OVERRIDE = 0;
0059
0060   //! computes the values <F> of the Functions for the
0061   //! variable <X>.
0062   //! Returns True if the computation was done successfully,
0063   //! False otherwise.
0064   Standard_EXPORT virtual Standard_Boolean Value (const math_Vector& X, math_Vector& F) Standard_OVERRIDE = 0;
0065
0066   //! returns the values <D> of the derivatives for the
0067   //! variable <X>.
0068   //! Returns True if the computation was done successfully,
0069   //! False otherwise.
0070   Standard_EXPORT virtual Standard_Boolean Derivatives (const math_Vector& X, math_Matrix& D) Standard_OVERRIDE = 0;
0071
0072   //! returns the values <F> of the functions and the derivatives
0073   //! <D> for the variable <X>.
0074   //! Returns True if the computation was done successfully,
0075   //! False otherwise.
0076   Standard_EXPORT virtual Standard_Boolean Values (const math_Vector& X, math_Vector& F, math_Matrix& D) Standard_OVERRIDE = 0;
0077
0078   //! Sets the value of the parameter along the guide line.
0079   //! This determines the plane in which the solution has
0080   //! to be found.
0081   Standard_EXPORT virtual void Set (const Standard_Real Param) Standard_OVERRIDE = 0;
0082
0083   //! Sets the bounds of the parametric interval on
0084   //! the guide line.
0085   //! This determines the derivatives in these values if the
0086   //! function is not Cn.
0087   Standard_EXPORT virtual void Set (const Standard_Real First, const Standard_Real Last) Standard_OVERRIDE = 0;
0088
0089   //! Returns in the vector Tolerance the parametric tolerance
0090   //! for each of the 3 variables;
0091   //! Tol is the tolerance used in 3d space.
0092   Standard_EXPORT virtual void GetTolerance (math_Vector& Tolerance, const Standard_Real Tol) const Standard_OVERRIDE = 0;
0093
0094   //! Returns in the vector InfBound the lowest values allowed
0095   //! for each of the 3 variables.
0096   //! Returns in the vector SupBound the greatest values allowed
0097   //! for each of the 3 variables.
0098   Standard_EXPORT virtual void GetBounds (math_Vector& InfBound, math_Vector& SupBound) const Standard_OVERRIDE = 0;
0099
0100   //! Returns Standard_True if Sol is a zero of the function.
0101   //! Tol is the tolerance used in 3d space.
0102   //! The computation is made at the current value of
0103   //! the parameter on the guide line.
0104   Standard_EXPORT virtual Standard_Boolean IsSolution (const math_Vector& Sol, const Standard_Real Tol) Standard_OVERRIDE = 0;
0105
0106   //! Returns   the    minimal  Distance  between   two
0107   //! extremities of calculated sections.
0108   Standard_EXPORT virtual Standard_Real GetMinimalDistance() const Standard_OVERRIDE;
0109
0110   //! Returns the point on the first support.
0111   Standard_EXPORT const gp_Pnt& Pnt1() const Standard_OVERRIDE;
0112
0113   //! Returns the point on the seconde support.
0114   Standard_EXPORT const gp_Pnt& Pnt2() const Standard_OVERRIDE;
0115
0116   //! Returns the point on the surface.
0117   Standard_EXPORT virtual const gp_Pnt& PointOnS() const = 0;
0118
0119   //! Returns the point on the curve.
0120   Standard_EXPORT virtual const gp_Pnt& PointOnC() const = 0;
0121
0122   //! Returns U,V coordinates of the point on the surface.
0123   Standard_EXPORT virtual const gp_Pnt2d& Pnt2d() const = 0;
0124
0125   //! Returns parameter of the point on the curve.
0126   Standard_EXPORT virtual Standard_Real ParameterOnC() const = 0;
0127
0128   //! Returns True when it is not possible to compute
0129   //! the tangent vectors at PointOnS and/or PointOnC.
0130   Standard_EXPORT virtual Standard_Boolean IsTangencyPoint() const = 0;
0131
0132   //! Returns the tangent vector at PointOnS, in 3d space.
0133   Standard_EXPORT virtual const gp_Vec& TangentOnS() const = 0;
0134
0135   //! Returns the tangent vector at PointOnS, in the
0136   //! parametric space of the first surface.
0137   Standard_EXPORT virtual const gp_Vec2d& Tangent2d() const = 0;
0138
0139   //! Returns the tangent vector at PointOnC, in 3d space.
0140   Standard_EXPORT virtual const gp_Vec& TangentOnC() const = 0;
0141
0142   //! Returns the tangent vector at the section,
0143   //! at the beginning and the end of the section, and
0144   //! returns the normal (of the surfaces) at
0145   //! these points.
0146   Standard_EXPORT virtual void Tangent (const Standard_Real U, const Standard_Real V, gp_Vec& TgS, gp_Vec& NormS) const = 0;
0147
0148   Standard_EXPORT virtual void GetShape (Standard_Integer& NbPoles, Standard_Integer& NbKnots, Standard_Integer& Degree, Standard_Integer& NbPoles2d) Standard_OVERRIDE = 0;
0149
0150   //! Returns the tolerance to reach in approximation
0151   //! to respecte
0152   //! BoundTol error at the Boundary
0153   //! AngleTol tangent error at the Boundary
0154   //! SurfTol error inside the surface.
0155   Standard_EXPORT virtual void GetTolerance (const Standard_Real BoundTol, const Standard_Real SurfTol, const Standard_Real AngleTol, math_Vector& Tol3d, math_Vector& Tol1D) const Standard_OVERRIDE = 0;
0156
0157   Standard_EXPORT virtual void Knots (TColStd_Array1OfReal& TKnots) Standard_OVERRIDE = 0;
0158
0159   Standard_EXPORT virtual void Mults (TColStd_Array1OfInteger& TMults) Standard_OVERRIDE = 0;
0160
0161   //! Used for the first and last section
0162   //! The method returns Standard_True if the derivatives
0163   //! are computed, otherwise it returns Standard_False.
0164   Standard_EXPORT virtual Standard_Boolean Section (const Blend_Point& P, TColgp_Array1OfPnt& Poles, TColgp_Array1OfVec& DPoles, TColgp_Array1OfPnt2d& Poles2d, TColgp_Array1OfVec2d& DPoles2d, TColStd_Array1OfReal& Weigths, TColStd_Array1OfReal& DWeigths) Standard_OVERRIDE = 0;
0165
0166   Standard_EXPORT virtual void Section (const Blend_Point& P, TColgp_Array1OfPnt& Poles, TColgp_Array1OfPnt2d& Poles2d, TColStd_Array1OfReal& Weigths) Standard_OVERRIDE = 0;
0167
0168   //! Used for the first and last section
0169   //! The method returns Standard_True if the derivatives
0170   //! are computed, otherwise it returns Standard_False.
0171   Standard_EXPORT virtual Standard_Boolean Section (const Blend_Point& P, TColgp_Array1OfPnt& Poles, TColgp_Array1OfVec& DPoles, TColgp_Array1OfVec& D2Poles, TColgp_Array1OfPnt2d& Poles2d, TColgp_Array1OfVec2d& DPoles2d, TColgp_Array1OfVec2d& D2Poles2d, TColStd_Array1OfReal& Weigths, TColStd_Array1OfReal& DWeigths, TColStd_Array1OfReal& D2Weigths) Standard_OVERRIDE;
0172
0173
0174
0175
0176 protected:
0177
0178
0179
0180
0181
0182 private:
0183
0184
0185
0186
0187
0188 };
0189
0190
0191
0192
0193
0194
0195
0196 #endif // _Blend_CSFunction_HeaderFile