include/opencascade/IGESDraw_Drawing.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_Drawing_HeaderFile
0018 #define _IGESDraw_Drawing_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IGESData_ViewKindEntity.hxx>
0024 #include <NCollection_Array1.hxx>
0025 #include <NCollection_HArray1.hxx>
0026 #include <gp_XY.hxx>
0027 #include <IGESData_IGESEntity.hxx>
0028 #include <Standard_Integer.hxx>
0029 class IGESData_ViewKindEntity;
0030 class gp_Pnt2d;
0031 class gp_XY;
0032 class gp_XYZ;
0033
0034 //! defines IGESDrawing, Type <404> Form <0>
0035 //! in package IGESDraw
0036 //!
0037 //! Specifies a drawing as a collection of annotation entities
0038 //! defined in drawing space, and views which together
0039 //! constitute a single representation of a part
0040 class IGESDraw_Drawing : public IGESData_IGESEntity
0041 {
0042
0043 public:
0044   Standard_EXPORT IGESDraw_Drawing();
0045
0046   //! This method is used to set the fields of the class
0047   //! Drawing
0048   //! - allViews       : Pointers to DEs of View entities
0049   //! - allViewOrigins : Origin coordinates of transformed Views
0050   //! - allAnnotations : Pointers to DEs of Annotation entities
0051   //! raises exception if Lengths of allViews and allViewOrigins are
0052   //! not same.
0053   Standard_EXPORT void Init(
0054     const occ::handle<NCollection_HArray1<occ::handle<IGESData_ViewKindEntity>>>& allViews,
0055     const occ::handle<NCollection_HArray1<gp_XY>>&                                allViewOrigins,
0056     const occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>&     allAnnotations);
0057
0058   //! returns the number of view pointers in <me>
0059   Standard_EXPORT int NbViews() const;
0060
0061   //! returns the ViewKindEntity indicated by ViewIndex
0062   //! raises an exception if ViewIndex <= 0 or ViewIndex > NbViews().
0063   Standard_EXPORT occ::handle<IGESData_ViewKindEntity> ViewItem(const int ViewIndex) const;
0064
0065   //! returns the Drawing space coordinates of the origin of the
0066   //! Transformed view indicated by TViewIndex
0067   //! raises an exception if TViewIndex <= 0 or TViewIndex > NbViews().
0068   Standard_EXPORT gp_Pnt2d ViewOrigin(const int TViewIndex) const;
0069
0070   //! returns the number of Annotation entities in <me>
0071   Standard_EXPORT int NbAnnotations() const;
0072
0073   //! returns the Annotation entity in this Drawing, indicated by the
0074   //! AnnotationIndex
0075   //! raises an exception if AnnotationIndex <= 0 or
0076   //! AnnotationIndex > NbAnnotations().
0077   Standard_EXPORT occ::handle<IGESData_IGESEntity> Annotation(const int AnnotationIndex) const;
0078
0079   Standard_EXPORT gp_XY ViewToDrawing(const int NumView, const gp_XYZ& ViewCoords) const;
0080
0081   //! Returns the Drawing Unit Value if it is specified (by a
0082   //! specific property entity)
0083   //! If not specified, returns False, and val as zero :
0084   //! unit to consider is then the model unit in GlobalSection
0085   Standard_EXPORT bool DrawingUnit(double& value) const;
0086
0087   //! Returns the Drawing Size if it is specified (by a
0088   //! specific property entity)
0089   //! If not specified, returns False, and X,Y as zero :
0090   //! unit to consider is then the model unit in GlobalSection
0091   Standard_EXPORT bool DrawingSize(double& X, double& Y) const;
0092
0093   DEFINE_STANDARD_RTTIEXT(IGESDraw_Drawing, IGESData_IGESEntity)
0094
0095 private:
0096   occ::handle<NCollection_HArray1<occ::handle<IGESData_ViewKindEntity>>> theViews;
0097   occ::handle<NCollection_HArray1<gp_XY>>                                theViewOrigins;
0098   occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>     theAnnotations;
0099 };
0100
0101 #endif // _IGESDraw_Drawing_HeaderFile