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