src/IGESGeom/IGESGeom_TrimmedSurface.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_TrimmedSurface_HeaderFile
  18 #define _IGESGeom_TrimmedSurface_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Integer.hxx>
  24 #include <IGESGeom_HArray1OfCurveOnSurface.hxx>
  25 #include <IGESData_IGESEntity.hxx>
  26 #include <Standard_Boolean.hxx>
  27 class IGESGeom_CurveOnSurface;
  28
  29
  30 class IGESGeom_TrimmedSurface;
  31 DEFINE_STANDARD_HANDLE(IGESGeom_TrimmedSurface, IGESData_IGESEntity)
  32
  33 //! defines IGESTrimmedSurface, Type <144> Form <0>
  34 //! in package IGESGeom
  35 //! A simple closed curve  in Euclidean plane  divides the
  36 //! plane in to two disjoint, open connected components; one
  37 //! bounded, one unbounded. The bounded one is called the
  38 //! interior region to the curve. Unbounded component is called
  39 //! exterior region to the curve. The domain of the trimmed
  40 //! surface is defined as the interior of the outer boundaries
  41 //! and exterior of the inner boundaries and includes the
  42 //! boundary curves.
  43 class IGESGeom_TrimmedSurface : public IGESData_IGESEntity
  44 {
  45
  46 public:
  47
  48
  49   Standard_EXPORT IGESGeom_TrimmedSurface();
  50
  51   //! This method is used to set the fields of the class
  52   //! TrimmedSurface
  53   //! - aSurface  : Surface to be trimmed
  54   //! - aFlag     : Outer boundary type
  55   //! False = The outer boundary is the boundary of
  56   //! rectangle D which is the domain of the
  57   //! surface to be trimmed
  58   //! True  = otherwise
  59   //! - anOuter   : Closed curve which constitutes outer boundary
  60   //! - allInners : Array of closed curves which constitute the
  61   //! inner boundary
  62   Standard_EXPORT void Init (const Handle(IGESData_IGESEntity)& aSurface, const Standard_Integer aFlag, const Handle(IGESGeom_CurveOnSurface)& anOuter, const Handle(IGESGeom_HArray1OfCurveOnSurface)& allInners);
  63
  64   //! returns the surface to be trimmed
  65   Standard_EXPORT Handle(IGESData_IGESEntity) Surface() const;
  66
  67   //! returns True if outer contour exists
  68   Standard_EXPORT Standard_Boolean HasOuterContour() const;
  69
  70   //! returns the outer contour of the trimmed surface
  71   Standard_EXPORT Handle(IGESGeom_CurveOnSurface) OuterContour() const;
  72
  73   //! returns the outer contour type of the trimmed surface
  74   //! 0  : The outer boundary is the boundary of D
  75   //! 1  : otherwise
  76   Standard_EXPORT Standard_Integer OuterBoundaryType() const;
  77
  78   //! returns the number of inner boundaries
  79   Standard_EXPORT Standard_Integer NbInnerContours() const;
  80
  81   //! returns the Index'th inner contour
  82   //! raises exception if Index <= 0 or Index > NbInnerContours()
  83   Standard_EXPORT Handle(IGESGeom_CurveOnSurface) InnerContour (const Standard_Integer Index) const;
  84
  85
  86
  87
  88   DEFINE_STANDARD_RTTIEXT(IGESGeom_TrimmedSurface,IGESData_IGESEntity)
  89
  90 protected:
  91
  92
  93
  94
  95 private:
  96
  97
  98   Handle(IGESData_IGESEntity) theSurface;
  99   Standard_Integer theFlag;
 100   Handle(IGESGeom_CurveOnSurface) theOuterCurve;
 101   Handle(IGESGeom_HArray1OfCurveOnSurface) theInnerCurves;
 102
 103
 104 };
 105
 106
 107
 108
 109
 110
 111
 112 #endif // _IGESGeom_TrimmedSurface_HeaderFile