include/opencascade/IGESSolid_Face.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_Face_HeaderFile
0018 #define _IGESSolid_Face_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <IGESSolid_Loop.hxx>
0023 #include <NCollection_Array1.hxx>
0024 #include <NCollection_HArray1.hxx>
0025 #include <IGESData_IGESEntity.hxx>
0026 #include <Standard_Integer.hxx>
0027 class IGESSolid_Loop;
0028
0029 //! defines Face, Type <510> Form Number <1>
0030 //! in package IGESSolid
0031 //! Face entity is a bound (partial) which has finite area
0032 class IGESSolid_Face : public IGESData_IGESEntity
0033 {
0034
0035 public:
0036   Standard_EXPORT IGESSolid_Face();
0037
0038   //! This method is used to set the fields of the class Face
0039   //! - aSurface      : Pointer to the underlying surface
0040   //! - outerLoopFlag : True means the first loop is the outer loop
0041   //! - loops         : Array of loops bounding the face
0042   Standard_EXPORT void Init(
0043     const occ::handle<IGESData_IGESEntity>&                              aSurface,
0044     const bool                                                           outerLoopFlag,
0045     const occ::handle<NCollection_HArray1<occ::handle<IGESSolid_Loop>>>& loops);
0046
0047   //! returns the underlying surface of the face
0048   Standard_EXPORT occ::handle<IGESData_IGESEntity> Surface() const;
0049
0050   //! returns the number of the loops bounding the face
0051   Standard_EXPORT int NbLoops() const;
0052
0053   //! checks whether there is an outer loop or not
0054   Standard_EXPORT bool HasOuterLoop() const;
0055
0056   //! returns the Index'th loop that bounds the face
0057   //! raises exception if Index < 0 or Index >= NbLoops
0058   Standard_EXPORT occ::handle<IGESSolid_Loop> Loop(const int Index) const;
0059
0060   DEFINE_STANDARD_RTTIEXT(IGESSolid_Face, IGESData_IGESEntity)
0061
0062 private:
0063   occ::handle<IGESData_IGESEntity>                              theSurface;
0064   bool                                                          hasOuterLoop;
0065   occ::handle<NCollection_HArray1<occ::handle<IGESSolid_Loop>>> theLoops;
0066 };
0067
0068 #endif // _IGESSolid_Face_HeaderFile