src/GeomData/GeomData_Dir.h

   1 // Copyright (C) 2014-2024  CEA, EDF
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef GeomData_Dir_H_
  21 #define GeomData_Dir_H_
  22
  23 #include "GeomData.h"
  24 #include "GeomDataAPI_Dir.h"
  25 #include <TDataStd_RealArray.hxx>
  26 #include <TDF_Label.hxx>
  27 #include <memory>
  28
  29 class GeomAPI_Dir;
  30 class GeomAPI_XYZ;
  31
  32 /**\class GeomData_Dir
  33  * \ingroup DataModel
  34  * \brief Attribute that contains direction.
  35  */
  36 class GeomData_Dir : public GeomDataAPI_Dir
  37 {
  38   TDF_Label myLab; ///< the main label of the attribute
  39   Handle_TDataStd_RealArray myCoords;  ///< X, Y and Z doubles as real array attribute [0; 2]
  40  public:
  41   /// Defines the double value
  42   GEOMDATA_EXPORT virtual void setValue(const double theX, const double theY, const double theZ);
  43   /// Defines the direction
  44   GEOMDATA_EXPORT virtual void setValue(const std::shared_ptr<GeomAPI_Dir>& theDir);
  45
  46   /// Returns the X double value
  47   GEOMDATA_EXPORT virtual double x() const;
  48   /// Returns the Y double value
  49   GEOMDATA_EXPORT virtual double y() const;
  50   /// Returns the Z double value
  51   GEOMDATA_EXPORT virtual double z() const;
  52   /// Returns the direction of this attribute
  53   GEOMDATA_EXPORT virtual std::shared_ptr<GeomAPI_Dir> dir();
  54   /// Returns the coordinates of this attribute
  55   GEOMDATA_EXPORT virtual std::shared_ptr<GeomAPI_XYZ> xyz();
  56
  57   /// Returns \c ture if the direction is initialized
  58   GEOMDATA_EXPORT virtual bool isInitialized();
  59
  60   /// Resets attribute to default state.
  61   GEOMDATA_EXPORT virtual void reset();
  62
  63  protected:
  64   /// Initializes attributes
  65   GEOMDATA_EXPORT GeomData_Dir(TDF_Label& theLabel);
  66   /// Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc)
  67   virtual void reinit();
  68
  69   friend class Model_Data;
  70 };
  71
  72 #endif