///! Kind of an object in a document
typedef int ObjectKind;
-const ObjectKind KIND_UNKNOWN = 0; ///! Unrecognized object
-const ObjectKind KIND_IMAGE = 1;
-const ObjectKind KIND_POLYLINE = 2;
-const ObjectKind KIND_BATHYMETRY = 3;
-const ObjectKind KIND_ALTITUDE = 4;
-const ObjectKind KIND_IMMERSIBLE_ZONE = 5;
-const ObjectKind KIND_RIVER = 6;
-const ObjectKind KIND_STREAM = 7;
-const ObjectKind KIND_CONFLUENCE = 8;
-const ObjectKind KIND_CHANNEL = 9;
-const ObjectKind KIND_OBSTACLE = 10;
-const ObjectKind KIND_DIGUE = 11;
-const ObjectKind KIND_PROFILE = 12;
-const ObjectKind KIND_PROFILEUZ = 13;
-const ObjectKind KIND_POLYLINEXY = 14;
-const ObjectKind KIND_CALCULATION = 15;
-const ObjectKind KIND_ZONE = 16;
-const ObjectKind KIND_REGION = 17;
-const ObjectKind KIND_VISUAL_STATE = 18;
-const ObjectKind KIND_LAST = KIND_VISUAL_STATE;
+const ObjectKind KIND_UNKNOWN = 0; ///! Unrecognized object
+const ObjectKind KIND_IMAGE = 1;
+const ObjectKind KIND_POLYLINE = 2;
+const ObjectKind KIND_BATHYMETRY = 3;
+const ObjectKind KIND_ALTITUDE = 4;
+const ObjectKind KIND_IMMERSIBLE_ZONE = 5;
+const ObjectKind KIND_RIVER = 6;
+const ObjectKind KIND_STREAM = 7;
+const ObjectKind KIND_CONFLUENCE = 8;
+const ObjectKind KIND_CHANNEL = 9;
+const ObjectKind KIND_OBSTACLE = 10;
+const ObjectKind KIND_DIGUE = 11;
+const ObjectKind KIND_PROFILE = 12;
+const ObjectKind KIND_PROFILEUZ = 13;
+const ObjectKind KIND_POLYLINEXY = 14;
+const ObjectKind KIND_CALCULATION = 15;
+const ObjectKind KIND_ZONE = 16;
+const ObjectKind KIND_REGION = 17;
+const ObjectKind KIND_VISUAL_STATE = 18;
+const ObjectKind KIND_ARTIFICIAL_OBJECT = 19;
+const ObjectKind KIND_NATURAL_OBJECT = 20;
+const ObjectKind KIND_DUMMY_3D = 21;
+const ObjectKind KIND_SHAPES_GROUP = 22;
+const ObjectKind KIND_SPLITTED_GROUP = 23;
+const ObjectKind KIND_STREAM_ALTITUDE = 24;
+const ObjectKind KIND_OBSTACLE_ALTITUDE = 25;
+const ObjectKind KIND_LAST = KIND_OBSTACLE_ALTITUDE;
DEFINE_STANDARD_HANDLE(HYDROData_Entity, MMgt_TShared)
/**
* Returns the name of this object.
*/
- HYDRODATA_EXPORT QString GetName() const;
+ HYDRODATA_EXPORT virtual QString GetName() const;
/**
* Updates the name of this object.
*/
- HYDRODATA_EXPORT void SetName(const QString& theName);
+ HYDRODATA_EXPORT virtual void SetName( const QString& theName );
+
+ /**
+ * Returns the name of this object valid for Python script.
+ */
+ HYDRODATA_EXPORT virtual QString GetObjPyName() const;
/**
* Dump object to Python script representation.
*/
HYDRODATA_EXPORT virtual QVariant GetDataVariant();
+
/**
* Sets the "MustBeUpdated" flag: if object is depended on updated features.
* \param theFlag is true for objects that must be updated, false for up-to-date
*/
- HYDRODATA_EXPORT void SetToUpdate(bool theFlag);
+ HYDRODATA_EXPORT virtual void SetToUpdate( bool theFlag );
/**
* Returns the "MustBeUpdated" flag: is object data must be updated or not
* \returns false if object is up to date
*/
- HYDRODATA_EXPORT bool IsMustBeUpdated() const;
+ HYDRODATA_EXPORT virtual bool IsMustBeUpdated() const;
+
+ /**
+ * Returns flag indicating that object is updateble or not.
+ */
+ HYDRODATA_EXPORT virtual bool CanBeUpdated() const;
+
/**
* Checks is object exists in the data structure.
HYDRODATA_EXPORT virtual void Remove();
/**
- * Returns unique integer identifier of the object (may be used for ordering of objects)
+ * Returns flag indicating that object can be removed or not.
+ * Reimplement this method in class which can't be removed
+ * separately with it parent object.
+ * Base implementaiton returns always TRUE.
*/
- HYDRODATA_EXPORT inline int ID() const {return myLab.Tag();}
+ HYDRODATA_EXPORT virtual bool CanRemove();
/**
* Copies all properties of this to the destinated object.
* Objects must be the same type.
* \param theDestination initialized object (from any document) - target of copying
*/
- HYDRODATA_EXPORT void CopyTo(Handle_HYDROData_Entity theDestination) const;
+ HYDRODATA_EXPORT void CopyTo( const Handle(HYDROData_Entity)& theDestination ) const;
/**
* Returns the label of this object.
*/
- HYDRODATA_EXPORT TDF_Label& Label() {return myLab;}
+ HYDRODATA_EXPORT TDF_Label& Label() { return myLab; }
+
/**
* Returns father object. For object created under root document label
*/
HYDRODATA_EXPORT virtual Handle(HYDROData_Entity) GetFatherObject() const;
+
+ /**
+ * Returns the list of all reference objects of this object.
+ * Base implementation always return empty list.
+ */
+ HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
+
+
protected:
friend class HYDROData_Iterator;
QStringList& theScript,
const Handle(HYDROData_Entity)& theRefObject,
const QString& theMethod ) const;
+
+ bool checkObjectPythonDefinition( MapOfTreatedObjects& theTreatedObjects,
+ QStringList& theScript,
+ const Handle(HYDROData_Entity)& theRefObject ) const;
+
+ void setPythonObjectColor( QStringList& theScript,
+ const QColor& theColor,
+ const QColor& theDefaultColor,
+ const QString& theMethod ) const;
+
+ /**
+ * Dump the initial object creation to a Python script.
+ * You should call it from DumpToPython implementation before
+ * dumping fields of the object.
+ */
+ HYDRODATA_EXPORT virtual QStringList dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const;
+
+ /**
+ * Returns an object type name as a string for dumping to Python.
+ */
+ QString getPyTypeID() const;
+
protected:
Handle(TDataStd_ReferenceList) getReferenceList( const int theTag,