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