src/IGESGeom/IGESGeom_CurveOnSurface.hxx

   1 // Created on: 1993-01-09
   2 // Created by: CKY / Contract Toubro-Larsen ( Kiran )
   3 // Copyright (c) 1993-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _IGESGeom_CurveOnSurface_HeaderFile
  18 #define _IGESGeom_CurveOnSurface_HeaderFile
  19
  20 #include <Standard.hxx>
  21
  22 #include <Standard_Integer.hxx>
  23 #include <IGESData_IGESEntity.hxx>
  24
  25
  26 class IGESGeom_CurveOnSurface;
  27 DEFINE_STANDARD_HANDLE(IGESGeom_CurveOnSurface, IGESData_IGESEntity)
  28
  29 //! defines IGESCurveOnSurface, Type <142> Form <0>
  30 //! in package IGESGeom
  31 //! A curve on a parametric surface entity associates a given
  32 //! curve with a surface and identifies the curve as lying on
  33 //! the surface.
  34 class IGESGeom_CurveOnSurface : public IGESData_IGESEntity
  35 {
  36
  37 public:
  38
  39
  40   Standard_EXPORT IGESGeom_CurveOnSurface();
  41
  42   //! This method is used to set the fields of the class
  43   //! CurveOnSurface
  44   //! - aMode       : Way the curve on the surface has been created
  45   //! - aSurface    : Surface on which the curve lies
  46   //! - aCurveUV    : Curve S (UV)
  47   //! - aCurve3D    : Curve C (3D)
  48   //! - aPreference : 0 = Unspecified
  49   //! 1 = S o B is preferred
  50   //! 2 = C is preferred
  51   //! 3 = C and S o B are equally preferred
  52   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);
  53
  54   //! returns the mode in which the curve is created on the surface
  55   //! 0 = Unspecified
  56   //! 1 = Projection of a given curve on the surface
  57   //! 2 = Intersection of two surfaces
  58   //! 3 = Isoparametric curve, i.e:- either a `u` parametric
  59   //! or a `v` parametric curve
  60   Standard_EXPORT Standard_Integer CreationMode() const;
  61
  62   //! returns the surface on which the curve lies
  63   Standard_EXPORT Handle(IGESData_IGESEntity) Surface() const;
  64
  65   //! returns curve S
  66   Standard_EXPORT Handle(IGESData_IGESEntity) CurveUV() const;
  67
  68   //! returns curve C
  69   Standard_EXPORT Handle(IGESData_IGESEntity) Curve3D() const;
  70
  71   //! returns preference mode
  72   //! 0 = Unspecified
  73   //! 1 = S o B is preferred
  74   //! 2 = C is preferred
  75   //! 3 = C and S o B are equally preferred
  76   Standard_EXPORT Standard_Integer PreferenceMode() const;
  77
  78
  79
  80
  81   DEFINE_STANDARD_RTTIEXT(IGESGeom_CurveOnSurface,IGESData_IGESEntity)
  82
  83 protected:
  84
  85
  86
  87
  88 private:
  89
  90
  91   Standard_Integer theCreationMode;
  92   Handle(IGESData_IGESEntity) theSurface;
  93   Handle(IGESData_IGESEntity) theCurveUV;
  94   Handle(IGESData_IGESEntity) theCurve3D;
  95   Standard_Integer thePreferenceMode;
  96
  97
  98 };
  99
 100
 101
 102
 103
 104
 105
 106 #endif // _IGESGeom_CurveOnSurface_HeaderFile