include/opencascade/IGESGeom_CircularArc.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( Kiran )
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 _IGESGeom_CircularArc_HeaderFile
0018 #define _IGESGeom_CircularArc_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <gp_XY.hxx>
0024 #include <IGESData_IGESEntity.hxx>
0025 class gp_Pnt2d;
0026 class gp_Pnt;
0027 class gp_Dir;
0028
0029
0030 class IGESGeom_CircularArc;
0031 DEFINE_STANDARD_HANDLE(IGESGeom_CircularArc, IGESData_IGESEntity)
0032
0033 //! defines IGESCircularArc, Type <100> Form <0>
0034 //! in package IGESGeom
0035 //! A circular arc is a connected portion of a parent circle
0036 //! which consists of more than one point. The definition space
0037 //! coordinate system is always chosen so that the circular arc
0038 //! remains in a plane either coincident with or parallel to
0039 //! the XT, YT plane.
0040 class IGESGeom_CircularArc : public IGESData_IGESEntity
0041 {
0042
0043 public:
0044
0045
0046   Standard_EXPORT IGESGeom_CircularArc();
0047
0048   //! This method is used to set the fields of the class
0049   //! CircularArc
0050   //! - aZT     : Shift above the Z plane
0051   //! - aCenter : Center of the circle of which the arc forms a part
0052   //! - aStart  : Starting point of the circular arc
0053   //! - anEnd   : Ending point of the circular arc
0054   Standard_EXPORT void Init (const Standard_Real aZT, const gp_XY& aCenter, const gp_XY& aStart, const gp_XY& anEnd);
0055
0056   //! returns the center of the circle of which arc forms a part
0057   Standard_EXPORT gp_Pnt2d Center() const;
0058
0059   //! returns the center of the circle of which arc forms a part
0060   //! after applying Transf. Matrix
0061   Standard_EXPORT gp_Pnt TransformedCenter() const;
0062
0063   //! returns the start point of the arc
0064   Standard_EXPORT gp_Pnt2d StartPoint() const;
0065
0066   //! returns the start point of the arc after applying Transf. Matrix
0067   Standard_EXPORT gp_Pnt TransformedStartPoint() const;
0068
0069   //! returns the parallel displacement of the plane containing the
0070   //! arc from the XT, YT plane
0071   Standard_EXPORT Standard_Real ZPlane() const;
0072
0073   //! returns the end point of the arc
0074   Standard_EXPORT gp_Pnt2d EndPoint() const;
0075
0076   //! returns the end point of the arc after applying Transf. Matrix
0077   Standard_EXPORT gp_Pnt TransformedEndPoint() const;
0078
0079   //! returns the radius of the circle of which arc forms a part
0080   Standard_EXPORT Standard_Real Radius() const;
0081
0082   //! returns the angle subtended by the arc at the center in radians
0083   Standard_EXPORT Standard_Real Angle() const;
0084
0085   //! Z-Axis of circle (i.e. [0,0,1])
0086   Standard_EXPORT gp_Dir Axis() const;
0087
0088   //! Z-Axis after applying Trans. Matrix
0089   Standard_EXPORT gp_Dir TransformedAxis() const;
0090
0091   //! True if StartPoint = EndPoint
0092   Standard_EXPORT Standard_Boolean IsClosed() const;
0093
0094
0095
0096
0097   DEFINE_STANDARD_RTTIEXT(IGESGeom_CircularArc,IGESData_IGESEntity)
0098
0099 protected:
0100
0101
0102
0103
0104 private:
0105
0106
0107   Standard_Real theZT;
0108   gp_XY theCenter;
0109   gp_XY theStart;
0110   gp_XY theEnd;
0111
0112
0113 };
0114
0115
0116
0117
0118
0119
0120
0121 #endif // _IGESGeom_CircularArc_HeaderFile