include/opencascade/IGESDimen_CenterLine.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_CenterLine_HeaderFile
0018 #define _IGESDimen_CenterLine_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 CenterLine, Type <106> Form <20-21>
0031 //! in package IGESDimen
0032 //! Is an entity appearing as crosshairs or as a
0033 //! construction between 2 positions
0034 class IGESDimen_CenterLine : public IGESData_IGESEntity
0035 {
0036
0037 public:
0038   Standard_EXPORT IGESDimen_CenterLine();
0039
0040   //! This method is used to set the fields of the class
0041   //! CenterLine
0042   //! - aDataType      : Interpretation Flag, always = 1
0043   //! - aZDisplacement : Common z displacement
0044   //! - dataPnts       : Data points (x and y)
0045   Standard_EXPORT void Init(const int                                      aDataType,
0046                             const double                                   aZdisp,
0047                             const occ::handle<NCollection_HArray1<gp_XY>>& dataPnts);
0048
0049   //! Sets FormNumber to 20 if <mode> is True, 21 else
0050   Standard_EXPORT void SetCrossHair(const bool mode);
0051
0052   //! returns Interpretation Flag : IP = 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 the data point as Pnt from gp.
0062   //! raises exception if Index <= 0 or Index > NbPoints()
0063   Standard_EXPORT gp_Pnt Point(const int Index) const;
0064
0065   //! returns the data point as Pnt from gp after Transformation.
0066   //! raises exception if Index <= 0 or Index > NbPoints()
0067   Standard_EXPORT gp_Pnt TransformedPoint(const int Index) const;
0068
0069   //! returns True if Form is 20.
0070   Standard_EXPORT bool IsCrossHair() const;
0071
0072   DEFINE_STANDARD_RTTIEXT(IGESDimen_CenterLine, IGESData_IGESEntity)
0073
0074 private:
0075   int                                     theDatatype;
0076   double                                  theZDisplacement;
0077   occ::handle<NCollection_HArray1<gp_XY>> theDataPoints;
0078 };
0079
0080 #endif // _IGESDimen_CenterLine_HeaderFile