include/opencascade/IGESDraw_DrawingWithRotation.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_DrawingWithRotation_HeaderFile
0018 #define _IGESDraw_DrawingWithRotation_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 IGESDrawingWithRotation, Type <404> Form <1>
0035 //! in package IGESDraw
0036 //!
0037 //! Permits rotation, in addition to transformation and
0038 //! scaling, between the view and drawing coordinate systems
0039 class IGESDraw_DrawingWithRotation : public IGESData_IGESEntity
0040 {
0041
0042 public:
0043   Standard_EXPORT IGESDraw_DrawingWithRotation();
0044
0045   //! This method is used to set the fields of the class
0046   //! DrawingWithRotation
0047   //! - allViews             : Pointers to View entities
0048   //! - allViewOrigins       : Origin coords of transformed views
0049   //! - allOrientationAngles : Orientation angles of transformed views
0050   //! - allAnnotations       : Pointers to Annotation entities
0051   //! raises exception if Lengths of allViews, allViewOrigins and
0052   //! allOrientationAngles are 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<double>>&                           allOrientationAngles,
0057     const occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>& allAnnotations);
0058
0059   //! returns the number of view pointers in <me>
0060   Standard_EXPORT int NbViews() const;
0061
0062   //! returns the View entity indicated by Index
0063   //! raises an exception if Index <= 0 or Index > NbViews().
0064   Standard_EXPORT occ::handle<IGESData_ViewKindEntity> ViewItem(const int Index) const;
0065
0066   //! returns the Drawing space coordinates of the origin of the
0067   //! Transformed view indicated by Index
0068   //! raises an exception if Index <= 0 or Index > NbViews().
0069   Standard_EXPORT gp_Pnt2d ViewOrigin(const int Index) const;
0070
0071   //! returns the Orientation angle for the Transformed view
0072   //! indicated by Index
0073   //! raises an exception if Index <= 0 or Index > NbViews().
0074   Standard_EXPORT double OrientationAngle(const int Index) const;
0075
0076   //! returns the number of Annotation entities in <me>
0077   Standard_EXPORT int NbAnnotations() const;
0078
0079   //! returns the Annotation entity in this Drawing, indicated by Index
0080   //! raises an exception if Index <= 0 or Index > NbAnnotations().
0081   Standard_EXPORT occ::handle<IGESData_IGESEntity> Annotation(const int Index) const;
0082
0083   Standard_EXPORT gp_XY ViewToDrawing(const int NumView, const gp_XYZ& ViewCoords) const;
0084
0085   //! Returns the Drawing Unit Value if it is specified (by a
0086   //! specific property entity)
0087   //! If not specified, returns False, and val as zero :
0088   //! unit to consider is then the model unit in GlobalSection
0089   Standard_EXPORT bool DrawingUnit(double& value) const;
0090
0091   //! Returns the Drawing Size if it is specified (by a
0092   //! specific property entity)
0093   //! If not specified, returns False, and X,Y as zero :
0094   //! unit to consider is then the model unit in GlobalSection
0095   Standard_EXPORT bool DrawingSize(double& X, double& Y) const;
0096
0097   DEFINE_STANDARD_RTTIEXT(IGESDraw_DrawingWithRotation, IGESData_IGESEntity)
0098
0099 private:
0100   occ::handle<NCollection_HArray1<occ::handle<IGESData_ViewKindEntity>>> theViews;
0101   occ::handle<NCollection_HArray1<gp_XY>>                                theViewOrigins;
0102   occ::handle<NCollection_HArray1<double>>                               theOrientationAngles;
0103   occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>     theAnnotations;
0104 };
0105
0106 #endif // _IGESDraw_DrawingWithRotation_HeaderFile