1 // Created on: 1993-01-11
2 // Created by: CKY / Contract Toubro-Larsen ( TCD )
3 // Copyright (c) 1993-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
6 // This file is part of Open CASCADE Technology software library.
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 #ifndef _IGESDraw_NetworkSubfigure_HeaderFile
18 #define _IGESDraw_NetworkSubfigure_HeaderFile
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
24 #include <Standard_Integer.hxx>
25 #include <IGESDraw_HArray1OfConnectPoint.hxx>
26 #include <IGESData_IGESEntity.hxx>
27 #include <Standard_Boolean.hxx>
28 class IGESDraw_NetworkSubfigureDef;
29 class TCollection_HAsciiString;
30 class IGESGraph_TextDisplayTemplate;
31 class Standard_OutOfRange;
33 class IGESDraw_ConnectPoint;
36 class IGESDraw_NetworkSubfigure;
37 DEFINE_STANDARD_HANDLE(IGESDraw_NetworkSubfigure, IGESData_IGESEntity)
39 //! defines IGES Network Subfigure Instance Entity,
40 //! Type <420> Form Number <0> in package IGESDraw
42 //! Used to specify each instance of Network Subfigure
43 //! Definition Entity (Type 320, Form 0).
44 class IGESDraw_NetworkSubfigure : public IGESData_IGESEntity
50 Standard_EXPORT IGESDraw_NetworkSubfigure();
52 //! This method is used to set the fields of the class
54 //! - aDefinition : Network Subfigure Definition Entity
55 //! - aTranslation : Translation data relative to the model
56 //! space or the definition space
57 //! - aScaleFactor : Scale factors in the definition space
58 //! - aTypeFlag : Type flag
59 //! - aDesignator : Primary reference designator
60 //! - aTemplate : Primary reference designator Text
61 //! display Template Entity
62 //! - allConnectPoints : Associated Connect Point Entities
63 Standard_EXPORT void Init (const Handle(IGESDraw_NetworkSubfigureDef)& aDefinition, const gp_XYZ& aTranslation, const gp_XYZ& aScaleFactor, const Standard_Integer aTypeFlag, const Handle(TCollection_HAsciiString)& aDesignator, const Handle(IGESGraph_TextDisplayTemplate)& aTemplate, const Handle(IGESDraw_HArray1OfConnectPoint)& allConnectPoints);
65 //! returns Network Subfigure Definition Entity specified by this entity
66 Standard_EXPORT Handle(IGESDraw_NetworkSubfigureDef) SubfigureDefinition() const;
68 //! returns Translation Data relative to either model space or to
69 //! the definition space of a referring entity
70 Standard_EXPORT gp_XYZ Translation() const;
72 //! returns the Transformed Translation Data relative to either model
73 //! space or to the definition space of a referring entity
74 Standard_EXPORT gp_XYZ TransformedTranslation() const;
76 //! returns Scale factor in definition space(x, y, z axes)
77 Standard_EXPORT gp_XYZ ScaleFactors() const;
79 //! returns Type Flag which implements the distinction between Logical
80 //! design and Physical design data,and is required if both are present.
81 //! Type Flag = 0 : Not specified (default)
84 Standard_EXPORT Standard_Integer TypeFlag() const;
86 //! returns the primary reference designator
87 Standard_EXPORT Handle(TCollection_HAsciiString) ReferenceDesignator() const;
89 //! returns True if Text Display Template Entity is specified,
91 Standard_EXPORT Standard_Boolean HasDesignatorTemplate() const;
93 //! returns primary reference designator Text Display Template Entity,
94 //! or null. If null, no Text Display Template Entity specified
95 Standard_EXPORT Handle(IGESGraph_TextDisplayTemplate) DesignatorTemplate() const;
97 //! returns the number of associated Connect Point Entities
98 Standard_EXPORT Standard_Integer NbConnectPoints() const;
100 //! returns the Index'th associated Connect point Entity
101 //! raises exception if Index <= 0 or Index > NbConnectPoints()
102 Standard_EXPORT Handle(IGESDraw_ConnectPoint) ConnectPoint (const Standard_Integer Index) const;
107 DEFINE_STANDARD_RTTIEXT(IGESDraw_NetworkSubfigure,IGESData_IGESEntity)
117 Handle(IGESDraw_NetworkSubfigureDef) theSubfigureDefinition;
118 gp_XYZ theTranslation;
119 gp_XYZ theScaleFactor;
120 Standard_Integer theTypeFlag;
121 Handle(TCollection_HAsciiString) theDesignator;
122 Handle(IGESGraph_TextDisplayTemplate) theDesignatorTemplate;
123 Handle(IGESDraw_HArray1OfConnectPoint) theConnectPoints;
134 #endif // _IGESDraw_NetworkSubfigure_HeaderFile