1 // Copyright (C) 2014-2015 EDF-R&D
2 // This library is free software; you can redistribute it and/or
3 // modify it under the terms of the GNU Lesser General Public
4 // License as published by the Free Software Foundation; either
5 // version 2.1 of the License, or (at your option) any later version.
7 // This library is distributed in the hope that it will be useful,
8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10 // Lesser General Public License for more details.
12 // You should have received a copy of the GNU Lesser General Public
13 // License along with this library; if not, write to the Free Software
14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 #ifndef HYDROData_Object_HeaderFile
20 #define HYDROData_Object_HeaderFile
22 #include <HYDROData_Entity.h>
24 DEFINE_STANDARD_HANDLE(HYDROData_Object, HYDROData_Entity)
27 class Handle(HYDROData_IAltitudeObject);
28 class Handle(HYDROData_DummyObject3D);
29 class Handle(HYDROData_ShapesGroup);
31 /**\class HYDROData_Object
32 * \brief The base class for all geometrical objects in the HYDRO module.
35 class HYDROData_Object : public HYDROData_Entity
39 * Enumeration of tags corresponding to the persistent object parameters.
43 DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
46 DataTag_AltitudeObject, ///< reference altitude object
47 DataTag_FillingColor, ///< filling color of geometrical object
48 DataTag_BorderColor, ///< border color of geometrical object
49 DataTag_Object3D, ///< child 3D object
50 DataTag_EdgesGroup, ///< child group objects
51 DataTag_ChildAltitudeObject, ///< child altitude object
52 DataTag_IsSubmersible, ///< the attribute "is submersible"
53 DataTag_MiddleZ, ///< middle Z value of Shape3D
57 DEFINE_STANDARD_RTTI(HYDROData_Object);
60 * Updates the name of this object.
61 * Reimplemented to update the names child groups.
63 HYDRODATA_EXPORT virtual void SetName( const QString& theName );
66 * Update the geometry object.
67 * Call this method whenever you made changes for object data.
69 HYDRODATA_EXPORT virtual void Update();
72 * Returns the list of all reference objects of this object.
74 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
77 * Sets the "MustBeUpdated" flag: if object is depended on updated features.
78 * Reimplemented to update the state of child 3D object.
80 HYDRODATA_EXPORT virtual void SetToUpdate( bool theFlag );
84 * Sets the top(2d projection) shape of the object.
86 HYDRODATA_EXPORT virtual void SetTopShape( const TopoDS_Shape& theShape );
89 * Returns the top shape of the object.
91 HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const = 0;
94 * Sets the 3d shape of the object.
96 HYDRODATA_EXPORT virtual void SetShape3D( const TopoDS_Shape& theShape );
99 * Returns the 3d shape of the object.
101 HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const = 0;
104 * Returns the middle z value of 3D object representation or -9999 if no value.
106 HYDRODATA_EXPORT virtual Standard_Boolean GetMiddleZ( Standard_Real& theMiddleZ ) const;
109 * Set the middle z value of 3D object representation.
111 HYDRODATA_EXPORT virtual void SetMiddleZ( const Standard_Real& theMiddleZ );
114 * Returns reference object which represent the 3D shape of object.
116 HYDRODATA_EXPORT virtual Handle(HYDROData_DummyObject3D) GetObject3D() const;
120 * Returns sequence of object groups.
122 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGroups() const;
125 * Returns group data model object by it id.
127 HYDRODATA_EXPORT virtual Handle(HYDROData_ShapesGroup) GetGroup( const int theGroupId ) const;
130 * Returns group id by data model object.
132 HYDRODATA_EXPORT virtual int GetGroupId( const Handle(HYDROData_ShapesGroup)& theGroup ) const;
136 * Set reference altitude object for geometry object.
138 HYDRODATA_EXPORT virtual bool SetAltitudeObject( const Handle(HYDROData_IAltitudeObject)& theAltitude );
141 * Returns reference altitude object of geometry object.
143 HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) GetAltitudeObject() const;
146 * Clear the reference altitude object for geometry object.
148 HYDRODATA_EXPORT virtual void RemoveAltitudeObject();
152 * Sets filling color for object.
154 HYDRODATA_EXPORT virtual void SetFillingColor( const QColor& theColor );
157 * Returns filling color of object.
159 HYDRODATA_EXPORT virtual QColor GetFillingColor() const;
162 * Sets border color for object.
164 HYDRODATA_EXPORT virtual void SetBorderColor( const QColor& theColor );
167 * Returns border color of object.
169 HYDRODATA_EXPORT virtual QColor GetBorderColor() const;
171 HYDRODATA_EXPORT bool IsSubmersible() const;
172 HYDRODATA_EXPORT void SetIsSubmersible( bool ) const;
177 * Returns default filling color for new object.
179 HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
182 * Returns default border color for new object.
184 HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
189 * Creates new object in the internal data structure. Use higher level objects
190 * to create objects with real content.
192 HYDRODATA_EXPORT HYDROData_Object();
195 * Destructs properties of the object and object itself, removes it from the document.
197 virtual HYDRODATA_EXPORT ~HYDROData_Object();
202 * Dump the initial object creation to a Python script.
203 * Reimplemented to dump the object colors.
205 HYDRODATA_EXPORT virtual QStringList dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const;
209 * Checks and if necessary create child 3D object.
210 * Reimplement this function in your subclass if you
211 * do not want to create child 3D object.
213 HYDRODATA_EXPORT virtual void checkAndSetObject3D();
217 * Returns the type of child altitude object.
218 * Base implementation returns KIND_UNKNOWN, it means that child altitude
219 * object will not be created inside of checkAndSetAltitudeObject() function.
220 * Reimplement this function in your subclass an return correct altitude
221 * object type if you want to create child altitude object.
223 HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
226 * Checks and if necessary create child altitude object.
228 HYDRODATA_EXPORT virtual void checkAndSetAltitudeObject();
231 * Return the child altitude object.
233 HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) getChildAltitudeObject() const;
237 * Create new one child group object.
239 HYDRODATA_EXPORT virtual Handle(HYDROData_ShapesGroup) createGroupObject();
242 * Remove all child group objects.
244 HYDRODATA_EXPORT virtual void removeGroupObjects();
248 * Retrieve the top shape of the object from data label.
250 HYDRODATA_EXPORT TopoDS_Shape getTopShape() const;
253 * Removes the top shape from data label of the object.
255 HYDRODATA_EXPORT void removeTopShape();
259 * Retrieve the 3d shape of the object from data label.
261 HYDRODATA_EXPORT TopoDS_Shape getShape3D() const;
264 * Removes the 3d shape from data label of the object.
266 HYDRODATA_EXPORT void removeShape3D();