X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Object.h;h=0d9c067d61b761fd715ad6fd252a190512bbe086;hb=f0cec241aae9ca16d86e166f45cb5c4987d2c792;hp=64240ce38b63a274007d598aea7fc91a8b24cca6;hpb=eab7248fd3b9120041364993091a51af7fc65577;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Object.h b/src/ModelAPI/ModelAPI_Object.h index 64240ce38..0d9c067d6 100644 --- a/src/ModelAPI/ModelAPI_Object.h +++ b/src/ModelAPI/ModelAPI_Object.h @@ -1,33 +1,104 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: ModelAPI_Object.hxx // Created: 19 May 2014 // Author: Mikhail PONIKAROV -#ifndef ModelAPI_Object_HeaderFile -#define ModelAPI_Object_HeaderFile +#ifndef ModelAPI_Object_H_ +#define ModelAPI_Object_H_ + +#include "ModelAPI.h" +#include "ModelAPI_Data.h" +#include "ModelAPI_Entity.h" + +#include -#include "ModelAPI_Feature.h" +class ModelAPI_Data; +class ModelAPI_Document; /**\class ModelAPI_Object * \ingroup DataModel - * \brief Represents the result of some feature in the object browser - * under the specific folder. Just a reference to specific feature-operation - * with possibility to rename it. + * \brief Represents any object in the data model and in the object browser. + * + * It may be feature or result of the feature. User just may set name for it + * or change this name later. Generic class for Feature, Body, Parameter and other + * objects related to the features and their results. Contains attributes of this + * object in the "Data". */ -class ModelAPI_Object : public ModelAPI_Feature +class ModelAPI_Object: public ModelAPI_Entity { -public: + std::shared_ptr myData; ///< manager of the data model of a feature + std::shared_ptr myDoc; ///< document this object belongs to + public: + /// By default object is displayed in the object browser. + 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 + MODELAPI_EXPORT virtual std::shared_ptr data() const; + + /// Returns true if object refers to the same data model instance + MODELAPI_EXPORT virtual bool isSame(const std::shared_ptr& theObject); + + /// Returns document this feature belongs to + MODELAPI_EXPORT virtual std::shared_ptr document() const; + + /// Returns the group identifier of this object + virtual std::string groupName() = 0; + + /// 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; - /// It is never located in history - MODELAPI_EXPORT virtual bool isInHistory() {return false;} + /// Returns the parameters of color definition in the resources config manager + virtual void colorConfigInfo(std::string& theSection, std::string& theName, + std::string& theDefault) {} - /// Reference to the feature-operation that produces this object - MODELAPI_EXPORT virtual boost::shared_ptr featureRef() = 0; + /// 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); - /// Returns the name of this object (by default equal to the name of feature) - MODELAPI_EXPORT virtual std::string getName() = 0; + /// 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); + + 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) + 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 Model_Document; - /// Defines the name of the object - MODELAPI_EXPORT virtual void setName(std::string theName) = 0; }; +typedef std::shared_ptr ObjectPtr; + #endif