src/Gui/Selection/SelectionObjectPyImp.cpp

// SPDX-License-Identifier: LGPL-2.1-or-later
/***************************************************************************
 *   Copyright (c) 2009 Jürgen Riegel <FreeCAD@juergen-riegel.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 <App/Document.h>
#include <App/DocumentObject.h>
#include <Base/GeometryPyCXX.h>

#include "Selection.h"
#include "SelectionObject.h"


// inclusion of the generated files (generated out of SelectionObjectPy.xml)
#include "Selection/SelectionObjectPy.h"
#include "Selection/SelectionObjectPy.cpp"


using namespace Gui;

// returns a string which represents the object e.g. when printed in python
std::string SelectionObjectPy::representation() const
{
    return "<SelectionObject>";
}

PyObject* SelectionObjectPy::remove(PyObject* args)
{
    if (!PyArg_ParseTuple(args, "")) {
        return nullptr;
    }
    Selection().rmvSelection(
        getSelectionObjectPtr()->getDocName(),
        getSelectionObjectPtr()->getFeatName()
    );
    Py_Return;
}

PyObject* SelectionObjectPy::isObjectTypeOf(PyObject* args)
{
    char* type;
    if (!PyArg_ParseTuple(args, "s", &type)) {
        return nullptr;
    }
    Base::Type id = Base::Type::fromName(type);
    if (id.isBad()) {
        PyErr_SetString(PyExc_TypeError, "Not a valid type");
        return nullptr;
    }

    bool ok = getSelectionObjectPtr()->isObjectTypeOf(id);

    return Py_BuildValue("O", (ok ? Py_True : Py_False));
}

Py::String SelectionObjectPy::getObjectName() const
{
    return {getSelectionObjectPtr()->getFeatName()};
}

Py::Tuple SelectionObjectPy::getSubElementNames() const
{
    std::vector<std::string> objs = getSelectionObjectPtr()->getSubNames();

    Py::Tuple temp(objs.size());
    Py::sequence_index_type index = 0;
    for (const auto& obj : objs) {
        temp.setItem(index++, Py::String(obj));
    }

    return temp;
}

Py::String SelectionObjectPy::getFullName() const
{
    return {getSelectionObjectPtr()->getAsPropertyLinkSubString()};
}

Py::String SelectionObjectPy::getTypeName() const
{
    return {getSelectionObjectPtr()->getTypeName()};
}

Py::String SelectionObjectPy::getDocumentName() const
{
    return {getSelectionObjectPtr()->getDocName()};
}

Py::Object SelectionObjectPy::getDocument() const
{
    App::DocumentObject* obj = getSelectionObjectPtr()->getObject();
    if (!obj) {
        throw Py::RuntimeError("Cannot get document of deleted object");
    }
    return Py::Object(obj->getDocument()->getPyObject(), true);
}

Py::Object SelectionObjectPy::getObject() const
{
    App::DocumentObject* obj = getSelectionObjectPtr()->getObject();
    if (!obj) {
        throw Py::RuntimeError("Object already deleted");
    }
    return Py::Object(obj->getPyObject(), true);
}

Py::Tuple SelectionObjectPy::getSubObjects() const
{
    App::DocumentObject* obj = getSelectionObjectPtr()->getObject();
    if (!obj) {
        throw Py::RuntimeError("Cannot get sub-objects of deleted object");
    }

    std::vector<PyObject*> subObjs;

    for (const auto& subname : getSelectionObjectPtr()->getSubNames()) {
        PyObject* pyObj = nullptr;
        Base::Matrix4D mat;
        obj->getSubObject(subname.c_str(), &pyObj, &mat);
        if (pyObj) {
            subObjs.push_back(pyObj);
        }
    }

    Py::Tuple temp(subObjs.size());
    Py::sequence_index_type index = 0;
    for (const auto& subObj : subObjs) {
        temp.setItem(index++, Py::asObject(subObj));
    }

    return temp;
}

Py::Boolean SelectionObjectPy::getHasSubObjects() const
{
    return {getSelectionObjectPtr()->hasSubNames()};
}

Py::Tuple SelectionObjectPy::getPickedPoints() const
{
    const std::vector<Base::Vector3d>& points = getSelectionObjectPtr()->getPickedPoints();

    Py::Tuple temp(points.size());
    Py::sequence_index_type index = 0;
    for (const auto& point : points) {
        temp.setItem(index++, Py::Vector(point));
    }

    return temp;
}

PyObject* SelectionObjectPy::getCustomAttributes(const char* /*attr*/) const
{
    return nullptr;
}

int SelectionObjectPy::setCustomAttributes(const char* /*attr*/, PyObject* /*obj*/)
{
    return 0;
}