src/IGESSolid/IGESSolid_Ellipsoid.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_Ellipsoid_HeaderFile
  18 #define _IGESSolid_Ellipsoid_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <gp_XYZ.hxx>
  24 #include <IGESData_IGESEntity.hxx>
  25 #include <Standard_Real.hxx>
  26 class gp_Pnt;
  27 class gp_Dir;
  28
  29
  30 class IGESSolid_Ellipsoid;
  31 DEFINE_STANDARD_HANDLE(IGESSolid_Ellipsoid, IGESData_IGESEntity)
  32
  33 //! defines Ellipsoid, Type <168> Form Number <0>
  34 //! in package IGESSolid
  35 //! The ellipsoid is a solid bounded by the surface defined
  36 //! by:
  37 //! X^2       Y^2       Z^2
  38 //! -----  +  -----  +  -----  =  1
  39 //! LX^2      LY^2      LZ^2
  40 class IGESSolid_Ellipsoid : public IGESData_IGESEntity
  41 {
  42
  43 public:
  44
  45
  46   Standard_EXPORT IGESSolid_Ellipsoid();
  47
  48   //! This method is used to set the fields of the class
  49   //! Ellipsoid
  50   //! - aSize      : Lengths in the local X,Y,Z directions
  51   //! - aCenter    : Center point of ellipsoid (default (0,0,0))
  52   //! - anXAxis    : Unit vector defining local X-axis
  53   //! default (1,0,0)
  54   //! - anZAxis    : Unit vector defining local Z-axis
  55   //! default (0,0,1)
  56   Standard_EXPORT void Init (const gp_XYZ& aSize, const gp_XYZ& aCenter, const gp_XYZ& anXAxis, const gp_XYZ& anZAxis);
  57
  58   //! returns the size
  59   Standard_EXPORT gp_XYZ Size() const;
  60
  61   //! returns the length in the local X-direction
  62   Standard_EXPORT Standard_Real XLength() const;
  63
  64   //! returns the length in the local Y-direction
  65   Standard_EXPORT Standard_Real YLength() const;
  66
  67   //! returns the length in the local Z-direction
  68   Standard_EXPORT Standard_Real ZLength() const;
  69
  70   //! returns the center of the ellipsoid
  71   Standard_EXPORT gp_Pnt Center() const;
  72
  73   //! returns the center of the ellipsoid after applying
  74   //! TransformationMatrix
  75   Standard_EXPORT gp_Pnt TransformedCenter() const;
  76
  77   //! returns the vector corresponding to the local X-direction
  78   Standard_EXPORT gp_Dir XAxis() const;
  79
  80   //! returns the vector corresponding to the local X-direction
  81   //! after applying TransformationMatrix
  82   Standard_EXPORT gp_Dir TransformedXAxis() const;
  83
  84   //! returns the vector corresponding to the local Y-direction
  85   //! which is got by taking cross product of ZAxis and XAxis
  86   Standard_EXPORT gp_Dir YAxis() const;
  87
  88   //! returns the vector corresponding to the local Y-direction
  89   //! (which is got by taking cross product of ZAxis and XAxis)
  90   //! after applying TransformationMatrix
  91   Standard_EXPORT gp_Dir TransformedYAxis() const;
  92
  93   //! returns the vector corresponding to the local Z-direction
  94   Standard_EXPORT gp_Dir ZAxis() const;
  95
  96   //! returns the vector corresponding to the local Z-direction
  97   //! after applying TransformationMatrix
  98   Standard_EXPORT gp_Dir TransformedZAxis() const;
  99
 100
 101
 102
 103   DEFINE_STANDARD_RTTIEXT(IGESSolid_Ellipsoid,IGESData_IGESEntity)
 104
 105 protected:
 106
 107
 108
 109
 110 private:
 111
 112
 113   gp_XYZ theSize;
 114   gp_XYZ theCenter;
 115   gp_XYZ theXAxis;
 116   gp_XYZ theZAxis;
 117
 118
 119 };
 120
 121
 122
 123
 124
 125
 126
 127 #endif // _IGESSolid_Ellipsoid_HeaderFile