include/opencascade/IGESGeom_RuledSurface.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_RuledSurface_HeaderFile
0018 #define _IGESGeom_RuledSurface_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <IGESData_IGESEntity.hxx>
0024
0025 //! defines IGESRuledSurface, Type <118> Form <0-1>
0026 //! in package IGESGeom
0027 //! A ruled surface is formed by moving a line connecting points
0028 //! of equal relative arc length or equal relative parametric
0029 //! value on two parametric curves from a start point to a
0030 //! terminate point on the curves. The parametric curves may be
0031 //! points, lines, circles, conics, rational B-splines,
0032 //! parametric splines or any parametric curve defined in
0033 //! the IGES specification.
0034 class IGESGeom_RuledSurface : public IGESData_IGESEntity
0035 {
0036
0037 public:
0038   Standard_EXPORT IGESGeom_RuledSurface();
0039
0040   //! This method is used to set the fields of the class
0041   //! RuledSurface
0042   //! - aCurve       : First parametric curve
0043   //! - anotherCurve : Second parametric curve
0044   //! - aDirFlag     : Direction Flag
0045   //! 0 = Join first to first, last to last
0046   //! 1 = Join first to last, last to first
0047   //! - aDevFlag     : Developable Surface Flag
0048   //! 1 = Developable
0049   //! 0 = Possibly not
0050   Standard_EXPORT void Init(const occ::handle<IGESData_IGESEntity>& aCurve,
0051                             const occ::handle<IGESData_IGESEntity>& anotherCurve,
0052                             const int                               aDirFlag,
0053                             const int                               aDevFlag);
0054
0055   //! Sets <me> to be Ruled by Parameter (Form 1) if <mode> is
0056   //! True, or Ruled by Length (Form 0) else
0057   Standard_EXPORT void SetRuledByParameter(const bool mode);
0058
0059   //! Returns True if Form is 1
0060   Standard_EXPORT bool IsRuledByParameter() const;
0061
0062   //! returns the first curve
0063   Standard_EXPORT occ::handle<IGESData_IGESEntity> FirstCurve() const;
0064
0065   //! returns the second curve
0066   Standard_EXPORT occ::handle<IGESData_IGESEntity> SecondCurve() const;
0067
0068   //! return the sense of direction
0069   //! 0 = Join first to first, last to last
0070   //! 1 = Join first to last, last to first
0071   Standard_EXPORT int DirectionFlag() const;
0072
0073   //! returns True if developable else False
0074   Standard_EXPORT bool IsDevelopable() const;
0075
0076   DEFINE_STANDARD_RTTIEXT(IGESGeom_RuledSurface, IGESData_IGESEntity)
0077
0078 private:
0079   occ::handle<IGESData_IGESEntity> theCurve1;
0080   occ::handle<IGESData_IGESEntity> theCurve2;
0081   int                              theDirFlag;
0082   int                              theDevFlag;
0083 };
0084
0085 #endif // _IGESGeom_RuledSurface_HeaderFile