include/opencascade/Geom2dLProp_CurAndInf2d.hxx

0001 // Created on: 1994-09-06
0002 // Created by: Yves FRICAUD
0003 // Copyright (c) 1994-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 _Geom2dLProp_CurAndInf2d_HeaderFile
0018 #define _Geom2dLProp_CurAndInf2d_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <LProp_CurAndInf.hxx>
0025 class Geom2d_Curve;
0026
0027
0028 //! An algorithm for computing local properties of a curve.
0029 //! These properties include:
0030 //! - the maximum and minimum curvatures
0031 //! - the inflection points.
0032 //! A CurAndInf2d object provides the framework for:
0033 //! - defining the curve to be analyzed
0034 //! - implementing the computation algorithms
0035 //! - consulting the results.
0036 class Geom2dLProp_CurAndInf2d  : public LProp_CurAndInf
0037 {
0038 public:
0039
0040   DEFINE_STANDARD_ALLOC
0041
0042
0043   //! Initializes the framework.
0044   //! Note: The curve on which the local properties are
0045   //! computed is defined using one of the following
0046   //! functions: Perform, PerformCurExt or PerformInf.
0047   Standard_EXPORT Geom2dLProp_CurAndInf2d();
0048
0049   //! For the curve C, Computes both the
0050   //! inflection points and the maximum and minimum curvatures.
0051   Standard_EXPORT void Perform (const Handle(Geom2d_Curve)& C);
0052
0053   //! For the curve C, Computes the locals extremas of curvature.
0054   Standard_EXPORT void PerformCurExt (const Handle(Geom2d_Curve)& C);
0055
0056   //! For the curve C, Computes the inflections.
0057   //! After computation, the following functions can be used:
0058   //! - IsDone to check if the computation was successful
0059   //! - NbPoints to obtain the number of computed particular points
0060   //! - Parameter to obtain the parameter on the curve for
0061   //! each particular point
0062   //! - Type to check if the point is an inflection point or an
0063   //! extremum of curvature of the curve C.
0064   //! Warning
0065   //! These functions can be used to analyze a series of
0066   //! curves, however it is necessary to clear the table of
0067   //! results between each computation.
0068   Standard_EXPORT void PerformInf (const Handle(Geom2d_Curve)& C);
0069
0070   //! True if the solutions are found.
0071   Standard_EXPORT Standard_Boolean IsDone() const;
0072
0073
0074
0075
0076 protected:
0077
0078
0079
0080
0081
0082 private:
0083
0084
0085
0086   Standard_Boolean isDone;
0087
0088
0089 };
0090
0091
0092
0093
0094
0095
0096
0097 #endif // _Geom2dLProp_CurAndInf2d_HeaderFile