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