src/GeomDataAPI/GeomDataAPI_Point.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        GeomDataAPI_Point.h
   4 // Created:     24 Apr 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef GeomDataAPI_Point_H_
   8 #define GeomDataAPI_Point_H_
   9
  10 #include "GeomDataAPI.h"
  11 #include <ModelAPI_Attribute.h>
  12
  13 class GeomAPI_Pnt;
  14
  15 /**\class GeomDataAPI_Point
  16  * \ingroup DataModel
  17  * \brief Attribute that contains 3D point coordinates.
  18  */
  19
  20 class GeomDataAPI_Point : public ModelAPI_Attribute
  21 {
  22  public:
  23   /// Defines the double value
  24   virtual void setValue(const double theX, const double theY, const double theZ) = 0;
  25   /// Defines the point
  26   virtual void setValue(const std::shared_ptr<GeomAPI_Pnt>& thePoint) = 0;
  27
  28   /// Returns the X double value
  29   virtual double x() const = 0;
  30   /// Returns the Y double value
  31   virtual double y() const = 0;
  32   /// Returns the Z double value
  33   virtual double z() const = 0;
  34   /// Returns the 3D point
  35   virtual std::shared_ptr<GeomAPI_Pnt> pnt() = 0;
  36
  37   /// Defines the double values
  38   virtual void setText(const std::string& theX,
  39                        const std::string& theY,
  40                        const std::string& theZ) = 0;
  41
  42   /// Returns the double values
  43   virtual std::string textX() = 0;
  44   virtual std::string textY() = 0;
  45   virtual std::string textZ() = 0;
  46
  47   enum PointComponent { C_X = 0,
  48                         C_Y = 1,
  49                         C_Z = 2,
  50   };
  51
  52   /// Allows to set expression (text) as invalid (by the parameters listener)
  53   virtual void setExpressionInvalid(int theComponent, const bool theFlag) = 0;
  54
  55   /// Returns true if text is invalid
  56   virtual bool expressionInvalid(int theComponent) = 0;
  57
  58   /// Returns the type of this class of attributes
  59   static std::string typeId()
  60   {
  61     return std::string("Point");
  62   }
  63
  64   /// Returns the type of this class of attributes, not static method
  65   GEOMDATAAPI_EXPORT virtual std::string attributeType();
  66
  67  protected:
  68   /// Objects are created for features automatically
  69   GEOMDATAAPI_EXPORT GeomDataAPI_Point();
  70   GEOMDATAAPI_EXPORT virtual ~GeomDataAPI_Point();
  71 };
  72
  73 #endif