include/opencascade/IGESDraw_NetworkSubfigure.hxx

0001 // Created on: 1993-01-11
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_NetworkSubfigure_HeaderFile
0018 #define _IGESDraw_NetworkSubfigure_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <gp_XYZ.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <IGESDraw_ConnectPoint.hxx>
0026 #include <NCollection_Array1.hxx>
0027 #include <NCollection_HArray1.hxx>
0028 #include <IGESData_IGESEntity.hxx>
0029 class IGESDraw_NetworkSubfigureDef;
0030 class TCollection_HAsciiString;
0031 class IGESGraph_TextDisplayTemplate;
0032 class IGESDraw_ConnectPoint;
0033
0034 //! defines IGES Network Subfigure Instance Entity,
0035 //! Type <420> Form Number <0> in package IGESDraw
0036 //!
0037 //! Used to specify each instance of Network Subfigure
0038 //! Definition Entity (Type 320, Form 0).
0039 class IGESDraw_NetworkSubfigure : public IGESData_IGESEntity
0040 {
0041
0042 public:
0043   Standard_EXPORT IGESDraw_NetworkSubfigure();
0044
0045   //! This method is used to set the fields of the class
0046   //! NetworkSubfigure
0047   //! - aDefinition      : Network Subfigure Definition Entity
0048   //! - aTranslation     : Translation data relative to the model
0049   //! space or the definition space
0050   //! - aScaleFactor     : Scale factors in the definition space
0051   //! - aTypeFlag        : Type flag
0052   //! - aDesignator      : Primary reference designator
0053   //! - aTemplate        : Primary reference designator Text
0054   //! display Template Entity
0055   //! - allConnectPoints : Associated Connect Point Entities
0056   Standard_EXPORT void Init(
0057     const occ::handle<IGESDraw_NetworkSubfigureDef>&                            aDefinition,
0058     const gp_XYZ&                                                               aTranslation,
0059     const gp_XYZ&                                                               aScaleFactor,
0060     const int                                                                   aTypeFlag,
0061     const occ::handle<TCollection_HAsciiString>&                                aDesignator,
0062     const occ::handle<IGESGraph_TextDisplayTemplate>&                           aTemplate,
0063     const occ::handle<NCollection_HArray1<occ::handle<IGESDraw_ConnectPoint>>>& allConnectPoints);
0064
0065   //! returns Network Subfigure Definition Entity specified by this entity
0066   Standard_EXPORT occ::handle<IGESDraw_NetworkSubfigureDef> SubfigureDefinition() const;
0067
0068   //! returns Translation Data relative to either model space or to
0069   //! the definition space of a referring entity
0070   Standard_EXPORT gp_XYZ Translation() const;
0071
0072   //! returns the Transformed Translation Data relative to either model
0073   //! space or to the definition space of a referring entity
0074   Standard_EXPORT gp_XYZ TransformedTranslation() const;
0075
0076   //! returns Scale factor in definition space(x, y, z axes)
0077   Standard_EXPORT gp_XYZ ScaleFactors() const;
0078
0079   //! returns Type Flag which implements the distinction between Logical
0080   //! design and Physical design data,and is required if both are present.
0081   //! Type Flag = 0 : Not specified (default)
0082   //! = 1 : Logical
0083   //! = 2 : Physical
0084   Standard_EXPORT int TypeFlag() const;
0085
0086   //! returns the primary reference designator
0087   Standard_EXPORT occ::handle<TCollection_HAsciiString> ReferenceDesignator() const;
0088
0089   //! returns True if Text Display Template Entity is specified,
0090   //! else False
0091   Standard_EXPORT bool HasDesignatorTemplate() const;
0092
0093   //! returns primary reference designator Text Display Template Entity,
0094   //! or null. If null, no Text Display Template Entity specified
0095   Standard_EXPORT occ::handle<IGESGraph_TextDisplayTemplate> DesignatorTemplate() const;
0096
0097   //! returns the number of associated Connect Point Entities
0098   Standard_EXPORT int NbConnectPoints() const;
0099
0100   //! returns the Index'th  associated Connect point Entity
0101   //! raises exception if Index <= 0 or Index > NbConnectPoints()
0102   Standard_EXPORT occ::handle<IGESDraw_ConnectPoint> ConnectPoint(const int Index) const;
0103
0104   DEFINE_STANDARD_RTTIEXT(IGESDraw_NetworkSubfigure, IGESData_IGESEntity)
0105
0106 private:
0107   occ::handle<IGESDraw_NetworkSubfigureDef>                            theSubfigureDefinition;
0108   gp_XYZ                                                               theTranslation;
0109   gp_XYZ                                                               theScaleFactor;
0110   int                                                                  theTypeFlag;
0111   occ::handle<TCollection_HAsciiString>                                theDesignator;
0112   occ::handle<IGESGraph_TextDisplayTemplate>                           theDesignatorTemplate;
0113   occ::handle<NCollection_HArray1<occ::handle<IGESDraw_ConnectPoint>>> theConnectPoints;
0114 };
0115
0116 #endif // _IGESDraw_NetworkSubfigure_HeaderFile