ModelAPI_Object.h

// Copyright (C) 2014-2025  CEA, EDF
//
// 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 <memory>
 
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: public ModelAPI_Entity
{
  std::shared_ptr<ModelAPI_Data> myData;  
  std::shared_ptr<ModelAPI_Document> myDoc;  
 public:
#ifdef DEBUG_NAMES
  std::wstring myName; // name of this object
#endif
  MODELAPI_EXPORT virtual bool isInHistory();
 
  MODELAPI_EXPORT virtual void setInHistory(
    const std::shared_ptr<ModelAPI_Object> theObject, const bool theFlag);
 
  MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Data> data() const;
 
  MODELAPI_EXPORT virtual bool isSame(const std::shared_ptr<ModelAPI_Object>& theObject);
 
  MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Document> document() const;
 
  virtual std::string groupName() = 0;
 
  virtual void initAttributes() = 0;
 
  virtual bool isDisabled() = 0;
 
  virtual void colorConfigInfo(std::string& /*theSection*/,
                               std::string& /*theName*/,
                               std::string& /*theDefault*/) {}
 
  MODELAPI_EXPORT virtual void attributeChanged(const std::string& theID);
 
  MODELAPI_EXPORT ModelAPI_Object();
 
  MODELAPI_EXPORT virtual ~ModelAPI_Object();
 
  MODELAPI_EXPORT virtual bool isDisplayed();
 
  MODELAPI_EXPORT virtual void setDisplayed(const bool theDisplay);
 
  MODELAPI_EXPORT virtual bool hasTexture()
  {
    return false;
  }
 
 protected:
  MODELAPI_EXPORT virtual void init() = 0;
 
  MODELAPI_EXPORT virtual void setData(std::shared_ptr<ModelAPI_Data> theData);
 
  MODELAPI_EXPORT virtual void setDoc(std::shared_ptr<ModelAPI_Document> theDoc);
 
  MODELAPI_EXPORT virtual void erase();
 
  friend class Model_Objects;
  friend class ModelAPI_Feature;
  friend class Model_Document;
 
};
 
typedef std::shared_ptr<ModelAPI_Object> ObjectPtr;
 
#endif