include/opencascade/Law_Linear.hxx

0001 // Created on: 1995-01-12
0002 // Created by: Laurent BOURESCHE
0003 // Copyright (c) 1995-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 _Law_Linear_HeaderFile
0018 #define _Law_Linear_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Law_Function.hxx>
0024 #include <GeomAbs_Shape.hxx>
0025 #include <Standard_Integer.hxx>
0026 #include <TColStd_Array1OfReal.hxx>
0027
0028 class Law_Linear;
0029 DEFINE_STANDARD_HANDLE(Law_Linear, Law_Function)
0030
0031 //! Describes an linear evolution law.
0032 class Law_Linear : public Law_Function
0033 {
0034
0035 public:
0036   //! Constructs an empty linear evolution law.
0037   Standard_EXPORT Law_Linear();
0038
0039   //! Defines this linear evolution law by assigning both:
0040   //! -   the bounds Pdeb and Pfin of the parameter, and
0041   //! -   the values Valdeb and Valfin of the function at these
0042   //! two parametric bounds.
0043   Standard_EXPORT void Set(const Standard_Real Pdeb,
0044                            const Standard_Real Valdeb,
0045                            const Standard_Real Pfin,
0046                            const Standard_Real Valfin);
0047
0048   //! Returns GeomAbs_CN
0049   Standard_EXPORT GeomAbs_Shape Continuity() const Standard_OVERRIDE;
0050
0051   //! Returns  1
0052   Standard_EXPORT Standard_Integer NbIntervals(const GeomAbs_Shape S) const Standard_OVERRIDE;
0053
0054   Standard_EXPORT void Intervals(TColStd_Array1OfReal& T,
0055                                  const GeomAbs_Shape   S) const Standard_OVERRIDE;
0056
0057   //! Returns the value of this function at the point of parameter X.
0058   Standard_EXPORT Standard_Real Value(const Standard_Real X) Standard_OVERRIDE;
0059
0060   //! Returns the value F and the first derivative D of this
0061   //! function at the point of parameter X.
0062   Standard_EXPORT void D1(const Standard_Real X,
0063                           Standard_Real&      F,
0064                           Standard_Real&      D) Standard_OVERRIDE;
0065
0066   //! Returns the value, first and second derivatives
0067   //! at parameter X.
0068   Standard_EXPORT void D2(const Standard_Real X,
0069                           Standard_Real&      F,
0070                           Standard_Real&      D,
0071                           Standard_Real&      D2) Standard_OVERRIDE;
0072
0073   //! Returns a  law equivalent of  <me>  between
0074   //! parameters <First>  and <Last>. <Tol>  is used  to
0075   //! test for 3d points confusion.
0076   //! It is usfule to determines the derivatives
0077   //! in these values <First> and <Last> if
0078   //! the Law is not Cn.
0079   Standard_EXPORT Handle(Law_Function) Trim(const Standard_Real PFirst,
0080                                             const Standard_Real PLast,
0081                                             const Standard_Real Tol) const Standard_OVERRIDE;
0082
0083   //! Returns the parametric bounds of the function.
0084   Standard_EXPORT void Bounds(Standard_Real& PFirst, Standard_Real& PLast) Standard_OVERRIDE;
0085
0086   DEFINE_STANDARD_RTTIEXT(Law_Linear, Law_Function)
0087
0088 protected:
0089 private:
0090   Standard_Real valdeb;
0091   Standard_Real valfin;
0092   Standard_Real pdeb;
0093   Standard_Real pfin;
0094 };
0095
0096 #endif // _Law_Linear_HeaderFile