File size: 4,724 Bytes
985c397 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | // 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 *
* *
***************************************************************************/
#ifndef GUI_SelectionObject_H
#define GUI_SelectionObject_H
#include <Base/BaseClass.h>
#include <Base/Vector3D.h>
#include <FCGlobal.h>
#include <string>
namespace App
{
class DocumentObject;
}
namespace Gui
{
class SelectionChanges;
/**
* The Selection object class
*/
class GuiExport SelectionObject: public Base::BaseClass
{
TYPESYSTEM_HEADER_WITH_OVERRIDE();
public:
/** Constructs a SelectionObject object. */
SelectionObject();
/*! Constructs a SelectionObject from the SelectionChanges structure.
*/
explicit SelectionObject(const SelectionChanges& msg);
explicit SelectionObject(const App::DocumentObject*);
~SelectionObject() override;
/**
* The default implementation returns an instance of @ref SelectionObjectPy.
*/
PyObject* getPyObject() override;
/// get the SubElement name of this SelectionObject
inline const std::vector<std::string>& getSubNames() const
{
return SubNames;
}
/// are there any SubNames selected
bool hasSubNames() const
{
return !SubNames.empty();
}
/// get the name of the Document of this SelctionObject
inline const char* getDocName() const
{
return DocName.c_str();
}
/// get the name of the Document Object of this SelectionObject
inline const char* getFeatName() const
{
return FeatName.c_str();
}
/// get the Type of the selected Object
inline const char* getTypeName() const
{
return TypeName.c_str();
}
/// get the selection points
inline const std::vector<Base::Vector3d> getPickedPoints() const
{
return SelPoses;
}
/// returns the selected DocumentObject or NULL if the object is already deleted
const App::DocumentObject* getObject() const;
/// returns the selected DocumentObject or NULL if the object is already deleted
template<class T>
const T* getObject() const
{
return freecad_cast<T*>(getObject());
};
/// returns the selected DocumentObject or NULL if the object is already deleted
App::DocumentObject* getObject();
/// returns the selected DocumentObject if it is of T type or null otherwise
template<class T>
T* getObject()
{
return freecad_cast<T*>(getObject());
}
/// check the selected object is a special type or derived of
bool isObjectTypeOf(const Base::Type& typeId) const;
/// returns python expreasion sutably for assigning to a LinkSub property
std::string getAsPropertyLinkSubString() const;
friend class SelectionSingleton;
protected:
std::vector<std::string> SubNames;
std::string DocName;
std::string FeatName;
std::string TypeName;
std::vector<Base::Vector3d> SelPoses;
private:
/// to make sure no duplicates of subnames
std::set<std::string> _SubNameSet;
};
} // namespace Gui
#endif // GUI_SelectionObject_H
|