include/opencascade/IGESGeom_SplineSurface.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( Kiran )
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 _IGESGeom_SplineSurface_HeaderFile
0018 #define _IGESGeom_SplineSurface_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <NCollection_Array1.hxx>
0024 #include <NCollection_HArray1.hxx>
0025 #include <NCollection_Array2.hxx>
0026 #include <NCollection_HArray2.hxx>
0027 #include <IGESData_IGESEntity.hxx>
0028 #include <Standard_Real.hxx>
0029
0030 //! defines IGESSplineSurface, Type <114> Form <0>
0031 //! in package IGESGeom
0032 //! A parametric spline surface is a grid of polynomial
0033 //! patches. Patch could be of the type Linear, Quadratic,
0034 //! Cubic, Wilson-Fowler, Modified Wilson-Fowler, B-Spline
0035 //! The M * N grid of patches is defined by the 'u' break
0036 //! points TU(1), TU(2), ..., TU(M+1) and the 'v' break
0037 //! points TV(1), TV(2), TV(3) ..., TV(N+1).
0038 class IGESGeom_SplineSurface : public IGESData_IGESEntity
0039 {
0040
0041 public:
0042   Standard_EXPORT IGESGeom_SplineSurface();
0043
0044   //! This method is used to set the fields of the class
0045   //! SplineSurface
0046   //! - aBoundaryType   : Type of Spline boundary
0047   //! 1 = Linear
0048   //! 2 = Quadratic
0049   //! 3 = Cubic
0050   //! 4 = Wilson-Fowler
0051   //! 5 = Modified Wilson-Fowler
0052   //! 6 = B-spline
0053   //! - aPatchType      : Type of patch contained in the grid
0054   //! 1 = Cartesian Product
0055   //! 0 = Unspecified
0056   //! - allUBreakpoints : u values of grid lines
0057   //! - allVBreakpoints : v values of grid lines
0058   //! - allXCoeffs      : X coefficients of M x N patches
0059   //! - allYCoeffs      : Y coefficients of M x N patches
0060   //! - allZCoeffs      : Z coefficients of M x N patches
0061   //! raises exception if allXCoeffs, allYCoeffs & allZCoeffs are not
0062   //! of the same size.
0063   //! or if the size of each element of the double array is not 16
0064   Standard_EXPORT void Init(
0065     const int                                       aBoundaryType,
0066     const int                                       aPatchType,
0067     const occ::handle<NCollection_HArray1<double>>& allUBreakpoints,
0068     const occ::handle<NCollection_HArray1<double>>& allVBreakpoints,
0069     const occ::handle<NCollection_HArray2<occ::handle<NCollection_HArray1<double>>>>& allXCoeffs,
0070     const occ::handle<NCollection_HArray2<occ::handle<NCollection_HArray1<double>>>>& allYCoeffs,
0071     const occ::handle<NCollection_HArray2<occ::handle<NCollection_HArray1<double>>>>& allZCoeffs);
0072
0073   //! returns the number of U segments
0074   Standard_EXPORT int NbUSegments() const;
0075
0076   //! returns the number of V segments
0077   Standard_EXPORT int NbVSegments() const;
0078
0079   //! returns boundary type
0080   Standard_EXPORT int BoundaryType() const;
0081
0082   //! returns patch type
0083   Standard_EXPORT int PatchType() const;
0084
0085   //! returns U break point of the grid line referred to by anIndex
0086   //! raises exception if anIndex <= 0 or anIndex > NbUSegments() + 1
0087   Standard_EXPORT double UBreakPoint(const int anIndex) const;
0088
0089   //! returns V break point of the grid line referred to by anIndex
0090   //! raises exception if anIndex <= 0 or anIndex > NbVSegments() + 1
0091   Standard_EXPORT double VBreakPoint(const int anIndex) const;
0092
0093   //! returns X polynomial of patch referred to by anIndex1, anIndex2
0094   //! raises exception if anIndex1 <= 0 or anIndex1 > NbUSegments()
0095   //! or anIndex2 <= 0 or anIndex2 > NbVSegments()
0096   Standard_EXPORT occ::handle<NCollection_HArray1<double>> XPolynomial(const int anIndex1,
0097                                                                        const int anIndex2) const;
0098
0099   //! returns Y polynomial of patch referred to by anIndex1, anIndex2
0100   //! raises exception if anIndex1 <= 0 or anIndex1 > NbUSegments()
0101   //! or anIndex2 <= 0 or anIndex2 > NbVSegments()
0102   Standard_EXPORT occ::handle<NCollection_HArray1<double>> YPolynomial(const int anIndex1,
0103                                                                        const int anIndex2) const;
0104
0105   //! returns Z polynomial of patch referred to by anIndex1, anIndex2
0106   //! raises exception if anIndex1 <= 0 or anIndex1 > NbUSegments()
0107   //! or anIndex2 <= 0 or anIndex2 > NbVSegments()
0108   Standard_EXPORT occ::handle<NCollection_HArray1<double>> ZPolynomial(const int anIndex1,
0109                                                                        const int anIndex2) const;
0110
0111   //! returns in one all the polynomial values "in bulk"
0112   //! useful for massive treatments
0113   Standard_EXPORT void Polynomials(
0114     occ::handle<NCollection_HArray2<occ::handle<NCollection_HArray1<double>>>>& XCoef,
0115     occ::handle<NCollection_HArray2<occ::handle<NCollection_HArray1<double>>>>& YCoef,
0116     occ::handle<NCollection_HArray2<occ::handle<NCollection_HArray1<double>>>>& ZCoef) const;
0117
0118   DEFINE_STANDARD_RTTIEXT(IGESGeom_SplineSurface, IGESData_IGESEntity)
0119
0120 private:
0121   int                                                                        theBoundaryType;
0122   int                                                                        thePatchType;
0123   occ::handle<NCollection_HArray1<double>>                                   theUBreakPoints;
0124   occ::handle<NCollection_HArray1<double>>                                   theVBreakPoints;
0125   occ::handle<NCollection_HArray2<occ::handle<NCollection_HArray1<double>>>> theXCoeffs;
0126   occ::handle<NCollection_HArray2<occ::handle<NCollection_HArray1<double>>>> theYCoeffs;
0127   occ::handle<NCollection_HArray2<occ::handle<NCollection_HArray1<double>>>> theZCoeffs;
0128 };
0129
0130 #endif // _IGESGeom_SplineSurface_HeaderFile