include/opencascade/IGESDimen_LeaderArrow.hxx

0001 // Created on: 1993-01-13
0002 // Created by: CKY / Contract Toubro-Larsen ( Deepak PRABHU )
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_LeaderArrow_HeaderFile
0018 #define _IGESDimen_LeaderArrow_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <gp_XY.hxx>
0024 #include <TColgp_HArray1OfXY.hxx>
0025 #include <IGESData_IGESEntity.hxx>
0026 #include <Standard_Integer.hxx>
0027 class gp_Pnt2d;
0028 class gp_Pnt;
0029
0030
0031 class IGESDimen_LeaderArrow;
0032 DEFINE_STANDARD_HANDLE(IGESDimen_LeaderArrow, IGESData_IGESEntity)
0033
0034 //! defines LeaderArrow, Type <214> Form <1-12>
0035 //! in package IGESDimen
0036 //! Consists of one or more line segments except when
0037 //! leader is part of an angular dimension, with links to
0038 //! presumed text item
0039 class IGESDimen_LeaderArrow : public IGESData_IGESEntity
0040 {
0041
0042 public:
0043
0044
0045   Standard_EXPORT IGESDimen_LeaderArrow();
0046
0047   //! This method is used to set the fields of the class
0048   //! LeaderArrow
0049   //! - height      : ArrowHead height
0050   //! - width       : ArrowHead width
0051   //! - depth       : Z Depth
0052   //! - position    : ArrowHead coordinates
0053   //! - segments    : Segment tail coordinate pairs
0054   Standard_EXPORT void Init (const Standard_Real height, const Standard_Real width, const Standard_Real depth, const gp_XY& position, const Handle(TColgp_HArray1OfXY)& segments);
0055
0056   //! Changes FormNumber (indicates the Shape of the Arrow)
0057   //! Error if not in range [0-12]
0058   Standard_EXPORT void SetFormNumber (const Standard_Integer form);
0059
0060   //! returns number of segments
0061   Standard_EXPORT Standard_Integer NbSegments() const;
0062
0063   //! returns ArrowHead height
0064   Standard_EXPORT Standard_Real ArrowHeadHeight() const;
0065
0066   //! returns ArrowHead width
0067   Standard_EXPORT Standard_Real ArrowHeadWidth() const;
0068
0069   //! returns Z depth
0070   Standard_EXPORT Standard_Real ZDepth() const;
0071
0072   //! returns ArrowHead coordinates
0073   Standard_EXPORT gp_Pnt2d ArrowHead() const;
0074
0075   //! returns ArrowHead coordinates after Transformation
0076   Standard_EXPORT gp_Pnt TransformedArrowHead() const;
0077
0078   //! returns segment tail coordinates.
0079   //! raises exception if Index <= 0 or Index > NbSegments
0080   Standard_EXPORT gp_Pnt2d SegmentTail (const Standard_Integer Index) const;
0081
0082   //! returns segment tail coordinates after Transformation.
0083   //! raises exception if Index <= 0 or Index > NbSegments
0084   Standard_EXPORT gp_Pnt TransformedSegmentTail (const Standard_Integer Index) const;
0085
0086
0087
0088
0089   DEFINE_STANDARD_RTTIEXT(IGESDimen_LeaderArrow,IGESData_IGESEntity)
0090
0091 protected:
0092
0093
0094
0095
0096 private:
0097
0098
0099   Standard_Real theArrowHeadHeight;
0100   Standard_Real theArrowHeadWidth;
0101   Standard_Real theZDepth;
0102   gp_XY theArrowHead;
0103   Handle(TColgp_HArray1OfXY) theSegmentTails;
0104
0105
0106 };
0107
0108
0109
0110
0111
0112
0113
0114 #endif // _IGESDimen_LeaderArrow_HeaderFile