include/opencascade/IGESSolid_Torus.hxx

0001 // Created on: 1993-01-09
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 _IGESSolid_Torus_HeaderFile
0018 #define _IGESSolid_Torus_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <gp_XYZ.hxx>
0024 #include <IGESData_IGESEntity.hxx>
0025 class gp_Pnt;
0026 class gp_Dir;
0027
0028
0029 class IGESSolid_Torus;
0030 DEFINE_STANDARD_HANDLE(IGESSolid_Torus, IGESData_IGESEntity)
0031
0032 //! defines Torus, Type <160> Form Number <0>
0033 //! in package IGESSolid
0034 //! A Torus is a solid formed by revolving a circular disc
0035 //! about a specified coplanar axis.
0036 class IGESSolid_Torus : public IGESData_IGESEntity
0037 {
0038
0039 public:
0040
0041
0042   Standard_EXPORT IGESSolid_Torus();
0043
0044   //! This method is used to set the fields of the class Torus
0045   //! - R1     : distance from center of torus to center
0046   //! of circular disc to be revolved
0047   //! - R2     : radius of circular disc
0048   //! - aPoint : center point coordinates (default (0,0,0))
0049   //! - anAxis : unit vector in axis direction (default (0,0,1))
0050   Standard_EXPORT void Init (const Standard_Real R1, const Standard_Real R2, const gp_XYZ& aPoint, const gp_XYZ& anAxisdir);
0051
0052   //! returns the distance from the center of torus to the center of
0053   //! the disc to be revolved
0054   Standard_EXPORT Standard_Real MajorRadius() const;
0055
0056   //! returns the radius of the disc to be revolved
0057   Standard_EXPORT Standard_Real DiscRadius() const;
0058
0059   //! returns the center of torus
0060   Standard_EXPORT gp_Pnt AxisPoint() const;
0061
0062   //! returns the center of torus after applying TransformationMatrix
0063   Standard_EXPORT gp_Pnt TransformedAxisPoint() const;
0064
0065   //! returns direction of the axis
0066   Standard_EXPORT gp_Dir Axis() const;
0067
0068   //! returns direction of the axis after applying TransformationMatrix
0069   Standard_EXPORT gp_Dir TransformedAxis() const;
0070
0071
0072
0073
0074   DEFINE_STANDARD_RTTIEXT(IGESSolid_Torus,IGESData_IGESEntity)
0075
0076 protected:
0077
0078
0079
0080
0081 private:
0082
0083
0084   Standard_Real theR1;
0085   Standard_Real theR2;
0086   gp_XYZ thePoint;
0087   gp_XYZ theAxis;
0088
0089
0090 };
0091
0092
0093
0094
0095
0096
0097
0098 #endif // _IGESSolid_Torus_HeaderFile