include/opencascade/IGESGeom_CurveOnSurface.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_CurveOnSurface_HeaderFile
0018 #define _IGESGeom_CurveOnSurface_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <IGESData_IGESEntity.hxx>
0024
0025 //! defines IGESCurveOnSurface, Type <142> Form <0>
0026 //! in package IGESGeom
0027 //! A curve on a parametric surface entity associates a given
0028 //! curve with a surface and identifies the curve as lying on
0029 //! the surface.
0030 class IGESGeom_CurveOnSurface : public IGESData_IGESEntity
0031 {
0032
0033 public:
0034   Standard_EXPORT IGESGeom_CurveOnSurface();
0035
0036   //! This method is used to set the fields of the class
0037   //! CurveOnSurface
0038   //! - aMode       : Way the curve on the surface has been created
0039   //! - aSurface    : Surface on which the curve lies
0040   //! - aCurveUV    : Curve S (UV)
0041   //! - aCurve3D    : Curve C (3D)
0042   //! - aPreference : 0 = Unspecified
0043   //! 1 = S o B is preferred
0044   //! 2 = C is preferred
0045   //! 3 = C and S o B are equally preferred
0046   Standard_EXPORT void Init(const int                               aMode,
0047                             const occ::handle<IGESData_IGESEntity>& aSurface,
0048                             const occ::handle<IGESData_IGESEntity>& aCurveUV,
0049                             const occ::handle<IGESData_IGESEntity>& aCurve3D,
0050                             const int                               aPreference);
0051
0052   //! returns the mode in which the curve is created on the surface
0053   //! 0 = Unspecified
0054   //! 1 = Projection of a given curve on the surface
0055   //! 2 = Intersection of two surfaces
0056   //! 3 = Isoparametric curve, i.e:- either a `u` parametric
0057   //! or a `v` parametric curve
0058   Standard_EXPORT int CreationMode() const;
0059
0060   //! returns the surface on which the curve lies
0061   Standard_EXPORT occ::handle<IGESData_IGESEntity> Surface() const;
0062
0063   //! returns curve S
0064   Standard_EXPORT occ::handle<IGESData_IGESEntity> CurveUV() const;
0065
0066   //! returns curve C
0067   Standard_EXPORT occ::handle<IGESData_IGESEntity> Curve3D() const;
0068
0069   //! returns preference mode
0070   //! 0 = Unspecified
0071   //! 1 = S o B is preferred
0072   //! 2 = C is preferred
0073   //! 3 = C and S o B are equally preferred
0074   Standard_EXPORT int PreferenceMode() const;
0075
0076   DEFINE_STANDARD_RTTIEXT(IGESGeom_CurveOnSurface, IGESData_IGESEntity)
0077
0078 private:
0079   int                              theCreationMode;
0080   occ::handle<IGESData_IGESEntity> theSurface;
0081   occ::handle<IGESData_IGESEntity> theCurveUV;
0082   occ::handle<IGESData_IGESEntity> theCurve3D;
0083   int                              thePreferenceMode;
0084 };
0085
0086 #endif // _IGESGeom_CurveOnSurface_HeaderFile