include/opencascade/IGESSolid_SolidAssembly.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_SolidAssembly_HeaderFile
0018 #define _IGESSolid_SolidAssembly_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <IGESData_IGESEntity.hxx>
0023 #include <NCollection_Array1.hxx>
0024 #include <NCollection_HArray1.hxx>
0025 #include <IGESGeom_TransformationMatrix.hxx>
0026 #include <Standard_Integer.hxx>
0027 class IGESGeom_TransformationMatrix;
0028
0029 //! defines SolidAssembly, Type <184> Form <0>
0030 //! in package IGESSolid
0031 //! Solid assembly is a collection of items which possess a
0032 //! shared fixed geometric relationship.
0033 //!
0034 //! From IGES-5.3, From 1 says that at least one item is a Brep
0035 //! else all are Primitives, Boolean Trees, Solid Instances or
0036 //! other Assemblies
0037 class IGESSolid_SolidAssembly : public IGESData_IGESEntity
0038 {
0039
0040 public:
0041   Standard_EXPORT IGESSolid_SolidAssembly();
0042
0043   //! This method is used to set the fields of the class
0044   //! SolidAssembly
0045   //! - allItems    : the collection of items
0046   //! - allMatrices : transformation matrices corresponding to each
0047   //! item
0048   //! raises exception if the length of allItems & allMatrices
0049   //! do not match
0050   Standard_EXPORT void Init(
0051     const occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>& allItems,
0052     const occ::handle<NCollection_HArray1<occ::handle<IGESGeom_TransformationMatrix>>>&
0053       allMatrices);
0054
0055   //! Tells if at least one item is a Brep, from FormNumber
0056   Standard_EXPORT bool HasBrep() const;
0057
0058   //! Sets or Unsets the status "HasBrep" from FormNumber
0059   //! Default is False
0060   Standard_EXPORT void SetBrep(const bool hasbrep);
0061
0062   //! returns the number of items in the collection
0063   Standard_EXPORT int NbItems() const;
0064
0065   //! returns the Index'th item
0066   //! raises exception if Index <= 0 or Index > NbItems()
0067   Standard_EXPORT occ::handle<IGESData_IGESEntity> Item(const int Index) const;
0068
0069   //! returns the transformation matrix of the Index'th item
0070   //! raises exception if Index <= 0 or Index > NbItems()
0071   Standard_EXPORT occ::handle<IGESGeom_TransformationMatrix> TransfMatrix(const int Index) const;
0072
0073   DEFINE_STANDARD_RTTIEXT(IGESSolid_SolidAssembly, IGESData_IGESEntity)
0074
0075 private:
0076   occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>           theItems;
0077   occ::handle<NCollection_HArray1<occ::handle<IGESGeom_TransformationMatrix>>> theMatrices;
0078 };
0079
0080 #endif // _IGESSolid_SolidAssembly_HeaderFile