include/opencascade/IGESAppli_LineWidening.hxx

0001 // Created on: 1993-01-11
0002 // Created by: CKY / Contract Toubro-Larsen ( Arun MENON )
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 _IGESAppli_LineWidening_HeaderFile
0018 #define _IGESAppli_LineWidening_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <Standard_Real.hxx>
0024 #include <IGESData_IGESEntity.hxx>
0025
0026
0027 class IGESAppli_LineWidening;
0028 DEFINE_STANDARD_HANDLE(IGESAppli_LineWidening, IGESData_IGESEntity)
0029
0030 //! defines LineWidening, Type <406> Form <5>
0031 //! in package IGESAppli
0032 //! Defines the characteristics of entities when they are
0033 //! used to define locations of items.
0034 class IGESAppli_LineWidening : public IGESData_IGESEntity
0035 {
0036
0037 public:
0038
0039
0040   Standard_EXPORT IGESAppli_LineWidening();
0041
0042   //! This method is used to set the fields of the class
0043   //! LineWidening
0044   //! - nbPropVal   : Number of property values = 5
0045   //! - aWidth      : Width of metalization
0046   //! - aCornering  : Cornering codes
0047   //! 0 = rounded
0048   //! 1 = squared
0049   //! - aExtnFlag   : Extension Flag
0050   //! 0 = No Extension
0051   //! 1 = One-half width extension
0052   //! 2 = Extn set by ExtnVal
0053   //! - aJustifFlag : Justification flag
0054   //! 0 = Center justified
0055   //! 1 = left justified
0056   //! 2 = right justified
0057   //! - aExtnVal    : Extension value if aExtnFlag = 2
0058   Standard_EXPORT void Init (const Standard_Integer nbPropVal, const Standard_Real aWidth, const Standard_Integer aCornering, const Standard_Integer aExtnFlag, const Standard_Integer aJustifFlag, const Standard_Real aExtnVal);
0059
0060   //! returns the number of property values
0061   //! is always 5
0062   Standard_EXPORT Standard_Integer NbPropertyValues() const;
0063
0064   //! returns the width of metallization
0065   Standard_EXPORT Standard_Real WidthOfMetalization() const;
0066
0067   //! returns the cornering code
0068   //! 0 = Rounded  /   1 = Squared
0069   Standard_EXPORT Standard_Integer CorneringCode() const;
0070
0071   //! returns the extension flag
0072   //! 0 = No extension
0073   //! 1 = One-half width extension
0074   //! 2 = Extension set by theExtnVal
0075   Standard_EXPORT Standard_Integer ExtensionFlag() const;
0076
0077   //! returns the justification flag
0078   //! 0 = Centre justified
0079   //! 1 = Left justified
0080   //! 2 = Right justified
0081   Standard_EXPORT Standard_Integer JustificationFlag() const;
0082
0083   //! returns the Extension Value
0084   //! Present only if theExtnFlag = 2
0085   Standard_EXPORT Standard_Real ExtensionValue() const;
0086
0087
0088
0089
0090   DEFINE_STANDARD_RTTIEXT(IGESAppli_LineWidening,IGESData_IGESEntity)
0091
0092 protected:
0093
0094
0095
0096
0097 private:
0098
0099
0100   Standard_Integer theNbPropertyValues;
0101   Standard_Real theWidth;
0102   Standard_Integer theCorneringCode;
0103   Standard_Integer theExtensionFlag;
0104   Standard_Integer theJustificationFlag;
0105   Standard_Real theExtensionValue;
0106
0107
0108 };
0109
0110
0111
0112
0113
0114
0115
0116 #endif // _IGESAppli_LineWidening_HeaderFile