include/opencascade/IGESDimen_PointDimension.hxx

0001 // Created on: 1993-01-11
0002 // Created by: CKY / Contract Toubro-Larsen ( SIVA )
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_PointDimension_HeaderFile
0018 #define _IGESDimen_PointDimension_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IGESData_IGESEntity.hxx>
0024 #include <Standard_Integer.hxx>
0025 class IGESDimen_GeneralNote;
0026 class IGESDimen_LeaderArrow;
0027 class IGESGeom_CircularArc;
0028 class IGESGeom_CompositeCurve;
0029
0030 //! defines IGES Point Dimension, Type <220> Form <0>,
0031 //! in package IGESDimen
0032 //! A Point Dimension Entity consists of a leader, text, and
0033 //! an optional circle or hexagon enclosing the text
0034 //! IGES specs for this entity mention SimpleClosedPlanarCurve
0035 //! Entity(106/63)which is not listed in LIST.Text In the sequel
0036 //! we have ignored this & considered only the other two entity
0037 //! for representing the hexagon or circle enclosing the text.
0038 class IGESDimen_PointDimension : public IGESData_IGESEntity
0039 {
0040
0041 public:
0042   Standard_EXPORT IGESDimen_PointDimension();
0043
0044   Standard_EXPORT void Init(const occ::handle<IGESDimen_GeneralNote>& aNote,
0045                             const occ::handle<IGESDimen_LeaderArrow>& anArrow,
0046                             const occ::handle<IGESData_IGESEntity>&   aGeom);
0047
0048   Standard_EXPORT occ::handle<IGESDimen_GeneralNote> Note() const;
0049
0050   Standard_EXPORT occ::handle<IGESDimen_LeaderArrow> LeaderArrow() const;
0051
0052   //! returns the type of geometric entity.
0053   //! 0 if no hexagon or circle encloses the text
0054   //! 1 if CircularArc
0055   //! 2 if CompositeCurve
0056   //! 3 otherwise
0057   Standard_EXPORT int GeomCase() const;
0058
0059   //! returns the Geometry Entity, Null handle if GeomCase(me) .eq. 0
0060   Standard_EXPORT occ::handle<IGESData_IGESEntity> Geom() const;
0061
0062   //! returns Null handle if GeomCase(me) .ne. 1
0063   Standard_EXPORT occ::handle<IGESGeom_CircularArc> CircularArc() const;
0064
0065   //! returns Null handle if GeomCase(me) .ne. 2
0066   Standard_EXPORT occ::handle<IGESGeom_CompositeCurve> CompositeCurve() const;
0067
0068   DEFINE_STANDARD_RTTIEXT(IGESDimen_PointDimension, IGESData_IGESEntity)
0069
0070 private:
0071   occ::handle<IGESDimen_GeneralNote> theNote;
0072   occ::handle<IGESDimen_LeaderArrow> theLeader;
0073   occ::handle<IGESData_IGESEntity>   theGeom;
0074 };
0075
0076 #endif // _IGESDimen_PointDimension_HeaderFile