X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Object.h;h=c72266b3b1deeedaa3e3da8765f2569e4d7ea665;hb=cf3d083e537c121658d873ff4225cda6b78abd29;hp=2d4838c17252f4feed9cfb8d078d21e0514f01ad;hpb=3da12847434e80669f608d589074a181df87da4e;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Object.h b/src/ModelAPI/ModelAPI_Object.h index 2d4838c17..c72266b3b 100644 --- a/src/ModelAPI/ModelAPI_Object.h +++ b/src/ModelAPI/ModelAPI_Object.h @@ -1,17 +1,37 @@ -// File: ModelAPI_Object.hxx -// Created: 19 May 2014 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2022 CEA/DEN, EDF R&D +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +// #ifndef ModelAPI_Object_H_ #define ModelAPI_Object_H_ #include "ModelAPI.h" +#include "ModelAPI_Data.h" +#include "ModelAPI_Entity.h" -#include +#include class ModelAPI_Data; class ModelAPI_Document; +// sometimes it is useful for debug to see name of each object (bad for memory and performance) +//#define DEBUG_NAMES + /**\class ModelAPI_Object * \ingroup DataModel * \brief Represents any object in the data model and in the object browser. @@ -21,54 +41,90 @@ class ModelAPI_Document; * objects related to the features and their results. Contains attributes of this * object in the "Data". */ -class ModelAPI_Object +class ModelAPI_Object: public ModelAPI_Entity { - boost::shared_ptr myData; ///< manager of the data model of a feature - boost::shared_ptr myDoc; ///< document this object belongs to + std::shared_ptr myData; ///< manager of the data model of a feature + std::shared_ptr myDoc; ///< document this object belongs to public: +#ifdef DEBUG_NAMES + std::wstring myName; // name of this object +#endif /// By default object is displayed in the object browser. - virtual bool isInHistory() - { - return true; - } + MODELAPI_EXPORT virtual bool isInHistory(); + + /// Makes object presented or not in the history of the created objects + /// \param theObject is shared pointer to "this" + /// \param theFlag is boolean value: to add or remove from the history + MODELAPI_EXPORT virtual void setInHistory( + const std::shared_ptr theObject, const bool theFlag); /// Returns the data manager of this object: attributes - virtual boost::shared_ptr data() - { - return myData; - } + MODELAPI_EXPORT virtual std::shared_ptr data() const; /// Returns true if object refers to the same data model instance - virtual bool isSame(const boost::shared_ptr& theObject) - { - return theObject.get() == this; - } + MODELAPI_EXPORT virtual bool isSame(const std::shared_ptr& theObject); /// Returns document this feature belongs to - virtual boost::shared_ptr document() - { - return myDoc; - } + MODELAPI_EXPORT virtual std::shared_ptr document() const; /// Returns the group identifier of this object virtual std::string groupName() = 0; - protected: - /// Sets the data manager of an object (document does) - virtual void setData(boost::shared_ptr theData) + /// Request for initialization of data model of the object: adding all attributes + virtual void initAttributes() = 0; + + /// Returns the feature is disabled or not. + virtual bool isDisabled() = 0; + + /// Returns the parameters of color definition in the resources config manager + virtual void colorConfigInfo(std::string& /*theSection*/, + std::string& /*theName*/, + std::string& /*theDefault*/) {} + + /// Called on change of any argument-attribute of this object + /// \param theID identifier of changed attribute + MODELAPI_EXPORT virtual void attributeChanged(const std::string& theID); + + /// Initializes the default states of the object + MODELAPI_EXPORT ModelAPI_Object(); + + /// To use virtuality for destructors + MODELAPI_EXPORT virtual ~ModelAPI_Object(); + + /// Returns true if object must be displayed in the viewer: flag is stored in the + /// data model, so on undo/redo, open/save or recreation of object by history-playing it keeps + /// the original state in the current transaction. + MODELAPI_EXPORT virtual bool isDisplayed(); + + /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay" + /// signal. + MODELAPI_EXPORT virtual void setDisplayed(const bool theDisplay); + + MODELAPI_EXPORT virtual bool hasTexture() { - myData = theData; + return false; } + protected: + /// This method is called just after creation of the object: it must initialize + /// all fields, normally initialized in the constructor + MODELAPI_EXPORT virtual void init() = 0; + /// Sets the data manager of an object (document does) - virtual void setDoc(boost::shared_ptr theDoc) - { - myDoc = theDoc; - } + MODELAPI_EXPORT virtual void setData(std::shared_ptr theData); + /// Sets the data manager of an object (document does) + MODELAPI_EXPORT virtual void setDoc(std::shared_ptr theDoc); + + /// removes all fields from this feature + MODELAPI_EXPORT virtual void erase(); + + friend class Model_Objects; + friend class ModelAPI_Feature; friend class Model_Document; + }; -typedef boost::shared_ptr ObjectPtr; +typedef std::shared_ptr ObjectPtr; #endif