include/opencascade/IGESGeom_Line.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_Line_HeaderFile
0018 #define _IGESGeom_Line_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <gp_XYZ.hxx>
0024 #include <IGESData_IGESEntity.hxx>
0025 #include <Standard_Integer.hxx>
0026 class gp_Pnt;
0027
0028 class IGESGeom_Line;
0029 DEFINE_STANDARD_HANDLE(IGESGeom_Line, IGESData_IGESEntity)
0030
0031 //! defines IGESLine, Type <110> Form <0>
0032 //! in package IGESGeom
0033 //! A line is a bounded, connected portion of a parent straight
0034 //! line which consists of more than one point. A line is
0035 //! defined by its end points.
0036 //!
0037 //! From IGES-5.3, two other Forms are admitted (same params) :
0038 //! 0 remains for standard limited line (the default)
0039 //! 1 for semi-infinite line (End is just a passing point)
0040 //! 2 for full infinite Line (both Start and End are arbitrary)
0041 class IGESGeom_Line : public IGESData_IGESEntity
0042 {
0043
0044 public:
0045   Standard_EXPORT IGESGeom_Line();
0046
0047   //! This method is used to set the fields of the class Line
0048   //! - aStart : Start point of the line
0049   //! - anEnd  : End point of the line
0050   Standard_EXPORT void Init(const gp_XYZ& aStart, const gp_XYZ& anEnd);
0051
0052   //! Returns the Infinite status i.e. the Form Number : 0 1 2
0053   Standard_EXPORT Standard_Integer Infinite() const;
0054
0055   //! Sets the Infinite status
0056   //! Does nothing if <status> is not 0 1 or 2
0057   Standard_EXPORT void SetInfinite(const Standard_Integer status);
0058
0059   //! returns the start point of the line
0060   Standard_EXPORT gp_Pnt StartPoint() const;
0061
0062   //! returns the start point of the line after applying Transf. Matrix
0063   Standard_EXPORT gp_Pnt TransformedStartPoint() const;
0064
0065   //! returns the end point of the line
0066   Standard_EXPORT gp_Pnt EndPoint() const;
0067
0068   //! returns the end point of the line after applying Transf. Matrix
0069   Standard_EXPORT gp_Pnt TransformedEndPoint() const;
0070
0071   DEFINE_STANDARD_RTTIEXT(IGESGeom_Line, IGESData_IGESEntity)
0072
0073 protected:
0074 private:
0075   gp_XYZ theStart;
0076   gp_XYZ theEnd;
0077 };
0078
0079 #endif // _IGESGeom_Line_HeaderFile