src/IGESSolid/IGESSolid_Cylinder.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_Cylinder_HeaderFile
  18 #define _IGESSolid_Cylinder_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <gp_XYZ.hxx>
  24 #include <IGESData_IGESEntity.hxx>
  25 class gp_Pnt;
  26 class gp_Dir;
  27
  28
  29 class IGESSolid_Cylinder;
  30 DEFINE_STANDARD_HANDLE(IGESSolid_Cylinder, IGESData_IGESEntity)
  31
  32 //! defines Cylinder, Type <154> Form Number <0>
  33 //! in package IGESSolid
  34 //! This defines a solid cylinder
  35 class IGESSolid_Cylinder : public IGESData_IGESEntity
  36 {
  37
  38 public:
  39
  40
  41   Standard_EXPORT IGESSolid_Cylinder();
  42
  43   //! This method is used to set the fields of the class
  44   //! Cylinder
  45   //! - aHeight : Cylinder height
  46   //! - aRadius : Cylinder radius
  47   //! - aCenter : First face center coordinates (default (0,0,0))
  48   //! - anAxis  : Unit vector in axis direction (default (0,0,1))
  49   Standard_EXPORT void Init (const Standard_Real aHeight, const Standard_Real aRadius, const gp_XYZ& aCenter, const gp_XYZ& anAxis);
  50
  51   //! returns the cylinder height
  52   Standard_EXPORT Standard_Real Height() const;
  53
  54   //! returns the cylinder radius
  55   Standard_EXPORT Standard_Real Radius() const;
  56
  57   //! returns the first face center coordinates.
  58   Standard_EXPORT gp_Pnt FaceCenter() const;
  59
  60   //! returns the first face center after applying TransformationMatrix
  61   Standard_EXPORT gp_Pnt TransformedFaceCenter() const;
  62
  63   //! returns the vector in axis direction
  64   Standard_EXPORT gp_Dir Axis() const;
  65
  66   //! returns the vector in axis direction after applying
  67   //! TransformationMatrix
  68   Standard_EXPORT gp_Dir TransformedAxis() const;
  69
  70
  71
  72
  73   DEFINE_STANDARD_RTTIEXT(IGESSolid_Cylinder,IGESData_IGESEntity)
  74
  75 protected:
  76
  77
  78
  79
  80 private:
  81
  82
  83   Standard_Real theHeight;
  84   Standard_Real theRadius;
  85   gp_XYZ theFaceCenter;
  86   gp_XYZ theAxis;
  87
  88
  89 };
  90
  91
  92
  93
  94
  95
  96
  97 #endif // _IGESSolid_Cylinder_HeaderFile