Files
create/src/Gui/ViewProviderDocumentObjectPyImp.cpp
Zheng, Lei cd7725227f ViewProvider(DocumentObject): new APIs for context aware selection
Context aware selection makes it possible to select the same Coin3D node
in different hierarchies (i.e. context) without ambiguity.

New/modified APIs in ViewProvider (the first two are the most crucial
APIs for context aware selection to work):

* getElementPicked(), supercedes getElement(). Given a Coin3D pick
  point, this function returns a dot separated subname reference as a
  path leads to the selected object.

* getDetailPath(), supercedes getDetail(). Given a subname reference,
  this function returns an SoFullPath leads to the Coin3D node of the
  selected object or sub-element (with SoDetail).

* (has)HiddenMarker(), check/return a special text marker for context
  aware override of object visibility.

* partialRender(), render only part of the object based on given
  subname references. It can render, e.g. some faces of a solid, or
  some children of a container. It uses the 'secondary' extension of
  SoSelectionElementAction to select which elements to render or hide.
  The actually rendering functionality will be added in the following
  patch.

* update()/onChanged(), modified to sync Visibility property from
  DocumentObject.

* useNewSelectionModel(), modified to return the default true view
  parameter. This is for test in the early stage of Link development,
  probably not needed anymore.

* getBoundingBox(), a convenience function to obtain the bounding box
  of a sub-object/element regardless of object's visibility. It uses
  getDetailPath() and SoGetBoundingBoxAction to obtain bounding box
  through Coin3D. It will be used in later sub-element box selection
  functionality.

New/modified APIs in ViewProviderDocumentObject:

* getElementPicked()/getDetailPath() provides actual implementation to
  support container like (sub)object selection without ambiguity. It
  relies on DocumentObject::getSubObject() to walk the path.

* reattach(), called when undo deleteion

* forceUpdate()/isUpdateForced(), force update even if object is
  invisible. These are used by Link to force update the visual of a
  linked object regardless of its visibility.

* getLinkedViewProvider(), return the linked view provider with
  hierarchy.

ViewProviderDocumentObjectPy:

* Object attribute is made writtable. Assigning it is equaivalant of
  calling ViewProviderDocumentObject::attach() in Python.
2019-08-17 14:52:10 +02:00

101 lines
4.0 KiB
C++

/***************************************************************************
* Copyright (c) 2008 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 *
* *
***************************************************************************/
#include "PreCompiled.h"
#ifndef _PreComp_
# include <sstream>
#endif
#include <Gui/ViewProviderDocumentObject.h>
#include <Gui/Document.h>
#include <App/DocumentObjectPy.h>
// inclusion of the generated files (generated out of ViewProviderDocumentObjectPy.xml)
#include "ViewProviderDocumentObjectPy.h"
#include "ViewProviderDocumentObjectPy.cpp"
using namespace Gui;
// returns a string which represents the object e.g. when printed in python
std::string ViewProviderDocumentObjectPy::representation(void) const
{
std::stringstream str;
str << "<View provider object at " << getViewProviderDocumentObjectPtr() << ">";
return str.str();
}
PyObject* ViewProviderDocumentObjectPy::update(PyObject *args)
{
if (!PyArg_ParseTuple(args, "")) // convert args: Python->C
return NULL; // NULL triggers exception
PY_TRY {
getViewProviderDocumentObjectPtr()->updateView();
Py_Return;
} PY_CATCH;
}
Py::Object ViewProviderDocumentObjectPy::getObject(void) const
{
App::DocumentObject* obj = getViewProviderDocumentObjectPtr()->getObject();
return Py::Object(obj->getPyObject(), true); // do not inc'ref twice
}
void ViewProviderDocumentObjectPy::setObject(Py::Object pyobj)
{
if(!PyObject_TypeCheck(*pyobj,&App::DocumentObjectPy::Type))
throw Py::TypeError("Expect document object");
App::DocumentObject* obj = getViewProviderDocumentObjectPtr()->getObject();
if(obj)
throw Py::RuntimeError("View object already attached");
getViewProviderDocumentObjectPtr()->attach(
static_cast<App::DocumentObjectPy*>(*pyobj)->getDocumentObjectPtr());
}
Py::Boolean ViewProviderDocumentObjectPy::getForceUpdate() const
{
return Py::Boolean(getViewProviderDocumentObjectPtr()->isUpdateForced());
}
void ViewProviderDocumentObjectPy::setForceUpdate(Py::Boolean arg)
{
getViewProviderDocumentObjectPtr()->forceUpdate(arg);
}
Py::Object ViewProviderDocumentObjectPy::getDocument(void) const
{
Document* doc = getViewProviderDocumentObjectPtr()->getDocument();
return Py::asObject(doc->getPyObject()); // do not inc'ref twice
}
PyObject *ViewProviderDocumentObjectPy::getCustomAttributes(const char* /*attr*/) const
{
return 0;
}
int ViewProviderDocumentObjectPy::setCustomAttributes(const char* /*attr*/, PyObject* /*obj*/)
{
return 0;
}