include/opencascade/IGESDimen_DimensionDisplayData.hxx

0001 // Created on: 1993-01-09
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 _IGESDimen_DimensionDisplayData_HeaderFile
0018 #define _IGESDimen_DimensionDisplayData_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <Standard_Real.hxx>
0024 #include <TColStd_HArray1OfInteger.hxx>
0025 #include <IGESData_IGESEntity.hxx>
0026 class TCollection_HAsciiString;
0027
0028
0029 class IGESDimen_DimensionDisplayData;
0030 DEFINE_STANDARD_HANDLE(IGESDimen_DimensionDisplayData, IGESData_IGESEntity)
0031
0032 //! Defines IGES Dimension Display Data, Type <406> Form <30>,
0033 //! in package IGESDimen
0034 //! The Dimensional Display Data Property is optional but when
0035 //! present must be referenced by a dimension entity.
0036 //! The information it contains could be extracted from the text,
0037 //! leader and witness line data with difficulty.
0038 class IGESDimen_DimensionDisplayData : public IGESData_IGESEntity
0039 {
0040
0041 public:
0042
0043
0044   Standard_EXPORT IGESDimen_DimensionDisplayData();
0045
0046   Standard_EXPORT void Init (const Standard_Integer numProps, const Standard_Integer aDimType, const Standard_Integer aLabelPos, const Standard_Integer aCharSet, const Handle(TCollection_HAsciiString)& aString, const Standard_Integer aSymbol, const Standard_Real anAng, const Standard_Integer anAlign, const Standard_Integer aLevel, const Standard_Integer aPlace, const Standard_Integer anOrient, const Standard_Real initVal, const Handle(TColStd_HArray1OfInteger)& notes, const Handle(TColStd_HArray1OfInteger)& startInd, const Handle(TColStd_HArray1OfInteger)& endInd);
0047
0048   //! returns the number of property values (14)
0049   Standard_EXPORT Standard_Integer NbPropertyValues() const;
0050
0051   //! returns the dimension type
0052   Standard_EXPORT Standard_Integer DimensionType() const;
0053
0054   //! returns the preferred label position
0055   Standard_EXPORT Standard_Integer LabelPosition() const;
0056
0057   //! returns the character set interpretation
0058   Standard_EXPORT Standard_Integer CharacterSet() const;
0059
0060   //! returns e.g., 8HDIAMETER
0061   Standard_EXPORT Handle(TCollection_HAsciiString) LString() const;
0062
0063   Standard_EXPORT Standard_Integer DecimalSymbol() const;
0064
0065   //! returns the witness line angle in radians
0066   Standard_EXPORT Standard_Real WitnessLineAngle() const;
0067
0068   //! returns the text alignment
0069   Standard_EXPORT Standard_Integer TextAlignment() const;
0070
0071   //! returns the text level
0072   Standard_EXPORT Standard_Integer TextLevel() const;
0073
0074   //! returns the preferred text placement
0075   Standard_EXPORT Standard_Integer TextPlacement() const;
0076
0077   //! returns the arrowhead orientation
0078   Standard_EXPORT Standard_Integer ArrowHeadOrientation() const;
0079
0080   //! returns the primary dimension initial value
0081   Standard_EXPORT Standard_Real InitialValue() const;
0082
0083   //! returns the number of supplementary notes or zero
0084   Standard_EXPORT Standard_Integer NbSupplementaryNotes() const;
0085
0086   //! returns the Index'th supplementary note
0087   //! raises exception if Index <= 0 or Index > NbSupplementaryNotes()
0088   Standard_EXPORT Standard_Integer SupplementaryNote (const Standard_Integer Index) const;
0089
0090   //! returns the Index'th note start index
0091   //! raises exception if Index <= 0 or Index > NbSupplementaryNotes()
0092   Standard_EXPORT Standard_Integer StartIndex (const Standard_Integer Index) const;
0093
0094   //! returns the Index'th note end index
0095   //! raises exception if Index <= 0 or Index > NbSupplemetaryNotes()
0096   Standard_EXPORT Standard_Integer EndIndex (const Standard_Integer Index) const;
0097
0098
0099
0100
0101   DEFINE_STANDARD_RTTIEXT(IGESDimen_DimensionDisplayData,IGESData_IGESEntity)
0102
0103 protected:
0104
0105
0106
0107
0108 private:
0109
0110
0111   Standard_Integer theNbPropertyValues;
0112   Standard_Integer theDimensionType;
0113   Standard_Integer theLabelPosition;
0114   Standard_Integer theCharacterSet;
0115   Handle(TCollection_HAsciiString) theLString;
0116   Standard_Integer theDecimalSymbol;
0117   Standard_Real theWitnessLineAngle;
0118   Standard_Integer theTextAlignment;
0119   Standard_Integer theTextLevel;
0120   Standard_Integer theTextPlacement;
0121   Standard_Integer theArrowHeadOrientation;
0122   Standard_Real theInitialValue;
0123   Handle(TColStd_HArray1OfInteger) theSupplementaryNotes;
0124   Handle(TColStd_HArray1OfInteger) theStartIndex;
0125   Handle(TColStd_HArray1OfInteger) theEndIndex;
0126
0127
0128 };
0129
0130
0131
0132
0133
0134
0135
0136 #endif // _IGESDimen_DimensionDisplayData_HeaderFile