src/IGESSolid/IGESSolid_CylindricalSurface.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_CylindricalSurface_HeaderFile
  18 #define _IGESSolid_CylindricalSurface_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
  29
  30 class IGESSolid_CylindricalSurface;
  31 DEFINE_STANDARD_HANDLE(IGESSolid_CylindricalSurface, IGESData_IGESEntity)
  32
  33 //! defines CylindricalSurface, Type <192> Form Number <0,1>
  34 //! in package IGESSolid
  35 class IGESSolid_CylindricalSurface : public IGESData_IGESEntity
  36 {
  37
  38 public:
  39
  40
  41   Standard_EXPORT IGESSolid_CylindricalSurface();
  42
  43   //! This method is used to set the fields of the class
  44   //! CylindricalSurface
  45   //! - aLocation : the location of the point on axis
  46   //! - anAxis    : the direction of the axis
  47   //! - aRadius   : the radius at the axis point
  48   //! - aRefdir   : the reference direction (parametrised surface)
  49   //! default NULL (unparametrised surface)
  50   Standard_EXPORT void Init (const Handle(IGESGeom_Point)& aLocation, const Handle(IGESGeom_Direction)& anAxis, const Standard_Real aRadius, const Handle(IGESGeom_Direction)& aRefdir);
  51
  52   //! returns the point on the axis
  53   Standard_EXPORT Handle(IGESGeom_Point) LocationPoint() const;
  54
  55   //! returns the direction on the axis
  56   Standard_EXPORT Handle(IGESGeom_Direction) Axis() const;
  57
  58   //! returns the radius at the axis point
  59   Standard_EXPORT Standard_Real Radius() const;
  60
  61   //! returns whether the surface is parametrised or not
  62   Standard_EXPORT Standard_Boolean IsParametrised() const;
  63
  64   //! returns the reference direction only for parametrised surface
  65   //! else returns NULL
  66   Standard_EXPORT Handle(IGESGeom_Direction) ReferenceDir() const;
  67
  68
  69
  70
  71   DEFINE_STANDARD_RTTIEXT(IGESSolid_CylindricalSurface,IGESData_IGESEntity)
  72
  73 protected:
  74
  75
  76
  77
  78 private:
  79
  80
  81   Handle(IGESGeom_Point) theLocationPoint;
  82   Handle(IGESGeom_Direction) theAxis;
  83   Standard_Real theRadius;
  84   Handle(IGESGeom_Direction) theRefDir;
  85
  86
  87 };
  88
  89
  90
  91
  92
  93
  94
  95 #endif // _IGESSolid_CylindricalSurface_HeaderFile