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 <TColgp_HArray1OfXY.hxx>
0025 #include <IGESData_IGESEntity.hxx>
0026 class gp_Pnt;
0027
0028 class IGESDimen_CenterLine;
0029 DEFINE_STANDARD_HANDLE(IGESDimen_CenterLine, IGESData_IGESEntity)
0030
0031 //! defines CenterLine, Type <106> Form <20-21>
0032 //! in package IGESDimen
0033 //! Is an entity appearing as crosshairs or as a
0034 //! construction between 2 positions
0035 class IGESDimen_CenterLine : public IGESData_IGESEntity
0036 {
0037
0038 public:
0039   Standard_EXPORT IGESDimen_CenterLine();
0040
0041   //! This method is used to set the fields of the class
0042   //! CenterLine
0043   //! - aDataType      : Interpretation Flag, always = 1
0044   //! - aZDisplacement : Common z displacement
0045   //! - dataPnts       : Data points (x and y)
0046   Standard_EXPORT void Init(const Standard_Integer            aDataType,
0047                             const Standard_Real               aZdisp,
0048                             const Handle(TColgp_HArray1OfXY)& dataPnts);
0049
0050   //! Sets FormNumber to 20 if <mode> is True, 21 else
0051   Standard_EXPORT void SetCrossHair(const Standard_Boolean mode);
0052
0053   //! returns Interpretation Flag : IP = 1.
0054   Standard_EXPORT Standard_Integer Datatype() const;
0055
0056   //! returns Number of Data Points.
0057   Standard_EXPORT Standard_Integer NbPoints() const;
0058
0059   //! returns Common Z displacement.
0060   Standard_EXPORT Standard_Real ZDisplacement() const;
0061
0062   //! returns the data point as Pnt from gp.
0063   //! raises exception if Index <= 0 or Index > NbPoints()
0064   Standard_EXPORT gp_Pnt Point(const Standard_Integer Index) const;
0065
0066   //! returns the data point as Pnt from gp after Transformation.
0067   //! raises exception if Index <= 0 or Index > NbPoints()
0068   Standard_EXPORT gp_Pnt TransformedPoint(const Standard_Integer Index) const;
0069
0070   //! returns True if Form is 20.
0071   Standard_EXPORT Standard_Boolean IsCrossHair() const;
0072
0073   DEFINE_STANDARD_RTTIEXT(IGESDimen_CenterLine, IGESData_IGESEntity)
0074
0075 protected:
0076 private:
0077   Standard_Integer           theDatatype;
0078   Standard_Real              theZDisplacement;
0079   Handle(TColgp_HArray1OfXY) theDataPoints;
0080 };
0081
0082 #endif // _IGESDimen_CenterLine_HeaderFile