include/opencascade/IGESSolid_Shell.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( SIVA )
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 _IGESSolid_Shell_HeaderFile
0018 #define _IGESSolid_Shell_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <IGESSolid_Face.hxx>
0023 #include <NCollection_Array1.hxx>
0024 #include <NCollection_HArray1.hxx>
0025 #include <Standard_Integer.hxx>
0026 #include <IGESData_IGESEntity.hxx>
0027 class IGESSolid_Face;
0028
0029 //! defines Shell, Type <514> Form Number <1>
0030 //! in package IGESSolid
0031 //! Shell entity is a connected entity of dimensionality 2
0032 //! which divides R3 into two arcwise connected open subsets,
0033 //! one of which is finite. Inside of the shell is defined to
0034 //! be the finite region.
0035 //! From IGES-5.3, Form can be <1> for Closed or <2> for Open
0036 class IGESSolid_Shell : public IGESData_IGESEntity
0037 {
0038
0039 public:
0040   Standard_EXPORT IGESSolid_Shell();
0041
0042   //! This method is used to set the fields of the class Shell
0043   //! - allFaces  : the faces comprising the shell
0044   //! - allOrient : the orientation flags of the shell
0045   //! raises exception if length of allFaces & allOrient do not match
0046   Standard_EXPORT void Init(
0047     const occ::handle<NCollection_HArray1<occ::handle<IGESSolid_Face>>>& allFaces,
0048     const occ::handle<NCollection_HArray1<int>>&                         allOrient);
0049
0050   //! Tells if a Shell is Closed, i.e. if its FormNumber is 1
0051   //! (this is the default)
0052   Standard_EXPORT bool IsClosed() const;
0053
0054   //! Sets or Unsets the Closed status (FormNumber = 1 else 2)
0055   Standard_EXPORT void SetClosed(const bool closed);
0056
0057   //! returns the number of the face entities in the shell
0058   Standard_EXPORT int NbFaces() const;
0059
0060   //! returns the Index'th face entity of the shell
0061   //! raises exception if Index <= 0 or Index > NbFaces()
0062   Standard_EXPORT occ::handle<IGESSolid_Face> Face(const int Index) const;
0063
0064   //! returns the orientation of Index'th face w.r.t the direction of
0065   //! the underlying surface
0066   //! raises exception if Index <= 0 or Index > NbFaces()
0067   Standard_EXPORT bool Orientation(const int Index) const;
0068
0069   DEFINE_STANDARD_RTTIEXT(IGESSolid_Shell, IGESData_IGESEntity)
0070
0071 private:
0072   occ::handle<NCollection_HArray1<occ::handle<IGESSolid_Face>>> theFaces;
0073   occ::handle<NCollection_HArray1<int>>                         theOrientation;
0074 };
0075
0076 #endif // _IGESSolid_Shell_HeaderFile