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_HArray1OfIGESEntity.hxx>
0024 #include <IGESData_IGESEntity.hxx>
0025 class IGESGeom_TransformationMatrix;
0026
0027
0028 class IGESDraw_Planar;
0029 DEFINE_STANDARD_HANDLE(IGESDraw_Planar, IGESData_IGESEntity)
0030
0031 //! defines IGESPlanar, Type <402> Form <16>
0032 //! in package IGESDraw
0033 //!
0034 //! Indicates that a collection of entities is coplanar.The
0035 //! entities may be geometric, annotative, and/or structural.
0036 class IGESDraw_Planar : public IGESData_IGESEntity
0037 {
0038
0039 public:
0040
0041
0042   Standard_EXPORT IGESDraw_Planar();
0043
0044   //! This method is used to set the fields of the class Planar
0045   //! - nbMats                : Number of Transformation matrices
0046   //! - aTransformationMatrix : Pointer to the Transformation matrix
0047   //! - allEntities           : Pointers to the entities specified
0048   Standard_EXPORT void Init (const Standard_Integer nbMats, const Handle(IGESGeom_TransformationMatrix)& aTransformationMatrix, const Handle(IGESData_HArray1OfIGESEntity)& allEntities);
0049
0050   //! returns the number of Transformation matrices in <me>
0051   Standard_EXPORT Standard_Integer NbMatrices() const;
0052
0053   //! returns the number of Entities in the plane pointed to by this
0054   //! associativity
0055   Standard_EXPORT Standard_Integer NbEntities() const;
0056
0057   //! returns True if TransformationMatrix is Identity Matrix,
0058   //! i.e:- No Matrix defined.
0059   Standard_EXPORT Standard_Boolean IsIdentityMatrix() const;
0060
0061   //! returns the Transformation matrix moving data from the XY plane
0062   //! into space or zero
0063   Standard_EXPORT Handle(IGESGeom_TransformationMatrix) TransformMatrix() const;
0064
0065   //! returns the Entity on the specified plane, indicated by EntityIndex
0066   //! raises an exception if EntityIndex <= 0 or
0067   //! EntityIndex > NbEntities()
0068   Standard_EXPORT Handle(IGESData_IGESEntity) Entity (const Standard_Integer EntityIndex) const;
0069
0070
0071
0072
0073   DEFINE_STANDARD_RTTIEXT(IGESDraw_Planar,IGESData_IGESEntity)
0074
0075 protected:
0076
0077
0078
0079
0080 private:
0081
0082
0083   Standard_Integer theNbMatrices;
0084   Handle(IGESGeom_TransformationMatrix) theTransformationMatrix;
0085   Handle(IGESData_HArray1OfIGESEntity) theEntities;
0086
0087
0088 };
0089
0090
0091
0092
0093
0094
0095
0096 #endif // _IGESDraw_Planar_HeaderFile