*/
class HYDROData_Image : public HYDROData_Object
{
+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_TrsfPoints, ///< image transformation points (3 input + 3 output)
+ DataTag_FilePath ///< image imported file path
+ };
+
public:
DEFINE_STANDARD_RTTI(HYDROData_Image);
*/
HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_IMAGE;}
+ /**
+ * Dump Image object to Python script representation.
+ */
+ HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
+
+ /**
+ * Updates object state.
+ * 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.
+ */
+ HYDRODATA_EXPORT virtual void Update();
+
+ /**
+ * Returns data of object wrapped to QVariant.
+ * Reimplemented to wrap and return saved image.
+ * Transformation are applied to result image.
+ */
+ HYDRODATA_EXPORT virtual QVariant GetDataVariant();
+
/**
* Stores the image
* \param theImage new image
*/
HYDRODATA_EXPORT void SetImage(const QImage& theImage);
+ /**
+ * Load the image from file
+ * \param theFilePath path to image
+ */
+ HYDRODATA_EXPORT bool LoadImage(const QString& theFilePath);
+
/**
* Returns the kept image
*/
HYDRODATA_EXPORT QImage Image();
+ /**
+ * Stores the image file path
+ * \param theFilePath image file path
+ */
+ HYDRODATA_EXPORT void SetFilePath(const QString& theFilePath);
+
+ /**
+ * Returns uploaded image file path
+ */
+ HYDRODATA_EXPORT QString GetFilePath() const;
+
/**
* Stores the image transformation
* \param theTrsf new transformation
/**
* Returns the kept transformation, or "identity" if not yet stored
*/
- HYDRODATA_EXPORT QTransform Trsf();
+ HYDRODATA_EXPORT QTransform Trsf() const;
+
+ /**
+ * Stores the image transformation points (3 input + 3 output)
+ * \param thePointAIn input point A
+ * \param thePointBIn input point B
+ * \param thePointCIn input point C
+ * \param thePointAOut output point A
+ * \param thePointBOut output point B
+ * \param thePointCOut output point C
+ */
+ HYDRODATA_EXPORT void SetTrsfPoints(const QPoint& thePointAIn,
+ const QPoint& thePointBIn,
+ const QPoint& thePointCIn,
+ const QPointF& thePointAOut,
+ const QPointF& thePointBOut,
+ const QPointF& thePointCOut);
+
+ /**
+ * Returns the image transformation points (3 input + 3 output)
+ * \param thePointAIn input point A
+ * \param thePointBIn input point B
+ * \param thePointCIn input point C
+ * \param thePointAOut output point A
+ * \param thePointBOut output point B
+ * \param thePointCOut output point C
+ */
+ HYDRODATA_EXPORT void TrsfPoints(QPoint& thePointAIn,
+ QPoint& thePointBIn,
+ QPoint& thePointCIn,
+ QPointF& thePointAOut,
+ QPointF& thePointBOut,
+ QPointF& thePointCOut) const;
+
+ HYDRODATA_EXPORT bool HasTrsfPoints() const;
/**
- * Appends reference to other image.
- * \param theReferenced the image referenced by this
+ * Appends reference to other object (image or polyline).
+ * \param theReferenced the object referenced by this
*/
- HYDRODATA_EXPORT void AppendReference(Handle(HYDROData_Image) theReferenced);
+ HYDRODATA_EXPORT void AppendReference(Handle(HYDROData_Object) theReferenced);
/**
- * Returns the number of referenced images
+ * Returns the number of referenced objects
* \return zero if there is no references
*/
- HYDRODATA_EXPORT int NbReferences();
+ HYDRODATA_EXPORT int NbReferences() const;
/**
* Returns reference by index.
* \param theIndex number of reference [0; NbReference)
- * \returns the referenced image, or Null if index is invalid
+ * \returns the referenced object, or Null if index is invalid
*/
- HYDRODATA_EXPORT Handle(HYDROData_Image) Reference(const int theIndex) const;
+ HYDRODATA_EXPORT Handle(HYDROData_Object) Reference(const int theIndex) const;
/**
* Updates reference by index. If index is one-bigger than \a NbReferences,
* this method appends it to the end (NbReferences is incremented).
* \param theIndex number of reference [0; NbReference]
- * \param theReferenced the image referenced by this
+ * \param theReferenced the object referenced by this
*/
HYDRODATA_EXPORT void ChangeReference(
- const int theIndex, Handle(HYDROData_Image) theReferenced);
+ const int theIndex, Handle(HYDROData_Object) theReferenced);
/**
* Removes reference by index
*/
HYDRODATA_EXPORT void ClearReferences();
+ /**
+ * Stores the operator name
+ * \param theOpName name of the operator that must be executed for image update
+ */
+ HYDRODATA_EXPORT void SetOperatorName(const QString theOpName);
+
+ /**
+ * Returns the operator name
+ * \returns the name of the operator that must be executed for image update
+ */
+ HYDRODATA_EXPORT QString OperatorName() const;
+
+ /**
+ * Stores the operator arguments
+ * \param theArgs array that stores the operator arguments, needed for execution
+ */
+ HYDRODATA_EXPORT void SetArgs(const QByteArray& theArgs);
+
+ /**
+ * Returns the operator arguments
+ * \returns array that stores the operator arguments, needed for execution
+ */
+ 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.
+ * \param theFlag is true for self-splitted image
+ */
+ HYDRODATA_EXPORT void SetIsSelfSplitted(bool theFlag);
+
+ /**
+ * Checks that the image is self-splitted.
+ * \returns true if image is self-splitted
+ */
+ HYDRODATA_EXPORT bool IsSelfSplitted() const;
+
protected:
friend class HYDROData_Iterator;