Files
create/src/App/FeatureCustom.h
Zheng, Lei f4205130ae App: Property related API changes
Property:

* Extended property status bitset. Mirror most of PropertyType and
  allow dynamic change property type.

* Cache property name and type to improve performance

* Centralize property status change signalling

* Change aboutToSetValue()/hasSetValue() to virtual

* Add new API getFullName() to obtain full quanlified name of the property

AtomicPropertyChangeInterface:

* Allow calling aboutToSetValue()/hasSetValue() when actually changed

PropertyLists:

* Refactor implementation by an abstract class PropertyListBase and a
  template class PropertyListsT, to allow better code reuse.
  PropertyListT is derived from AtomicPropertyChangeInterface to allow
  more efficient change on individual elements.

* All list type property now accept setting python value as a dictionary
  with index as key to set individual element of a list.

* Add touch list for more efficient handling of value changes. The list
  contains the index of changed value. And empty touch list should be
  treated as the entire list is changed. PropertyContainerPy expose this
  functionality with getPropertyTouchList().

PropertyPersistentObject:

* New property to allow dynamic creation of any FreeCAD object derived
  from Base::Persistence, and use it as a property.

DynamicProperty:

* Use boost multi_index_container for efficient property lookup while
  keeping order.

* Modify to be allowed to use in PropertyContainer directly

PropertyContainer:

* Use boost multi_index_container for efficient property lookup while
  keeping order.

* Allow adding/removing dynamic property on all property container

* Modify Save/Restore() to persist property status, and better handle
  transient property which can now be dynamically enabled/disabled per
  object.

* Add new API getFullName() to obtain full quanlified name of the property.
  Implemented by Document, DocumentObject, and also
  ViewProviderDocumentObject if future patch

DocumentObject and FeaturePython are modified to accommondate the
dynamic property changes.

Removed get/setCustomAttribute() implementation from DocumentObjectPy,
and rely on PropertyContainerPy for the implementation, because of the
additional dynamic property support in property container.

Gui::ViewProviderDocumentObject, which is derived from
PropertyContainer, is also modified accordingly
2019-08-17 14:52:09 +02:00

96 lines
3.3 KiB
C++

/***************************************************************************
* Copyright (c) 2015 Werner Mayer <wmayer[at]users.sourceforge.net> *
* *
* This file is part of the FreeCAD CAx development system. *
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Library General Public *
* License as published by the Free Software Foundation; either *
* version 2 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 Library General Public License for more details. *
* *
* You should have received a copy of the GNU Library General Public *
* License along with this library; see the file COPYING.LIB. If not, *
* write to the Free Software Foundation, Inc., 59 Temple Place, *
* Suite 330, Boston, MA 02111-1307, USA *
* *
***************************************************************************/
#ifndef APP_FEATURECUSTOM_H
#define APP_FEATURECUSTOM_H
#include <Base/Writer.h>
#include <App/DocumentObject.h>
namespace App
{
class Property;
/**
* FeatureCustomT is a template class to be used with DocumentObject or
* any of its subclasses as template parameter.
* FeatureCustomT offers a way to add or remove a property at runtime.
* This class is similar to \ref FeaturePythonT with the difference that
* it has no support for in Python written feature classes.
* @author Werner Mayer
*/
template <class FeatureT>
class FeatureCustomT : public FeatureT
{
PROPERTY_HEADER(App::FeatureCustomT<FeatureT>);
public:
FeatureCustomT() {
}
virtual ~FeatureCustomT() {
}
/** @name methods override DocumentObject */
//@{
short mustExecute() const {
return FeatureT::mustExecute();
}
/// recalculate the Feature
virtual DocumentObjectExecReturn *execute(void) {
return FeatureT::execute();
}
/// returns the type name of the ViewProvider
virtual const char* getViewProviderName(void) const {
return FeatureT::getViewProviderName();
}
PyObject *getPyObject(void) {
return FeatureT::getPyObject();
}
void setPyObject(PyObject *obj) {
FeatureT::setPyObject(obj);
}
protected:
virtual void onBeforeChange(const Property* prop) {
FeatureT::onBeforeChange(prop);
}
virtual void onChanged(const Property* prop) {
FeatureT::onChanged(prop);
}
virtual void onDocumentRestored() {
FeatureT::onDocumentRestored();
}
virtual void onSettingDocument() {
FeatureT::onSettingDocument();
}
};
} //namespace App
#endif // APP_FEATURECUSTOM_H