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