1008 lines
31 KiB
C++
1008 lines
31 KiB
C++
/***************************************************************************
|
|
* Copyright (c) 2007 Jürgen Riegel <juergen.riegel@web.de> *
|
|
* *
|
|
* 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"
|
|
|
|
#include <Base/GeometryPyCXX.h>
|
|
#include <Base/MatrixPy.h>
|
|
#include <Base/PyWrapParseTupleAndKeywords.h>
|
|
|
|
#include "DocumentObject.h"
|
|
#include "Document.h"
|
|
#include "ExpressionParser.h"
|
|
#include "GeoFeature.h"
|
|
#include "GeoFeatureGroupExtension.h"
|
|
#include "GroupExtension.h"
|
|
|
|
|
|
// inclusion of the generated files (generated out of DocumentObjectPy.xml)
|
|
#include <App/DocumentObjectPy.h>
|
|
#include <App/DocumentObjectPy.cpp>
|
|
|
|
using namespace App;
|
|
|
|
// returns a string which represent the object e.g. when printed in python
|
|
std::string DocumentObjectPy::representation() const
|
|
{
|
|
DocumentObject* object = this->getDocumentObjectPtr();
|
|
std::stringstream str;
|
|
str << "<" << object->getTypeId().getName() << " object>";
|
|
return str.str();
|
|
}
|
|
|
|
Py::Object DocumentObjectPy::getName() const
|
|
{
|
|
DocumentObject* object = this->getDocumentObjectPtr();
|
|
const char* internal = object->getNameInDocument();
|
|
if (!internal) {
|
|
return Py::None();
|
|
}
|
|
return Py::String(internal);
|
|
}
|
|
|
|
Py::String DocumentObjectPy::getFullName() const
|
|
{
|
|
return {getDocumentObjectPtr()->getFullName()};
|
|
}
|
|
|
|
Py::Object DocumentObjectPy::getDocument() const
|
|
{
|
|
DocumentObject* object = this->getDocumentObjectPtr();
|
|
Document* doc = object->getDocument();
|
|
if (!doc) {
|
|
return Py::None();
|
|
}
|
|
else {
|
|
return Py::Object(doc->getPyObject(), true);
|
|
}
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::isAttachedToDocument(PyObject* args)
|
|
{
|
|
if (!PyArg_ParseTuple(args, "")) {
|
|
return nullptr;
|
|
}
|
|
|
|
DocumentObject* object = this->getDocumentObjectPtr();
|
|
bool ok = object->isAttachedToDocument();
|
|
return Py::new_reference_to(Py::Boolean(ok));
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::addProperty(PyObject* args, PyObject* kwd)
|
|
{
|
|
char *sType, *sName = nullptr, *sGroup = nullptr, *sDoc = nullptr;
|
|
short attr = 0;
|
|
std::string sDocStr;
|
|
PyObject *ro = Py_False, *hd = Py_False;
|
|
PyObject* enumVals = nullptr;
|
|
const std::array<const char*, 9> kwlist {"type",
|
|
"name",
|
|
"group",
|
|
"doc",
|
|
"attr",
|
|
"read_only",
|
|
"hidden",
|
|
"enum_vals",
|
|
nullptr};
|
|
if (!Base::Wrapped_ParseTupleAndKeywords(args,
|
|
kwd,
|
|
"ss|sethO!O!O",
|
|
kwlist,
|
|
&sType,
|
|
&sName,
|
|
&sGroup,
|
|
"utf-8",
|
|
&sDoc,
|
|
&attr,
|
|
&PyBool_Type,
|
|
&ro,
|
|
&PyBool_Type,
|
|
&hd,
|
|
&enumVals)) {
|
|
return nullptr;
|
|
}
|
|
|
|
if (sDoc) {
|
|
sDocStr = sDoc;
|
|
PyMem_Free(sDoc);
|
|
}
|
|
|
|
Property* prop = getDocumentObjectPtr()->addDynamicProperty(sType,
|
|
sName,
|
|
sGroup,
|
|
sDocStr.c_str(),
|
|
attr,
|
|
Base::asBoolean(ro),
|
|
Base::asBoolean(hd));
|
|
|
|
// enum support
|
|
auto* propEnum = dynamic_cast<App::PropertyEnumeration*>(prop);
|
|
if (propEnum && enumVals) {
|
|
propEnum->setPyObject(enumVals);
|
|
}
|
|
|
|
return Py::new_reference_to(this);
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::removeProperty(PyObject* args)
|
|
{
|
|
char* sName;
|
|
if (!PyArg_ParseTuple(args, "s", &sName)) {
|
|
return nullptr;
|
|
}
|
|
|
|
bool ok = getDocumentObjectPtr()->removeDynamicProperty(sName);
|
|
return Py_BuildValue("O", (ok ? Py_True : Py_False));
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::supportedProperties(PyObject* args)
|
|
{
|
|
if (!PyArg_ParseTuple(args, "")) {
|
|
return nullptr;
|
|
}
|
|
|
|
std::vector<Base::Type> ary;
|
|
Base::Type::getAllDerivedFrom(App::Property::getClassTypeId(), ary);
|
|
Py::List res;
|
|
for (auto& it : ary) {
|
|
Base::BaseClass* data = static_cast<Base::BaseClass*>(it.createInstance());
|
|
if (data) {
|
|
delete data;
|
|
res.append(Py::String(it.getName()));
|
|
}
|
|
}
|
|
return Py::new_reference_to(res);
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::touch(PyObject* args)
|
|
{
|
|
char* propName = nullptr;
|
|
if (!PyArg_ParseTuple(args, "|s", &propName)) {
|
|
return nullptr;
|
|
}
|
|
if (propName) {
|
|
if (!propName[0]) {
|
|
getDocumentObjectPtr()->touch(true);
|
|
Py_Return;
|
|
}
|
|
auto prop = getDocumentObjectPtr()->getPropertyByName(propName);
|
|
if (!prop) {
|
|
throw Py::RuntimeError("Property not found");
|
|
}
|
|
prop->touch();
|
|
Py_Return;
|
|
}
|
|
|
|
getDocumentObjectPtr()->touch();
|
|
Py_Return;
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::purgeTouched(PyObject* args)
|
|
{
|
|
if (!PyArg_ParseTuple(args, "")) {
|
|
return nullptr;
|
|
}
|
|
getDocumentObjectPtr()->purgeTouched();
|
|
Py_Return;
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::enforceRecompute(PyObject* args)
|
|
{
|
|
if (!PyArg_ParseTuple(args, "")) {
|
|
return nullptr;
|
|
}
|
|
getDocumentObjectPtr()->enforceRecompute();
|
|
Py_Return;
|
|
}
|
|
|
|
Py::List DocumentObjectPy::getState() const
|
|
{
|
|
DocumentObject* object = this->getDocumentObjectPtr();
|
|
Py::List list;
|
|
bool uptodate = true;
|
|
if (object->isTouched()) {
|
|
uptodate = false;
|
|
list.append(Py::String("Touched"));
|
|
}
|
|
if (object->isError()) {
|
|
uptodate = false;
|
|
list.append(Py::String("Invalid"));
|
|
}
|
|
if (object->isRecomputing()) {
|
|
uptodate = false;
|
|
list.append(Py::String("Recompute"));
|
|
}
|
|
if (object->testStatus(App::Recompute2)) {
|
|
list.append(Py::String("Recompute2"));
|
|
}
|
|
if (object->isRestoring()) {
|
|
uptodate = false;
|
|
list.append(Py::String("Restore"));
|
|
}
|
|
if (object->testStatus(App::Expand)) {
|
|
list.append(Py::String("Expanded"));
|
|
}
|
|
if (object->testStatus(App::PartialObject)) {
|
|
list.append(Py::String("Partial"));
|
|
}
|
|
if (object->testStatus(App::ObjImporting)) {
|
|
list.append(Py::String("Importing"));
|
|
}
|
|
if (uptodate) {
|
|
list.append(Py::String("Up-to-date"));
|
|
}
|
|
return list;
|
|
}
|
|
|
|
Py::Object DocumentObjectPy::getViewObject() const
|
|
{
|
|
try {
|
|
PyObject* dict = PySys_GetObject("modules");
|
|
if (!dict) {
|
|
return Py::None();
|
|
}
|
|
|
|
// check if the FreeCADGui module is already loaded, if not then don't try to load it
|
|
Py::Dict sysmod(dict);
|
|
if (!sysmod.hasKey("FreeCADGui")) {
|
|
return Py::None();
|
|
}
|
|
|
|
// double-check that the module doesn't have a null pointer
|
|
Py::Module module(PyImport_ImportModule("FreeCADGui"), true);
|
|
if (module.isNull() || !module.hasAttr("getDocument")) {
|
|
// in v0.14+, the GUI module can be loaded in console mode (but doesn't have all its
|
|
// document methods)
|
|
return Py::None();
|
|
}
|
|
if (!getDocumentObjectPtr()->getDocument()) {
|
|
throw Py::RuntimeError("Object has no document");
|
|
}
|
|
const char* internalName = getDocumentObjectPtr()->getNameInDocument();
|
|
if (!internalName) {
|
|
throw Py::RuntimeError("Object has been removed from document");
|
|
}
|
|
|
|
Py::Callable method(module.getAttr("getDocument"));
|
|
Py::Tuple arg(1);
|
|
arg.setItem(0, Py::String(getDocumentObjectPtr()->getDocument()->getName()));
|
|
Py::Object doc = method.apply(arg);
|
|
method = doc.getAttr("getObject");
|
|
arg.setItem(0, Py::String(internalName));
|
|
Py::Object obj = method.apply(arg);
|
|
return obj;
|
|
}
|
|
catch (Py::Exception& e) {
|
|
if (PyErr_ExceptionMatches(PyExc_ImportError)) {
|
|
// the GUI is not up, hence None is returned
|
|
e.clear();
|
|
return Py::None();
|
|
}
|
|
// FreeCADGui is loaded, so there must be wrong something else
|
|
throw; // re-throw
|
|
}
|
|
}
|
|
|
|
Py::List DocumentObjectPy::getInList() const
|
|
{
|
|
Py::List ret;
|
|
std::vector<DocumentObject*> list = getDocumentObjectPtr()->getInList();
|
|
|
|
for (auto It : list) {
|
|
ret.append(Py::Object(It->getPyObject(), true));
|
|
}
|
|
|
|
return ret;
|
|
}
|
|
|
|
Py::List DocumentObjectPy::getInListRecursive() const
|
|
{
|
|
Py::List ret;
|
|
try {
|
|
std::vector<DocumentObject*> list = getDocumentObjectPtr()->getInListRecursive();
|
|
|
|
for (auto It : list) {
|
|
ret.append(Py::Object(It->getPyObject(), true));
|
|
}
|
|
}
|
|
catch (const Base::Exception& e) {
|
|
throw Py::IndexError(e.what());
|
|
}
|
|
return ret;
|
|
}
|
|
|
|
Py::List DocumentObjectPy::getOutList() const
|
|
{
|
|
Py::List ret;
|
|
std::vector<DocumentObject*> list = getDocumentObjectPtr()->getOutList();
|
|
|
|
for (auto It : list) {
|
|
ret.append(Py::Object(It->getPyObject(), true));
|
|
}
|
|
|
|
return ret;
|
|
}
|
|
|
|
Py::List DocumentObjectPy::getOutListRecursive() const
|
|
{
|
|
Py::List ret;
|
|
try {
|
|
std::vector<DocumentObject*> list = getDocumentObjectPtr()->getOutListRecursive();
|
|
|
|
// create the python list for the output
|
|
for (auto It : list) {
|
|
ret.append(Py::Object(It->getPyObject(), true));
|
|
}
|
|
}
|
|
catch (const Base::Exception& e) {
|
|
throw Py::IndexError(e.what());
|
|
}
|
|
|
|
return ret;
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::setExpression(PyObject* args)
|
|
{
|
|
char* path = nullptr;
|
|
PyObject* expr;
|
|
char* comment = nullptr;
|
|
|
|
if (!PyArg_ParseTuple(args, "sO|s", &path, &expr, &comment)) {
|
|
return nullptr;
|
|
}
|
|
|
|
App::ObjectIdentifier p(ObjectIdentifier::parse(getDocumentObjectPtr(), path));
|
|
|
|
if (Py::Object(expr).isNone()) {
|
|
getDocumentObjectPtr()->clearExpression(p);
|
|
Py_Return;
|
|
}
|
|
else if (PyUnicode_Check(expr)) {
|
|
const char* exprStr = PyUnicode_AsUTF8(expr);
|
|
std::shared_ptr<Expression> shared_expr(Expression::parse(getDocumentObjectPtr(), exprStr));
|
|
if (shared_expr && comment) {
|
|
shared_expr->comment = comment;
|
|
}
|
|
|
|
getDocumentObjectPtr()->setExpression(p, shared_expr);
|
|
Py_Return;
|
|
}
|
|
|
|
throw Py::TypeError("String or None expected.");
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::clearExpression(PyObject* args)
|
|
{
|
|
char* path = nullptr;
|
|
if (!PyArg_ParseTuple(args, "s", &path)) {
|
|
return nullptr;
|
|
}
|
|
|
|
App::ObjectIdentifier p(ObjectIdentifier::parse(getDocumentObjectPtr(), path));
|
|
getDocumentObjectPtr()->clearExpression(p);
|
|
Py_Return;
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::evalExpression(PyObject* self, PyObject* args)
|
|
{
|
|
const char* expr;
|
|
if (!PyArg_ParseTuple(args, "s", &expr)) {
|
|
return nullptr;
|
|
}
|
|
|
|
// HINT:
|
|
// The standard behaviour of Python for class methods is to always pass the class
|
|
// object as first argument.
|
|
// For FreeCAD-specific types the behaviour is a bit different:
|
|
// When calling this method for an instance then this is passed as first argument
|
|
// and otherwise the class object is passed.
|
|
// This behaviour is achieved by the function _getattr() that passed 'this' to
|
|
// PyCFunction_New().
|
|
//
|
|
// evalExpression() is a class method and thus 'self' can either be an instance of
|
|
// DocumentObjectPy or a type object.
|
|
App::DocumentObject* obj = nullptr;
|
|
if (self && PyObject_TypeCheck(self, &DocumentObjectPy::Type)) {
|
|
obj = static_cast<DocumentObjectPy*>(self)->getDocumentObjectPtr();
|
|
}
|
|
|
|
PY_TRY
|
|
{
|
|
std::shared_ptr<Expression> shared_expr(Expression::parse(obj, expr));
|
|
if (shared_expr) {
|
|
return Py::new_reference_to(shared_expr->getPyValue());
|
|
}
|
|
Py_Return;
|
|
}
|
|
PY_CATCH
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::recompute(PyObject* args)
|
|
{
|
|
PyObject* recursive = Py_False;
|
|
if (!PyArg_ParseTuple(args, "|O!", &PyBool_Type, &recursive)) {
|
|
return nullptr;
|
|
}
|
|
|
|
try {
|
|
bool ok = getDocumentObjectPtr()->recomputeFeature(Base::asBoolean(recursive));
|
|
return Py_BuildValue("O", (ok ? Py_True : Py_False));
|
|
}
|
|
catch (const Base::Exception& e) {
|
|
throw Py::RuntimeError(e.what());
|
|
}
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::isValid(PyObject* args)
|
|
{
|
|
if (!PyArg_ParseTuple(args, "")) {
|
|
return nullptr;
|
|
}
|
|
|
|
try {
|
|
bool ok = getDocumentObjectPtr()->isValid();
|
|
return Py_BuildValue("O", (ok ? Py_True : Py_False));
|
|
}
|
|
catch (const Base::Exception& e) {
|
|
throw Py::RuntimeError(e.what());
|
|
}
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::getStatusString(PyObject* args)
|
|
{
|
|
if (!PyArg_ParseTuple(args, "")) {
|
|
return nullptr;
|
|
}
|
|
|
|
try {
|
|
Py::String text(getDocumentObjectPtr()->getStatusString());
|
|
return Py::new_reference_to(text);
|
|
}
|
|
catch (const Base::Exception& e) {
|
|
throw Py::RuntimeError(e.what());
|
|
}
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::getSubObject(PyObject* args, PyObject* keywds)
|
|
{
|
|
enum class ReturnType
|
|
{
|
|
PyObject = 0,
|
|
DocObject = 1,
|
|
DocAndPyObject = 2,
|
|
Placement = 3,
|
|
Matrix = 4,
|
|
LinkAndPlacement = 5,
|
|
LinkAndMatrix = 6
|
|
};
|
|
|
|
PyObject* obj;
|
|
short retType = 0;
|
|
PyObject* pyMat = nullptr;
|
|
PyObject* doTransform = Py_True;
|
|
short depth = 0;
|
|
|
|
static const std::array<const char*, 6> kwlist {"subname",
|
|
"retType",
|
|
"matrix",
|
|
"transform",
|
|
"depth",
|
|
nullptr};
|
|
if (!Base::Wrapped_ParseTupleAndKeywords(args,
|
|
keywds,
|
|
"O|hO!O!h",
|
|
kwlist,
|
|
&obj,
|
|
&retType,
|
|
&Base::MatrixPy::Type,
|
|
&pyMat,
|
|
&PyBool_Type,
|
|
&doTransform,
|
|
&depth)) {
|
|
return nullptr;
|
|
}
|
|
|
|
if (retType < 0 || static_cast<size_t>(retType) > kwlist.size()) {
|
|
PyErr_SetString(PyExc_ValueError, "invalid retType, can only be integer 0~6");
|
|
return nullptr;
|
|
}
|
|
|
|
ReturnType retEnum = ReturnType(retType);
|
|
std::vector<std::string> subs;
|
|
bool single = true;
|
|
|
|
if (PyUnicode_Check(obj)) {
|
|
subs.emplace_back(PyUnicode_AsUTF8(obj));
|
|
}
|
|
else if (PySequence_Check(obj)) {
|
|
single = false;
|
|
Py::Sequence shapeSeq(obj);
|
|
for (Py::Sequence::iterator it = shapeSeq.begin(); it != shapeSeq.end(); ++it) {
|
|
PyObject* item = (*it).ptr();
|
|
if (PyUnicode_Check(item)) {
|
|
subs.emplace_back(PyUnicode_AsUTF8(item));
|
|
}
|
|
else {
|
|
PyErr_SetString(PyExc_TypeError, "non-string object in sequence");
|
|
return nullptr;
|
|
}
|
|
}
|
|
}
|
|
else {
|
|
PyErr_SetString(PyExc_TypeError, "subname must be either a string or sequence of string");
|
|
return nullptr;
|
|
}
|
|
|
|
bool transform = Base::asBoolean(doTransform);
|
|
|
|
struct SubInfo
|
|
{
|
|
App::DocumentObject* sobj {nullptr};
|
|
Py::Object obj;
|
|
Py::Object pyObj;
|
|
Base::Matrix4D mat;
|
|
explicit SubInfo(const Base::Matrix4D& mat)
|
|
: mat(mat)
|
|
{}
|
|
};
|
|
|
|
Base::Matrix4D mat;
|
|
if (pyMat) {
|
|
mat = *static_cast<Base::MatrixPy*>(pyMat)->getMatrixPtr();
|
|
}
|
|
|
|
PY_TRY
|
|
{
|
|
std::vector<SubInfo> ret;
|
|
for (const auto& sub : subs) {
|
|
ret.emplace_back(mat);
|
|
auto& info = ret.back();
|
|
PyObject* pyObj = nullptr;
|
|
|
|
info.sobj = getDocumentObjectPtr()->getSubObject(
|
|
sub.c_str(),
|
|
retEnum != ReturnType::PyObject && retEnum != ReturnType::DocAndPyObject ? nullptr
|
|
: &pyObj,
|
|
&info.mat,
|
|
transform,
|
|
depth);
|
|
if (pyObj) {
|
|
info.pyObj = Py::asObject(pyObj);
|
|
}
|
|
if (info.sobj) {
|
|
info.obj = Py::asObject(info.sobj->getPyObject());
|
|
}
|
|
}
|
|
|
|
if (ret.empty()) {
|
|
Py_Return;
|
|
}
|
|
|
|
auto getReturnValue = [retEnum, pyMat](SubInfo& ret) -> Py::Object {
|
|
if (retEnum == ReturnType::PyObject) {
|
|
return ret.pyObj;
|
|
}
|
|
else if (retEnum == ReturnType::DocObject && !pyMat) {
|
|
return ret.obj;
|
|
}
|
|
else if (!ret.sobj) {
|
|
return Py::None();
|
|
}
|
|
else if (retEnum == ReturnType::Placement) {
|
|
return Py::Placement(Base::Placement(ret.mat));
|
|
}
|
|
else if (retEnum == ReturnType::Matrix) {
|
|
return Py::Matrix(ret.mat);
|
|
}
|
|
else if (retEnum == ReturnType::LinkAndPlacement
|
|
|| retEnum == ReturnType::LinkAndMatrix) {
|
|
ret.sobj->getLinkedObject(true, &ret.mat, false);
|
|
if (retEnum == ReturnType::LinkAndPlacement) {
|
|
return Py::Placement(Base::Placement(ret.mat));
|
|
}
|
|
else {
|
|
return Py::Matrix(ret.mat);
|
|
}
|
|
}
|
|
else {
|
|
Py::Tuple rret(retEnum == ReturnType::DocObject ? 2 : 3);
|
|
rret.setItem(0, ret.obj);
|
|
rret.setItem(1, Py::asObject(new Base::MatrixPy(ret.mat)));
|
|
if (retEnum != ReturnType::DocObject) {
|
|
rret.setItem(2, ret.pyObj);
|
|
}
|
|
return rret;
|
|
}
|
|
};
|
|
|
|
if (single) {
|
|
return Py::new_reference_to(getReturnValue(ret[0]));
|
|
}
|
|
|
|
Py::Tuple tuple(ret.size());
|
|
for (size_t i = 0; i < ret.size(); ++i) {
|
|
tuple.setItem(i, getReturnValue(ret[i]));
|
|
}
|
|
return Py::new_reference_to(tuple);
|
|
}
|
|
PY_CATCH
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::getSubObjectList(PyObject* args)
|
|
{
|
|
const char* subname;
|
|
if (!PyArg_ParseTuple(args, "s", &subname)) {
|
|
return nullptr;
|
|
}
|
|
Py::List res;
|
|
PY_TRY
|
|
{
|
|
for (auto o : getDocumentObjectPtr()->getSubObjectList(subname)) {
|
|
res.append(Py::asObject(o->getPyObject()));
|
|
}
|
|
return Py::new_reference_to(res);
|
|
}
|
|
PY_CATCH
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::getSubObjects(PyObject* args)
|
|
{
|
|
int reason = 0;
|
|
if (!PyArg_ParseTuple(args, "|i", &reason)) {
|
|
return nullptr;
|
|
}
|
|
|
|
PY_TRY
|
|
{
|
|
auto names = getDocumentObjectPtr()->getSubObjects(reason);
|
|
Py::Tuple pyObjs(names.size());
|
|
for (size_t i = 0; i < names.size(); ++i) {
|
|
pyObjs.setItem(i, Py::String(names[i]));
|
|
}
|
|
return Py::new_reference_to(pyObjs);
|
|
}
|
|
PY_CATCH;
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::getLinkedObject(PyObject* args, PyObject* keywds)
|
|
{
|
|
PyObject* recursive = Py_True;
|
|
PyObject* pyMat = Py_None;
|
|
PyObject* transform = Py_True;
|
|
short depth = 0;
|
|
static const std::array<const char*, 5> kwlist {"recursive",
|
|
"matrix",
|
|
"transform",
|
|
"depth",
|
|
nullptr};
|
|
if (!Base::Wrapped_ParseTupleAndKeywords(args,
|
|
keywds,
|
|
"|O!OO!h",
|
|
kwlist,
|
|
&PyBool_Type,
|
|
&recursive,
|
|
&pyMat,
|
|
&PyBool_Type,
|
|
&transform,
|
|
&depth)) {
|
|
return nullptr;
|
|
}
|
|
|
|
PY_TRY
|
|
{
|
|
Base::PyTypeCheck(&pyMat,
|
|
&Base::MatrixPy::Type,
|
|
"expect argument 'matrix' to be of type Base.Matrix");
|
|
Base::Matrix4D _mat;
|
|
Base::Matrix4D* mat = nullptr;
|
|
if (pyMat) {
|
|
_mat = *static_cast<Base::MatrixPy*>(pyMat)->getMatrixPtr();
|
|
mat = &_mat;
|
|
}
|
|
|
|
auto linked = getDocumentObjectPtr()->getLinkedObject(Base::asBoolean(recursive),
|
|
mat,
|
|
Base::asBoolean(transform),
|
|
depth);
|
|
if (!linked) {
|
|
linked = getDocumentObjectPtr();
|
|
}
|
|
auto pyObj = Py::Object(linked->getPyObject(), true);
|
|
if (mat) {
|
|
Py::Tuple ret(2);
|
|
ret.setItem(0, pyObj);
|
|
ret.setItem(1, Py::asObject(new Base::MatrixPy(*mat)));
|
|
return Py::new_reference_to(ret);
|
|
}
|
|
|
|
return Py::new_reference_to(pyObj);
|
|
}
|
|
PY_CATCH;
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::isElementVisible(PyObject* args)
|
|
{
|
|
char* element = nullptr;
|
|
if (!PyArg_ParseTuple(args, "s", &element)) {
|
|
return nullptr;
|
|
}
|
|
PY_TRY
|
|
{
|
|
return Py_BuildValue("h", getDocumentObjectPtr()->isElementVisible(element));
|
|
}
|
|
PY_CATCH;
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::setElementVisible(PyObject* args)
|
|
{
|
|
char* element = nullptr;
|
|
PyObject* visible = Py_True;
|
|
if (!PyArg_ParseTuple(args, "s|O!", &element, &PyBool_Type, &visible)) {
|
|
return nullptr;
|
|
}
|
|
PY_TRY
|
|
{
|
|
return Py_BuildValue(
|
|
"h",
|
|
getDocumentObjectPtr()->setElementVisible(element, Base::asBoolean(visible)));
|
|
}
|
|
PY_CATCH;
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::hasChildElement(PyObject* args)
|
|
{
|
|
if (!PyArg_ParseTuple(args, "")) {
|
|
return nullptr;
|
|
}
|
|
PY_TRY
|
|
{
|
|
return Py_BuildValue("O", getDocumentObjectPtr()->hasChildElement() ? Py_True : Py_False);
|
|
}
|
|
PY_CATCH;
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::getParentGroup(PyObject* args)
|
|
{
|
|
if (!PyArg_ParseTuple(args, "")) {
|
|
return nullptr;
|
|
}
|
|
|
|
try {
|
|
auto grp = GroupExtension::getGroupOfObject(getDocumentObjectPtr());
|
|
if (!grp) {
|
|
Py_INCREF(Py_None);
|
|
return Py_None;
|
|
}
|
|
return grp->getPyObject();
|
|
}
|
|
catch (const Base::Exception& e) {
|
|
throw Py::RuntimeError(e.what());
|
|
}
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::getParentGeoFeatureGroup(PyObject* args)
|
|
{
|
|
if (!PyArg_ParseTuple(args, "")) {
|
|
return nullptr;
|
|
}
|
|
|
|
try {
|
|
auto grp = GeoFeatureGroupExtension::getGroupOfObject(getDocumentObjectPtr());
|
|
if (!grp) {
|
|
Py_INCREF(Py_None);
|
|
return Py_None;
|
|
}
|
|
return grp->getPyObject();
|
|
}
|
|
catch (const Base::Exception& e) {
|
|
throw Py::RuntimeError(e.what());
|
|
}
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::getParent(PyObject* args)
|
|
{
|
|
if (!PyArg_ParseTuple(args, "")) {
|
|
return nullptr;
|
|
}
|
|
|
|
try {
|
|
auto grp = getDocumentObjectPtr()->getFirstParent();
|
|
if (!grp) {
|
|
Py_INCREF(Py_None);
|
|
return Py_None;
|
|
}
|
|
return grp->getPyObject();
|
|
}
|
|
catch (const Base::Exception& e) {
|
|
throw Py::RuntimeError(e.what());
|
|
}
|
|
}
|
|
|
|
Py::Boolean DocumentObjectPy::getMustExecute() const
|
|
{
|
|
try {
|
|
return {getDocumentObjectPtr()->mustExecute() ? true : false};
|
|
}
|
|
catch (const Base::Exception& e) {
|
|
throw Py::RuntimeError(e.what());
|
|
}
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::getPathsByOutList(PyObject* args)
|
|
{
|
|
PyObject* o;
|
|
if (!PyArg_ParseTuple(args, "O!", &DocumentObjectPy::Type, &o)) {
|
|
return nullptr;
|
|
}
|
|
|
|
try {
|
|
DocumentObject* target = static_cast<DocumentObjectPy*>(o)->getDocumentObjectPtr();
|
|
auto array = getDocumentObjectPtr()->getPathsByOutList(target);
|
|
Py::List list;
|
|
for (const auto& it : array) {
|
|
Py::List path;
|
|
for (auto jt : it) {
|
|
path.append(Py::asObject(jt->getPyObject()));
|
|
}
|
|
list.append(path);
|
|
}
|
|
return Py::new_reference_to(list);
|
|
}
|
|
catch (const Base::Exception& e) {
|
|
throw Py::RuntimeError(e.what());
|
|
}
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::getElementMapVersion(PyObject* args)
|
|
{
|
|
const char* name;
|
|
PyObject* restored = Py_False;
|
|
if (!PyArg_ParseTuple(args, "s|O", &name, &restored)) {
|
|
return NULL;
|
|
}
|
|
|
|
Property* prop = getDocumentObjectPtr()->getPropertyByName(name);
|
|
if (!prop) {
|
|
throw Py::ValueError("property not found");
|
|
}
|
|
return Py::new_reference_to(
|
|
Py::String(getDocumentObjectPtr()->getElementMapVersion(prop, Base::asBoolean(restored))));
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::getCustomAttributes(const char*) const
|
|
{
|
|
return nullptr;
|
|
}
|
|
// remove
|
|
int DocumentObjectPy::setCustomAttributes(const char*, PyObject*)
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
Py::Long DocumentObjectPy::getID() const
|
|
{
|
|
return Py::Long(getDocumentObjectPtr()->getID());
|
|
}
|
|
|
|
Py::Boolean DocumentObjectPy::getRemoving() const
|
|
{
|
|
return {getDocumentObjectPtr()->testStatus(ObjectStatus::Remove)};
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::resolve(PyObject* args)
|
|
{
|
|
const char* subname;
|
|
if (!PyArg_ParseTuple(args, "s", &subname)) {
|
|
return nullptr;
|
|
}
|
|
|
|
PY_TRY
|
|
{
|
|
std::string elementName;
|
|
const char* subElement = nullptr;
|
|
App::DocumentObject* parent = nullptr;
|
|
auto obj = getDocumentObjectPtr()->resolve(subname, &parent, &elementName, &subElement);
|
|
|
|
Py::Tuple ret(4);
|
|
ret.setItem(0, obj ? Py::Object(obj->getPyObject(), true) : Py::None());
|
|
ret.setItem(1, parent ? Py::Object(parent->getPyObject(), true) : Py::None());
|
|
ret.setItem(2, Py::String(elementName.c_str()));
|
|
ret.setItem(3, Py::String(subElement ? subElement : ""));
|
|
return Py::new_reference_to(ret);
|
|
}
|
|
PY_CATCH;
|
|
|
|
Py_Return;
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::resolveSubElement(PyObject* args)
|
|
{
|
|
const char* subname;
|
|
PyObject* append = Py_False;
|
|
int type = 0;
|
|
if (!PyArg_ParseTuple(args, "s|O!i", &subname, &PyBool_Type, &append, &type)) {
|
|
return nullptr;
|
|
}
|
|
|
|
PY_TRY
|
|
{
|
|
ElementNamePair elementName;
|
|
auto obj = GeoFeature::resolveElement(getDocumentObjectPtr(),
|
|
subname,
|
|
elementName,
|
|
Base::asBoolean(append),
|
|
static_cast<GeoFeature::ElementNameType>(type));
|
|
Py::Tuple ret(3);
|
|
ret.setItem(0, obj ? Py::Object(obj->getPyObject(), true) : Py::None());
|
|
ret.setItem(1, Py::String(elementName.newName));
|
|
ret.setItem(2, Py::String(elementName.oldName));
|
|
return Py::new_reference_to(ret);
|
|
}
|
|
PY_CATCH;
|
|
|
|
Py_Return;
|
|
}
|
|
|
|
Py::List DocumentObjectPy::getParents() const
|
|
{
|
|
Py::List ret;
|
|
for (auto& v : getDocumentObjectPtr()->getParents()) {
|
|
ret.append(Py::TupleN(Py::Object(v.first->getPyObject(), true), Py::String(v.second)));
|
|
}
|
|
return ret;
|
|
}
|
|
|
|
PyObject* DocumentObjectPy::adjustRelativeLinks(PyObject* args)
|
|
{
|
|
PyObject* pyobj;
|
|
PyObject* recursive = Py_True;
|
|
if (!PyArg_ParseTuple(args, "O!|O", &DocumentObjectPy::Type, &pyobj, &recursive)) {
|
|
return nullptr;
|
|
}
|
|
PY_TRY
|
|
{
|
|
auto obj = static_cast<DocumentObjectPy*>(pyobj)->getDocumentObjectPtr();
|
|
auto inList = obj->getInListEx(true);
|
|
inList.insert(obj);
|
|
std::set<App::DocumentObject*> visited;
|
|
return Py::new_reference_to(Py::Boolean(getDocumentObjectPtr()->adjustRelativeLinks(
|
|
inList,
|
|
Base::asBoolean(recursive) ? &visited : nullptr)));
|
|
}
|
|
PY_CATCH
|
|
}
|
|
|
|
Py::String DocumentObjectPy::getOldLabel() const
|
|
{
|
|
return {getDocumentObjectPtr()->getOldLabel()};
|
|
}
|
|
|
|
Py::Boolean DocumentObjectPy::getNoTouch() const
|
|
{
|
|
return {getDocumentObjectPtr()->testStatus(ObjectStatus::NoTouch)};
|
|
}
|
|
|
|
void DocumentObjectPy::setNoTouch(Py::Boolean value)
|
|
{
|
|
getDocumentObjectPtr()->setStatus(ObjectStatus::NoTouch, value.isTrue());
|
|
}
|