include/opencascade/IGESSolid_ToroidalSurface.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_ToroidalSurface_HeaderFile
0018 #define _IGESSolid_ToroidalSurface_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IGESData_IGESEntity.hxx>
0024 class IGESGeom_Point;
0025 class IGESGeom_Direction;
0026 class gp_Pnt;
0027
0028 //! defines ToroidalSurface, Type <198> Form Number <0,1>
0029 //! in package IGESSolid
0030 //! This entity is defined by the center point, the axis
0031 //! direction and the major and minor radii. In case of
0032 //! parametrised surface a reference direction is provided.
0033 class IGESSolid_ToroidalSurface : public IGESData_IGESEntity
0034 {
0035
0036 public:
0037   Standard_EXPORT IGESSolid_ToroidalSurface();
0038
0039   //! This method is used to set the fields of the class
0040   //! ToroidalSurface
0041   //! - aCenter   : the center point coordinates
0042   //! - anAxis    : the direction of the axis
0043   //! - majRadius : the major radius
0044   //! - minRadius : the minor radius
0045   //! - Refdir    : the reference direction (parametrised)
0046   //! default Null for unparametrised surface
0047   Standard_EXPORT void Init(const occ::handle<IGESGeom_Point>&     aCenter,
0048                             const occ::handle<IGESGeom_Direction>& anAxis,
0049                             const double                           majRadius,
0050                             const double                           minRadius,
0051                             const occ::handle<IGESGeom_Direction>& Refdir);
0052
0053   //! returns the center point coordinates of the surface
0054   Standard_EXPORT occ::handle<IGESGeom_Point> Center() const;
0055
0056   //! returns the center point coordinates of the surface
0057   //! after applying TransformationMatrix
0058   Standard_EXPORT gp_Pnt TransformedCenter() const;
0059
0060   //! returns the direction of the axis
0061   Standard_EXPORT occ::handle<IGESGeom_Direction> Axis() const;
0062
0063   //! returns the major radius of the surface
0064   Standard_EXPORT double MajorRadius() const;
0065
0066   //! returns the minor radius of the surface
0067   Standard_EXPORT double MinorRadius() const;
0068
0069   //! returns the reference direction (parametrised surface)
0070   //! Null is returned if the surface is not parametrised
0071   Standard_EXPORT occ::handle<IGESGeom_Direction> ReferenceDir() const;
0072
0073   //! Returns True if the surface is parametrised, else False
0074   Standard_EXPORT bool IsParametrised() const;
0075
0076   DEFINE_STANDARD_RTTIEXT(IGESSolid_ToroidalSurface, IGESData_IGESEntity)
0077
0078 private:
0079   occ::handle<IGESGeom_Point>     theCenter;
0080   occ::handle<IGESGeom_Direction> theAxis;
0081   double                          theMajorRadius;
0082   double                          theMinorRadius;
0083   occ::handle<IGESGeom_Direction> theRefDir;
0084 };
0085
0086 #endif // _IGESSolid_ToroidalSurface_HeaderFile