1 #ifndef HYDROData_Object_HeaderFile
2 #define HYDROData_Object_HeaderFile
6 #include <NCollection_Sequence.hxx>
7 #include <TDF_Label.hxx>
11 ///! Kind of an object in a document
12 typedef int ObjectKind;
13 ///! Unrecognized object
14 const ObjectKind KIND_UNKNOWN = 0;
15 const ObjectKind KIND_IMAGE = 1;
16 const ObjectKind KIND_POLYLINE = 2;
17 const ObjectKind KIND_VISUAL_STATE = 3;
18 const ObjectKind KIND_BATHYMETRY = 4;
20 DEFINE_STANDARD_HANDLE(HYDROData_Object, MMgt_TShared)
22 /**\class HYDROData_Object
23 * \brief Generic class of any object in the data model.
25 * Interface for getting access to the object that belong to the data model.
26 * Managed by Document. Provides access to the common properties:
27 * kind of an object, name.
29 class HYDROData_Object : public MMgt_TShared
33 * Enumeration of tags corresponding to the persistent object parameters.
37 DataTag_First = 0, ///< first tag, to reserve
38 DataTag_ViewId, ///< visual state, array of view ids
39 DataTag_Visibility, ///< visual state, array of visibility states
40 DataTag_Transparency, ///< visual state, array of transparency values
41 DataTag_ZValue ///< visual state, array of z-values
53 VisualState() : Visibility( false ), Transparency( 1.0 ), ZValue( 0.0 ) {}
55 typedef QMap < int, VisualState > ViewId2VisualStateMap;
56 typedef QMapIterator< int, VisualState > ViewId2VisualStateMapIterator;
59 DEFINE_STANDARD_RTTI(HYDROData_Object);
62 * Returns the kind of this object. Must be redefined in all objects of known type.
64 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_UNKNOWN;}
67 * Returns the name of this object.
69 HYDRODATA_EXPORT QString GetName() const;
72 * Updates the name of this object.
74 HYDRODATA_EXPORT void SetName(const QString& theName);
77 * Returns the object visibility state for the view with specified id.
78 * \param theViewId view id
79 * \returns visibility state
81 HYDRODATA_EXPORT bool IsVisible( const int theViewId ) const;
84 * Sets the object visibility state for the view with specified id.
85 * \param theViewId view id
86 * \param theVal visibility state
88 HYDRODATA_EXPORT void SetVisible( const int theViewId,
92 * Checks is object exists in the data structure.
93 * \returns true is object is not exists in the data model
95 HYDRODATA_EXPORT bool IsRemoved() const;
98 * Removes object from the data structure.
100 HYDRODATA_EXPORT void Remove();
103 * Returns unique integer identifier of the object (may be used for ordering of objects)
105 HYDRODATA_EXPORT inline int ID() const {return myLab.Tag();}
108 * Copies all properties of this to the destinated object.
109 * Objects must be the same type.
110 * \param theDestination initialized object (from any document) - target of copying
112 HYDRODATA_EXPORT void CopyTo(Handle_HYDROData_Object theDestination) const;
115 * Returns the label of this object.
117 HYDRODATA_EXPORT TDF_Label& Label() {return myLab;}
121 friend class HYDROData_Iterator;
124 * Creates new object in the internal data structure. Use higher level objects
125 * to create objects with real content.
127 HYDRODATA_EXPORT HYDROData_Object();
130 * Destructs properties of the object and object itself, removes it from the document.
132 virtual HYDRODATA_EXPORT ~HYDROData_Object();
135 * Put the object to the label of the document.
136 * \param theLabel new label of the object
138 HYDRODATA_EXPORT virtual void SetLabel(TDF_Label theLabel);
141 * Internal method that used to store the byte array attribute
142 * \param theTag tag of a label to store attribute (for 0 this is myLab)
143 * \param theData pointer to bytes array
144 * \param theLen number of bytes in byte array that must be stored
146 void SaveByteArray(const int theTag, const char* theData, const int theLen);
149 * Internal method that used to retreive the content of byte array attribute
150 * \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
151 * \param theLen number of bytes in byte array
152 * \returns pointer to the internal data structure wit harray content,
153 * or NULL if array size is zero
155 const char* ByteArray(const int theTag, int& theLen);
158 * Returns the map containing the visual states for the specified views.
159 * \param theMap map of visual states
161 void GetViewId2VisualStateMap( ViewId2VisualStateMap& theMap ) const;
164 * Sets the map containing the visual states for the specified views.
165 * \param theMap map of visual states
167 void SetViewId2VisualStateMap( const ViewId2VisualStateMap& theMap );
170 /// Array of pointers to the properties of this object; index in this array is returned by \a AddProperty.
171 TDF_Label myLab; ///< label of this object
174 typedef NCollection_Sequence<Handle_HYDROData_Object> HYDROData_SequenceOfObjects;
176 ///! Is Equal for HYDROData_Object mapping
177 HYDRODATA_EXPORT bool IsEqual(const Handle_HYDROData_Object& theObj1, const Handle_HYDROData_Object& theObj2);