deb15a57e4
Obtaining specific kind of document object is very common task. This commit introduces handy helper which makes that a lot easier.
107 lines
4.0 KiB
C++
107 lines
4.0 KiB
C++
/***************************************************************************
|
|
* Copyright (c) 2022 WandererFan <wandererfan@gmail.com> *
|
|
* *
|
|
* 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 TECHDRAW_DIMENSIONREFERENCES_H
|
|
#define TECHDRAW_DIMENSIONREFERENCES_H
|
|
|
|
#include <Mod/TechDraw/TechDrawGlobal.h>
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include <TopoDS_Shape.hxx>
|
|
#include <TopoDS_Edge.hxx>
|
|
#include <TopoDS_Vertex.hxx>
|
|
|
|
#include <Mod/Part/App/TopoShape.h>
|
|
#include <Mod/TechDraw/App/Geometry.h>
|
|
|
|
namespace App
|
|
{
|
|
class DocumentObject;
|
|
class Document;
|
|
}
|
|
|
|
namespace Part
|
|
{
|
|
class TopoShape;
|
|
}
|
|
|
|
namespace TechDraw
|
|
{
|
|
class DrawViewPart;
|
|
|
|
//a convenient way of handling object+subName references
|
|
class TechDrawExport ReferenceEntry
|
|
{
|
|
public:
|
|
ReferenceEntry() = default;
|
|
ReferenceEntry( App::DocumentObject* docObject, std::string subName, App::Document* document = nullptr);
|
|
ReferenceEntry(const ReferenceEntry& other);
|
|
~ReferenceEntry() = default;
|
|
|
|
ReferenceEntry& operator= (const ReferenceEntry& otherRef);
|
|
bool operator== (const ReferenceEntry& otherRef) const;
|
|
|
|
App::DocumentObject* getObject() const;
|
|
template <class T> T* getObject() const { return dynamic_cast<T*>(getObject()); }
|
|
void setObject(App::DocumentObject* docObj) { m_object = docObj; }
|
|
std::string getSubName(bool longForm = false) const;
|
|
void setSubName(const std::string& subName) { m_subName = subName; }
|
|
std::string getObjectName() const { return m_objectName; }
|
|
void setObjectName(const std::string& name) { m_objectName = name; }
|
|
App::Document* getDocument() const { return m_document; }
|
|
void setDocument(App::Document* document) { m_document = document; }
|
|
|
|
TopoDS_Shape getGeometry() const;
|
|
std::string geomType() const;
|
|
GeomType geomEdgeType() const;
|
|
|
|
bool isWholeObject() const;
|
|
|
|
Part::TopoShape asTopoShape() const;
|
|
Part::TopoShape asCanonicalTopoShape() const;
|
|
static Part::TopoShape asCanonicalTopoShape(const Part::TopoShape& inShape, const DrawViewPart& dvp);
|
|
|
|
bool is3d() const;
|
|
bool hasGeometry() const;
|
|
|
|
private:
|
|
bool hasGeometry2d() const;
|
|
TopoDS_Shape getGeometry2d() const;
|
|
|
|
static Part::TopoShape asTopoShapeVertex(const TopoDS_Vertex &vert);
|
|
static Part::TopoShape asTopoShapeEdge(const TopoDS_Edge& edge);
|
|
static Part::TopoShape asTopoShapeFace(const TopoDS_Face& edge);
|
|
|
|
App::DocumentObject* m_object{nullptr};
|
|
std::string m_subName;
|
|
std::string m_objectName;
|
|
App::Document* m_document{nullptr};
|
|
};
|
|
|
|
using ReferenceVector = std::vector<ReferenceEntry>;
|
|
|
|
} // end namespace
|
|
|
|
#endif //TECHDRAW_DIMENSIONREFERENCES_H
|