include/opencascade/IGESDimen_Section.hxx

0001 // Created on: 1993-01-13
0002 // Created by: CKY / Contract Toubro-Larsen ( Deepak PRABHU )
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 _IGESDimen_Section_HeaderFile
0018 #define _IGESDimen_Section_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <gp_XY.hxx>
0025 #include <NCollection_Array1.hxx>
0026 #include <NCollection_HArray1.hxx>
0027 #include <IGESData_IGESEntity.hxx>
0028 class gp_Pnt;
0029
0030 //! defines Section, Type <106> Form <31-38>
0031 //! in package IGESDimen
0032 //! Contains information to display sectioned sides
0033 class IGESDimen_Section : public IGESData_IGESEntity
0034 {
0035
0036 public:
0037   Standard_EXPORT IGESDimen_Section();
0038
0039   //! This method is used to set the fields of the class
0040   //! Section
0041   //! - dataType   : Interpretation Flag, always = 1
0042   //! - aDisp      : Common z displacement
0043   //! - dataPoints : Data points
0044   Standard_EXPORT void Init(const int                                      dataType,
0045                             const double                                   aDisp,
0046                             const occ::handle<NCollection_HArray1<gp_XY>>& dataPoints);
0047
0048   //! Changes FormNumber (indicates the Type of the Hatches)
0049   //! Error if not in range [31-38]
0050   Standard_EXPORT void SetFormNumber(const int form);
0051
0052   //! returns Interpretation Flag, always = 1
0053   Standard_EXPORT int Datatype() const;
0054
0055   //! returns number of Data Points
0056   Standard_EXPORT int NbPoints() const;
0057
0058   //! returns common Z displacement
0059   Standard_EXPORT double ZDisplacement() const;
0060
0061   //! returns Index'th data point
0062   //! raises exception if Index <= 0 or Index > NbPoints()
0063   Standard_EXPORT gp_Pnt Point(const int Index) const;
0064
0065   //! returns Index'th data point after Transformation
0066   //! raises exception if Index <= 0 or Index > NbPoints()
0067   Standard_EXPORT gp_Pnt TransformedPoint(const int Index) const;
0068
0069   DEFINE_STANDARD_RTTIEXT(IGESDimen_Section, IGESData_IGESEntity)
0070
0071 private:
0072   int                                     theDatatype;
0073   double                                  theZDisplacement;
0074   occ::handle<NCollection_HArray1<gp_XY>> theDataPoints;
0075 };
0076
0077 #endif // _IGESDimen_Section_HeaderFile