src/IGESSolid/IGESSolid_ToroidalSurface.hxx

   1 // Created on: 1993-01-09
   2 // Created by: CKY / Contract Toubro-Larsen ( SIVA )
   3 // Copyright (c) 1993-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _IGESSolid_ToroidalSurface_HeaderFile
  18 #define _IGESSolid_ToroidalSurface_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Real.hxx>
  24 #include <IGESData_IGESEntity.hxx>
  25 #include <Standard_Boolean.hxx>
  26 class IGESGeom_Point;
  27 class IGESGeom_Direction;
  28 class gp_Pnt;
  29
  30
  31 class IGESSolid_ToroidalSurface;
  32 DEFINE_STANDARD_HANDLE(IGESSolid_ToroidalSurface, IGESData_IGESEntity)
  33
  34 //! defines ToroidalSurface, Type <198> Form Number <0,1>
  35 //! in package IGESSolid
  36 //! This entity is defined by the center point, the axis
  37 //! direction and the major and minor radii. In case of
  38 //! parametrised surface a reference direction is provided.
  39 class IGESSolid_ToroidalSurface : public IGESData_IGESEntity
  40 {
  41
  42 public:
  43
  44
  45   Standard_EXPORT IGESSolid_ToroidalSurface();
  46
  47   //! This method is used to set the fields of the class
  48   //! ToroidalSurface
  49   //! - aCenter   : the center point coordinates
  50   //! - anAxis    : the direction of the axis
  51   //! - majRadius : the major radius
  52   //! - minRadius : the minor radius
  53   //! - Refdir    : the reference direction (parametrised)
  54   //! default Null for unparametrised surface
  55   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);
  56
  57   //! returns the center point coordinates of the surface
  58   Standard_EXPORT Handle(IGESGeom_Point) Center() const;
  59
  60   //! returns the center point coordinates of the surface
  61   //! after applying TransformationMatrix
  62   Standard_EXPORT gp_Pnt TransformedCenter() const;
  63
  64   //! returns the direction of the axis
  65   Standard_EXPORT Handle(IGESGeom_Direction) Axis() const;
  66
  67   //! returns the major radius of the surface
  68   Standard_EXPORT Standard_Real MajorRadius() const;
  69
  70   //! returns the minor radius of the surface
  71   Standard_EXPORT Standard_Real MinorRadius() const;
  72
  73   //! returns the reference direction (parametrised surface)
  74   //! Null is returned if the surface is not parametrised
  75   Standard_EXPORT Handle(IGESGeom_Direction) ReferenceDir() const;
  76
  77   //! Returns True if the surface is parametrised, else False
  78   Standard_EXPORT Standard_Boolean IsParametrised() const;
  79
  80
  81
  82
  83   DEFINE_STANDARD_RTTIEXT(IGESSolid_ToroidalSurface,IGESData_IGESEntity)
  84
  85 protected:
  86
  87
  88
  89
  90 private:
  91
  92
  93   Handle(IGESGeom_Point) theCenter;
  94   Handle(IGESGeom_Direction) theAxis;
  95   Standard_Real theMajorRadius;
  96   Standard_Real theMinorRadius;
  97   Handle(IGESGeom_Direction) theRefDir;
  98
  99
 100 };
 101
 102
 103
 104
 105
 106
 107
 108 #endif // _IGESSolid_ToroidalSurface_HeaderFile