include/opencascade/LProp_CurAndInf.hxx

0001 // Created on: 1994-09-02
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 _LProp_CurAndInf_HeaderFile
0018 #define _LProp_CurAndInf_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TColStd_SequenceOfReal.hxx>
0025 #include <LProp_SequenceOfCIType.hxx>
0026 #include <Standard_Boolean.hxx>
0027 #include <LProp_CIType.hxx>
0028
0029
0030 //! Stores the parameters of a curve 2d or 3d corresponding
0031 //! to the curvature's extremas and the Inflection's Points.
0032 class LProp_CurAndInf
0033 {
0034 public:
0035
0036   DEFINE_STANDARD_ALLOC
0037
0038
0039   Standard_EXPORT LProp_CurAndInf();
0040
0041   Standard_EXPORT void AddInflection (const Standard_Real Param);
0042
0043   Standard_EXPORT void AddExtCur (const Standard_Real Param, const Standard_Boolean IsMin);
0044
0045   Standard_EXPORT void Clear();
0046
0047   Standard_EXPORT Standard_Boolean IsEmpty() const;
0048
0049   //! Returns the number of points.
0050   //! The Points are stored to increasing parameter.
0051   Standard_EXPORT Standard_Integer NbPoints() const;
0052
0053   //! Returns the parameter of the Nth point.
0054   //! raises if N not in the range [1,NbPoints()]
0055   Standard_EXPORT Standard_Real Parameter (const Standard_Integer N) const;
0056
0057   //! Returns
0058   //! - MinCur if the Nth parameter corresponds to
0059   //! a minimum of the radius of curvature.
0060   //! - MaxCur if the Nth parameter corresponds to
0061   //! a maximum of the radius of curvature.
0062   //! - Inflection if the parameter corresponds to
0063   //! a point of inflection.
0064   //! raises if N not in the range [1,NbPoints()]
0065   Standard_EXPORT LProp_CIType Type (const Standard_Integer N) const;
0066
0067
0068
0069
0070 protected:
0071
0072
0073
0074
0075
0076 private:
0077
0078
0079
0080   TColStd_SequenceOfReal theParams;
0081   LProp_SequenceOfCIType theTypes;
0082
0083
0084 };
0085
0086
0087
0088
0089
0090
0091
0092 #endif // _LProp_CurAndInf_HeaderFile