6731e83bf5
DocumentObject: * getSubObject(): the most important API for Link to work with hierarchies. The function is a inspired from and replaces the getPySubObjects(). It returns a child object following a dot separated subname reference, and can optionally return accumulated transformation, and/or a python object of the refered sub-object/element. The default implementation here is to look for link type property, and search for the referenced object. This patch also include other specialized implementation of this API, such as (GeoFeature)GroupExtension (through extensionGetSubObject()), PartDesign::Body, and so on. A link type object is expected to call the linked object's getSubObject() for resolving. * getSubObjectList(): helper function to return a list of object referenced in the given subname. * getSubObjects(): return a list of subname references of all children objects. The purpose of this function is similar to ViewProvider::claimChildren(). Container type object is expected to implement this function. The reason it returns subname references instead of just object is to allow the container to skip hierarchies. For example, the Assembly3 container uses this to skip the constraint and element group. * getLinkedObject(), obtain the linked object, and optionally with the accumulated transformation. It is expected to return a linked object or the object itself if it is not a link. In case there are multiple levels of linking involved, this function allows the caller to retrieve the linked object recursively. * hasChildElement(), set/isElementVisible(), controls the children visibility for a group type object. Because the child object may be claimed by other objects, it is essential to have independent control of children visibilities. These APIs are designed to abstract how group manages the child visibility. For performance reason, these function are meant to control only the immediate child object. * resolve(), helper function to parse subname reference and resolve the final object, and optionally the immediate parent of the final object, the final object reference name (for calling `set/isElementVisible()`), and the subname reference if there is one. * touch(), add optional argument 'noRecompute' for better backward compatibility with the NoRecompute flag. By default, touch() causes recompute unless noRecompute is true * signalChanged/signalBeforeChange, two new signal for tracking changes of a specific object. * getViewProviderNameOverride(), return a string of the view provider type of this object. This allows Python class to override the view provider of an object. This feature will be used by ViewProviderLink which is designed to work with any object that has LinkBaseExtension. * canLinkProperties(), will be used by Gui::PropertyView to display linked object properties together with the object's own properties. * redirectSubname(), will be used by Gui::Tree to allow an object to redirect selection to some other object when (pre)selected in the tree view. * Visibility, new property serve as the same purpose as view provider property of the same name. It is added here so that App namespace code can check for visibility without Gui module. This is useful, for example, when constructing a compound shape of a container that respects the children visibility. * (has)hasHiddenMarker(), return or check for a special sub-element name used as marker for overriding sub-object visibility. Will be used by Gui::ViewProvider, it is put here for the same reason as adding Visibility property. * getID(), return object internal identifier. Each object is now assigned an integer identifier that is unique within its containing document. Document: * ShowHidden, new property to tell tree view whether to show hidden object items. * signalTouchedObject, new signal triggered when manually touch an object when calling its touch() function * getObjectByID(), get object by its identifier * addObject() is modified to allow overriding view provider * has/getLinksTo(), helper function to obtain links to a given object. Application: * checkLinkDepth(), helper function to check recursive depth for link traversal. The depth is checked against the total object count of all opened documents. The count (_objCount) is internally updated whenever object is added or removed. * has/getLinksTo(), same as Document::has/getLinksTo() but return links from all opened documents. GroupExtension/OriginGroupExtension/DatumFeature/DatumCS/Part::Feature: implement sepcialized getSubObject/getSubObjects().
87 lines
3.7 KiB
C++
87 lines
3.7 KiB
C++
/***************************************************************************
|
|
* Copyright (c) Alexander Golubev (Fat-Zer) <fatzer2@gmail.com> 2015 *
|
|
* *
|
|
* 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 ORIGINGROUP_H_QHTU73IF
|
|
#define ORIGINGROUP_H_QHTU73IF
|
|
|
|
#include "GeoFeatureGroupExtension.h"
|
|
#include "PropertyLinks.h"
|
|
|
|
namespace App {
|
|
class Origin;
|
|
|
|
/**
|
|
* Represents an abstract placeable group of objects with an associated Origin
|
|
*/
|
|
class AppExport OriginGroupExtension : public App::GeoFeatureGroupExtension
|
|
{
|
|
EXTENSION_PROPERTY_HEADER_WITH_OVERRIDE(App::OriginGroupExtension);
|
|
|
|
public:
|
|
OriginGroupExtension ();
|
|
virtual ~OriginGroupExtension ();
|
|
|
|
/// Returns the origin link or throws an exception
|
|
App::Origin *getOrigin () const;
|
|
|
|
/// returns the type name of the ViewProvider
|
|
virtual const char* getViewProviderName () const {
|
|
return "Gui::ViewProviderOriginGroup";
|
|
}
|
|
|
|
/**
|
|
* Returns the origin group which contains this object.
|
|
* In case this object is not part of any geoFeatureGroup 0 is returned.
|
|
* @param obj the object to search for
|
|
*/
|
|
static DocumentObject* getGroupOfObject (const DocumentObject* obj);
|
|
|
|
/// Returns true on changing OriginFeature set
|
|
virtual short extensionMustExecute () override;
|
|
|
|
/// Origin linked to the group
|
|
PropertyLink Origin;
|
|
|
|
//changes all links of obj to a origin to point to this groupes origin
|
|
void relinkToOrigin(App::DocumentObject* obj);
|
|
|
|
virtual std::vector<DocumentObject*> addObjects(std::vector<DocumentObject*> obj) override;
|
|
virtual bool hasObject(const DocumentObject* obj, bool recursive = false) const override;
|
|
|
|
virtual bool extensionGetSubObject(DocumentObject *&ret, const char *subname, PyObject **pyObj,
|
|
Base::Matrix4D *mat, bool transform, int depth) const override;
|
|
|
|
protected:
|
|
/// Checks integrity of the Origin
|
|
virtual App::DocumentObjectExecReturn *extensionExecute () override;
|
|
/// Creates the corresponding Origin object
|
|
virtual void onExtendedSetupObject () override;
|
|
/// Removes all planes and axis if they are still linked to the document
|
|
virtual void onExtendedUnsetupObject () override;
|
|
};
|
|
|
|
typedef ExtensionPythonT<GroupExtensionPythonT<OriginGroupExtension>> OriginGroupExtensionPython;
|
|
|
|
} /* App */
|
|
|
|
#endif /* end of include guard: ORIGINGROUP_H_QHTU73IF */
|