src/IGESSolid/IGESSolid_SphericalSurface.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_SphericalSurface_HeaderFile
  18 #define _IGESSolid_SphericalSurface_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_SphericalSurface;
  32 DEFINE_STANDARD_HANDLE(IGESSolid_SphericalSurface, IGESData_IGESEntity)
  33
  34 //! defines SphericalSurface, Type <196> Form Number <0,1>
  35 //! in package IGESSolid
  36 //! Spherical surface is defined by a center and radius.
  37 //! In case of parametrised surface an axis and a
  38 //! reference direction is provided.
  39 class IGESSolid_SphericalSurface : public IGESData_IGESEntity
  40 {
  41
  42 public:
  43
  44
  45   Standard_EXPORT IGESSolid_SphericalSurface();
  46
  47   //! This method is used to set the fields of the class
  48   //! SphericalSurface
  49   //! - aCenter : the coordinates of the center point
  50   //! - aRadius : value of radius
  51   //! - anAxis  : the direction of the axis
  52   //! Null in case of Unparametrised surface
  53   //! - aRefdir : the reference direction
  54   //! Null in case of Unparametrised surface
  55   Standard_EXPORT void Init (const Handle(IGESGeom_Point)& aCenter, const Standard_Real aRadius, const Handle(IGESGeom_Direction)& anAxis, const Handle(IGESGeom_Direction)& aRefdir);
  56
  57   //! returns the center of the spherical surface
  58   Standard_EXPORT Handle(IGESGeom_Point) Center() const;
  59
  60   //! returns the center of the spherical surface after applying
  61   //! TransformationMatrix
  62   Standard_EXPORT gp_Pnt TransformedCenter() const;
  63
  64   //! returns the radius of the spherical surface
  65   Standard_EXPORT Standard_Real Radius() const;
  66
  67   //! returns the direction of the axis (Parametrised surface)
  68   //! Null is returned if the surface is not parametrised
  69   Standard_EXPORT Handle(IGESGeom_Direction) Axis() const;
  70
  71   //! returns the reference direction (Parametrised surface)
  72   //! Null is returned if the surface is not parametrised
  73   Standard_EXPORT Handle(IGESGeom_Direction) ReferenceDir() const;
  74
  75   //! Returns True if the surface is parametrised, else False
  76   Standard_EXPORT Standard_Boolean IsParametrised() const;
  77
  78
  79
  80
  81   DEFINE_STANDARD_RTTIEXT(IGESSolid_SphericalSurface,IGESData_IGESEntity)
  82
  83 protected:
  84
  85
  86
  87
  88 private:
  89
  90
  91   Handle(IGESGeom_Point) theCenter;
  92   Standard_Real theRadius;
  93   Handle(IGESGeom_Direction) theAxis;
  94   Handle(IGESGeom_Direction) theRefDir;
  95
  96
  97 };
  98
  99
 100
 101
 102
 103
 104
 105 #endif // _IGESSolid_SphericalSurface_HeaderFile