Salome HOME
Update flag for calculation case during polyline changing.
[modules/hydro.git] / src / HYDROData / HYDROData_Image.h
index ad5984128e3c8c4d3e1d03a28b7a7b0cf6ea8a5b..90dec9c3210a6cba816ac85c1825ddb53e46b65c 100644 (file)
@@ -1,12 +1,13 @@
+
 #ifndef HYDROData_Image_HeaderFile
 #define HYDROData_Image_HeaderFile
 
-#include <HYDROData_Object.h>
+#include <HYDROData_Entity.h>
 
 #include <QImage>
 #include <QTransform>
 
-DEFINE_STANDARD_HANDLE(HYDROData_Image, HYDROData_Object)
+DEFINE_STANDARD_HANDLE(HYDROData_Image, HYDROData_Entity)
 
 /**\class HYDROData_Image
  * \brief Class that stores/retreives information about the image.
@@ -14,19 +15,30 @@ DEFINE_STANDARD_HANDLE(HYDROData_Image, HYDROData_Object)
  * Keeps image as binary array, transformation and other properties
  * of image with correspondent API for forkind wit hthese properties.
  */
-class HYDROData_Image : public HYDROData_Object
+class HYDROData_Image : public HYDROData_Entity
 {
+
+public:
+
+  enum TransformationMode
+  {
+    ManualGeodesic = 0,
+    ManualCartesian,
+    ReferenceImage
+  };
+
 protected:
   /**
    * Enumeration of tags corresponding to the persistent object parameters.
    */
   enum DataTag
   {
-    DataTag_First = HYDROData_Object::DataTag_First + 100, ///< first tag, to reserve
-    DataTag_Operator,    ///< name of the operator that must be executed for image update
-    DataTag_TrsfMode,    ///< transformation mode (0 - Lambert93, 1 - Cartesian)
-    DataTag_TrsfPoints,  ///< image transformation points (3 input + 3 output lambert + 3 output cartesian)
-    DataTag_FilePath     ///< image imported file path
+    DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
+    DataTag_Operator,        ///< name of the operator that must be executed for image update
+    DataTag_TrsfMode,        ///< transformation mode (0 - Lambert93, 1 - Cartesian, 2 - on other Image)
+    DataTag_TrsfPoints,      ///< image transformation points 
+    DataTag_TrsfImage,      ///< reference transformation image
+    DataTag_FilePath         ///< image imported file path
   };
 
 public:
@@ -47,9 +59,8 @@ public:
    * Reimplemented to update an Image object in the data structure.
    * Call this method whenever you made changes for operator or reference objects.
    * If it is changed, sets "MustBeUpdated" flag to other depended images.
-   * \param theIsForce force reupdating of data object
    */
-  HYDRODATA_EXPORT virtual void Update( const bool theIsForce = true );
+  HYDRODATA_EXPORT virtual void Update();
 
   /**
    * Returns data of object wrapped to QVariant.
@@ -98,69 +109,148 @@ public:
   HYDRODATA_EXPORT QTransform Trsf() const;
 
   /**
-   * Stores the image transformation points (3 input + 3 output)
-   * \param thePointA input point A
-   * \param thePointB input point B
-   * \param thePointC input point C
-   * \param theLambertPointA output point A in Lambert93 coordinates
-   * \param theLambertPointB output point B in Lambert93 coordinates
-   * \param theLambertPointC output point C in Lambert93 coordinates
-   * \param theCartesianPointA output point A in Cartesian coordinates
-   * \param theCartesianPointB output point B in Cartesian coordinates
-   * \param theCartesianPointC output point C in Cartesian coordinates
+   * Updates the matrix of transformation in accordance with reference points.
+   * \param theTrsf new transformation
    */
-  HYDRODATA_EXPORT void SetTrsfPoints(const QPoint& thePointA,
-                                      const QPoint& thePointB,
-                                      const QPoint& thePointC,
-                                      const QPointF& theLambertPointA,
-                                      const QPointF& theLambertPointB,
-                                      const QPointF& theLambertPointC,
-                                      const QPointF& theCartesianPointA,
-                                      const QPointF& theCartesianPointB,
-                                      const QPointF& theCartesianPointC);
+  HYDRODATA_EXPORT void UpdateTrsf();
+
 
   /**
-   * Returns the image transformation points (3 input + 3 output)
-   * \param thePointA input point A
-   * \param thePointB input point B
-   * \param thePointC input point C
-   * \param theLambertPointA output point A in Lambert93 coordinates
-   * \param theLambertPointB output point B in Lambert93 coordinates
-   * \param theLambertPointC output point C in Lambert93 coordinates
-   * \param theCartesianPointA output point A in Cartesian coordinates
-   * \param theCartesianPointB output point B in Cartesian coordinates
-   * \param theCartesianPointC output point C in Cartesian coordinates
+   * Returns true if transformation is done by two points only
    */
-  HYDRODATA_EXPORT void TrsfPoints(QPoint& thePointA,
-                                   QPoint& thePointB,
-                                   QPoint& thePointC,
-                                   QPointF& theLambertPointA,
-                                   QPointF& theLambertPointB,
-                                   QPointF& theLambertPointC,
-                                   QPointF& theCartesianPointA,
-                                   QPointF& theCartesianPointB,
-                                   QPointF& theCartesianPointC) const;
+  HYDRODATA_EXPORT bool IsByTwoPoints() const;
+
 
   /**
-   * Returns true if the image has stored transformation points
+   * Removes all references from this image.
    */
-  HYDRODATA_EXPORT bool HasTrsfPoints() const;
+  HYDRODATA_EXPORT bool HasReferences() const;
 
   /**
-   * Stores the transformation mode (0 - Lambert93, 1 - Cartesian)
+   * Removes all references from this image.
    */
-  HYDRODATA_EXPORT void SetTrsfMode(const int theMode);
+  HYDRODATA_EXPORT void RemoveAllReferences();
+
 
   /**
-   * Returns the transformation mode (0 - Lambert93, 1 - Cartesian)
+   * Stores the transformation points in local cs of image
+   * \param thePointA point A
+   * \param thePointB point B
+   * \param thePointC point C
    */
-  HYDRODATA_EXPORT int TrsfMode() const;
+  HYDRODATA_EXPORT void SetLocalPoints( const QPoint& thePointA,
+                                        const QPoint& thePointB,
+                                        const QPoint& thePointC = QPoint( INT_MIN, INT_MIN ),
+                                        const bool    theIsUpdate = true );
 
   /**
-   * Appends reference to other object (image or polyline).
-   * \param theReferenced the object referenced by this
+   * Returns the transformation points in local cs of image
+   * \param thePointA point A
+   * \param thePointB point B
+   * \param thePointC point C
+   * \return true if all parameters has been set before
+   */
+  HYDRODATA_EXPORT bool GetLocalPoints( QPoint& thePointA,
+                                        QPoint& thePointB,
+                                        QPoint& thePointC ) const;
+
+  /**
+   * Returns true if local points has been set before
+   */
+  HYDRODATA_EXPORT bool HasLocalPoints() const;
+
+
+  /**
+   * Stores the transformation points in global cs
+   * \param theMode transformation mode
+   * \param thePointA point A
+   * \param thePointB point B
+   * \param thePointC point C
    */
-  HYDRODATA_EXPORT void AppendReference( const Handle(HYDROData_Object)& theReferenced );
+  HYDRODATA_EXPORT void SetGlobalPoints( const TransformationMode& theMode,
+                                         const QPointF&            thePointA,
+                                         const QPointF&            thePointB,
+                                         const QPointF&            thePointC = QPoint( INT_MIN, INT_MIN ),
+                                         const bool                theIsUpdate = true  );
+
+  /**
+   * Returns the transformation points in global cs
+   * \param theMode transformation mode
+   * \param thePointA point A
+   * \param thePointB point B
+   * \param thePointC point C
+   * \return true if all parameters has been set before
+   */
+  HYDRODATA_EXPORT bool GetGlobalPoints( TransformationMode& theMode,
+                                         QPointF&            thePointA,
+                                         QPointF&            thePointB,
+                                         QPointF&            thePointC ) const;
+
+  /**
+   * Returns true if global points has been set before
+   */
+  HYDRODATA_EXPORT bool HasGlobalPoints() const;
+
+
+  /**
+   * Stores the transformation points in reference image local cs
+   * \param theRefImage reference image
+   * \param thePointA point A
+   * \param thePointB point B
+   * \param thePointC point C
+   */
+  HYDRODATA_EXPORT void SetReferencePoints( const Handle(HYDROData_Image)& theRefImage,
+                                            const QPointF&                 thePointA,
+                                            const QPointF&                 thePointB,
+                                            const QPointF&                 thePointC = QPoint( INT_MIN, INT_MIN ),
+                                            const bool                     theIsUpdate = true );
+
+  /**
+   * Returns the transformation points in reference image local cs
+   * \param theRefImage reference image
+   * \param thePointA point A
+   * \param thePointB point B
+   * \param thePointC point C
+   * \return true if all parameters has been set correctly
+   */
+  HYDRODATA_EXPORT bool GetReferencePoints( Handle(HYDROData_Image)& theRefImage,
+                                            QPointF&                 thePointA,
+                                            QPointF&                 thePointB,
+                                            QPointF&                 thePointC ) const;
+
+  /**
+   * Returns true if reference points has been set before
+   */
+  HYDRODATA_EXPORT bool HasReferencePoints() const;
+
+
+  /**
+   * Stores the reference image for transformation
+   * \param theRefImage reference image
+   */
+  HYDRODATA_EXPORT void SetTrsfReferenceImage( const Handle(HYDROData_Image)& theRefImage );
+
+  /**
+   * Returns the reference image for transformation
+   */
+  HYDRODATA_EXPORT Handle(HYDROData_Image) GetTrsfReferenceImage() const;
+
+  /**
+   * Removes the reference image for transformation
+   */
+  HYDRODATA_EXPORT void RemoveTrsfReferenceImage();
+
+
+  /**
+   * Stores the transformation mode
+   */
+  HYDRODATA_EXPORT void SetTrsfMode( const TransformationMode& theMode );
+
+  /**
+   * Returns the transformation mode
+   */
+  HYDRODATA_EXPORT TransformationMode GetTrsfMode() const;
+
 
   /**
    * Returns the number of referenced objects
@@ -168,12 +258,18 @@ public:
    */
   HYDRODATA_EXPORT int NbReferences() const;
 
+  /**
+   * Appends reference to other object (image or polyline).
+   * \param theReferenced the object referenced by this
+   */
+  HYDRODATA_EXPORT void AppendReference( const Handle(HYDROData_Entity)& theReferenced );
+
   /**
    * Returns reference by index.
    * \param theIndex number of reference [0; NbReference)
    * \returns the referenced object, or Null if index is invalid
    */
-  HYDRODATA_EXPORT Handle(HYDROData_Object) Reference(const int theIndex) const;
+  HYDRODATA_EXPORT Handle(HYDROData_Entity) Reference(const int theIndex) const;
 
   /**
    * Updates reference by index. If index is one-bigger than \a NbReferences, 
@@ -182,7 +278,7 @@ public:
    * \param theReferenced the object referenced by this
    */
   HYDRODATA_EXPORT void ChangeReference(
-    const int theIndex, Handle(HYDROData_Object) theReferenced);
+    const int theIndex, Handle(HYDROData_Entity) theReferenced);
 
   /**
    * Removes reference by index
@@ -195,6 +291,7 @@ public:
    */
   HYDRODATA_EXPORT void ClearReferences();
 
+
   /**
    * Stores the operator name
    * \param theOpName name of the operator that must be executed for image update
@@ -219,17 +316,6 @@ public:
    */
   HYDRODATA_EXPORT QByteArray Args() const;
   
-  /**
-   * Sets the "MustBeUpdated" flag: if image is depended on updated features.
-   * \param theFlag is true for images that must be updated, false for up-to-date
-   */
-  HYDRODATA_EXPORT void MustBeUpdated(bool theFlag);
-
-  /**
-   * Returns the "MustBeUpdated" flag: is image must be recomputed or not
-   * \returns false if image is up to date
-   */
-  HYDRODATA_EXPORT bool MustBeUpdated() const;
 
   /**
    * Marks the image as self-splitted.
@@ -243,6 +329,12 @@ public:
    */
   HYDRODATA_EXPORT bool IsSelfSplitted() const;
 
+private:
+
+  QPointF generateThirdPoint( const QPointF& thePointA,
+                              const QPointF& thePointB,
+                              const bool&    theIsLocal ) const;
+
 protected:
 
   friend class HYDROData_Iterator;