src/IGESGeom/IGESGeom_CircularArc.hxx

   1 // Created on: 1993-01-09
   2 // Created by: CKY / Contract Toubro-Larsen ( Kiran )
   3 // Copyright (c) 1993-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _IGESGeom_CircularArc_HeaderFile
  18 #define _IGESGeom_CircularArc_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Real.hxx>
  24 #include <gp_XY.hxx>
  25 #include <IGESData_IGESEntity.hxx>
  26 #include <Standard_Boolean.hxx>
  27 class gp_XY;
  28 class gp_Pnt2d;
  29 class gp_Pnt;
  30 class gp_Dir;
  31
  32
  33 class IGESGeom_CircularArc;
  34 DEFINE_STANDARD_HANDLE(IGESGeom_CircularArc, IGESData_IGESEntity)
  35
  36 //! defines IGESCircularArc, Type <100> Form <0>
  37 //! in package IGESGeom
  38 //! A circular arc is a connected portion of a parent circle
  39 //! which consists of more than one point. The definition space
  40 //! coordinate system is always chosen so that the circular arc
  41 //! remains in a plane either coincident with or parallel to
  42 //! the XT, YT plane.
  43 class IGESGeom_CircularArc : public IGESData_IGESEntity
  44 {
  45
  46 public:
  47
  48
  49   Standard_EXPORT IGESGeom_CircularArc();
  50
  51   //! This method is used to set the fields of the class
  52   //! CircularArc
  53   //! - aZT     : Shift above the Z plane
  54   //! - aCenter : Center of the circle of which the arc forms a part
  55   //! - aStart  : Starting point of the circular arc
  56   //! - anEnd   : Ending point of the circular arc
  57   Standard_EXPORT void Init (const Standard_Real aZT, const gp_XY& aCenter, const gp_XY& aStart, const gp_XY& anEnd);
  58
  59   //! returns the center of the circle of which arc forms a part
  60   Standard_EXPORT gp_Pnt2d Center() const;
  61
  62   //! returns the center of the circle of which arc forms a part
  63   //! after applying Transf. Matrix
  64   Standard_EXPORT gp_Pnt TransformedCenter() const;
  65
  66   //! returns the start point of the arc
  67   Standard_EXPORT gp_Pnt2d StartPoint() const;
  68
  69   //! returns the start point of the arc after applying Transf. Matrix
  70   Standard_EXPORT gp_Pnt TransformedStartPoint() const;
  71
  72   //! returns the parallel displacement of the plane containing the
  73   //! arc from the XT, YT plane
  74   Standard_EXPORT Standard_Real ZPlane() const;
  75
  76   //! returns the end point of the arc
  77   Standard_EXPORT gp_Pnt2d EndPoint() const;
  78
  79   //! returns the end point of the arc after applying Transf. Matrix
  80   Standard_EXPORT gp_Pnt TransformedEndPoint() const;
  81
  82   //! returns the radius of the circle of which arc forms a part
  83   Standard_EXPORT Standard_Real Radius() const;
  84
  85   //! returns the angle subtended by the arc at the center in radians
  86   Standard_EXPORT Standard_Real Angle() const;
  87
  88   //! Z-Axis of circle (i.e. [0,0,1])
  89   Standard_EXPORT gp_Dir Axis() const;
  90
  91   //! Z-Axis after applying Trans. Matrix
  92   Standard_EXPORT gp_Dir TransformedAxis() const;
  93
  94   //! True if StartPoint = EndPoint
  95   Standard_EXPORT Standard_Boolean IsClosed() const;
  96
  97
  98
  99
 100   DEFINE_STANDARD_RTTIEXT(IGESGeom_CircularArc,IGESData_IGESEntity)
 101
 102 protected:
 103
 104
 105
 106
 107 private:
 108
 109
 110   Standard_Real theZT;
 111   gp_XY theCenter;
 112   gp_XY theStart;
 113   gp_XY theEnd;
 114
 115
 116 };
 117
 118
 119
 120
 121
 122
 123
 124 #endif // _IGESGeom_CircularArc_HeaderFile