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