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