include/opencascade/IGESDraw_Planar.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( TCD )
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 _IGESDraw_Planar_HeaderFile
0018 #define _IGESDraw_Planar_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <IGESData_IGESEntity.hxx>
0024 #include <NCollection_Array1.hxx>
0025 #include <NCollection_HArray1.hxx>
0026 class IGESGeom_TransformationMatrix;
0027
0028 //! defines IGESPlanar, Type <402> Form <16>
0029 //! in package IGESDraw
0030 //!
0031 //! Indicates that a collection of entities is coplanar.The
0032 //! entities may be geometric, annotative, and/or structural.
0033 class IGESDraw_Planar : public IGESData_IGESEntity
0034 {
0035
0036 public:
0037   Standard_EXPORT IGESDraw_Planar();
0038
0039   //! This method is used to set the fields of the class Planar
0040   //! - nbMats                : Number of Transformation matrices
0041   //! - aTransformationMatrix : Pointer to the Transformation matrix
0042   //! - allEntities           : Pointers to the entities specified
0043   Standard_EXPORT void Init(
0044     const int                                                                 nbMats,
0045     const occ::handle<IGESGeom_TransformationMatrix>&                         aTransformationMatrix,
0046     const occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>& allEntities);
0047
0048   //! returns the number of Transformation matrices in <me>
0049   Standard_EXPORT int NbMatrices() const;
0050
0051   //! returns the number of Entities in the plane pointed to by this
0052   //! associativity
0053   Standard_EXPORT int NbEntities() const;
0054
0055   //! returns True if TransformationMatrix is Identity Matrix,
0056   //! i.e:- No Matrix defined.
0057   Standard_EXPORT bool IsIdentityMatrix() const;
0058
0059   //! returns the Transformation matrix moving data from the XY plane
0060   //! into space or zero
0061   Standard_EXPORT occ::handle<IGESGeom_TransformationMatrix> TransformMatrix() const;
0062
0063   //! returns the Entity on the specified plane, indicated by EntityIndex
0064   //! raises an exception if EntityIndex <= 0 or
0065   //! EntityIndex > NbEntities()
0066   Standard_EXPORT occ::handle<IGESData_IGESEntity> Entity(const int EntityIndex) const;
0067
0068   DEFINE_STANDARD_RTTIEXT(IGESDraw_Planar, IGESData_IGESEntity)
0069
0070 private:
0071   int                                                                theNbMatrices;
0072   occ::handle<IGESGeom_TransformationMatrix>                         theTransformationMatrix;
0073   occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>> theEntities;
0074 };
0075
0076 #endif // _IGESDraw_Planar_HeaderFile