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