a0fdc86948
Dialogs to view the Appearance and Material properties of an object These inspectors are intended to be used when debugging Appearance and Material issues in a model. The Appearance inspector displays the appearance properties of an object. This will be more useful once PR 13792 is merged which migrates parts to use ShapeAppearance instead of DiffuseColor. This shows each of the appearance properties per face for the object. The Material inspector shows the material, models, and properties assigned to a model. It displays useful debugging information such as the UUID and file paths associated with eacch of the items. This is useful when finding and resolving model conflicts. The material inspector now gives the option of copying the information to the clipboard.
426 lines
14 KiB
C++
426 lines
14 KiB
C++
/***************************************************************************
|
|
* Copyright (c) 2024 David Carter <dcarter@david.carter.ca> *
|
|
* *
|
|
* This file is part of FreeCAD. *
|
|
* *
|
|
* FreeCAD is free software: you can redistribute it and/or modify it *
|
|
* under the terms of the GNU Lesser General Public License as *
|
|
* published by the Free Software Foundation, either version 2.1 of the *
|
|
* License, or (at your option) any later version. *
|
|
* *
|
|
* FreeCAD 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 *
|
|
* Lesser General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU Lesser General Public *
|
|
* License along with FreeCAD. If not, see *
|
|
* <https://www.gnu.org/licenses/>. *
|
|
* *
|
|
**************************************************************************/
|
|
|
|
#include "PreCompiled.h"
|
|
#ifndef _PreComp_
|
|
#include <QClipboard>
|
|
#include <QStandardItem>
|
|
#include <QStandardItemModel>
|
|
#include <QTreeView>
|
|
#endif
|
|
|
|
#include <App/Document.h>
|
|
#include <Gui/Application.h>
|
|
#include <Gui/BitmapFactory.h>
|
|
#include <Gui/Document.h>
|
|
#include <Gui/Selection.h>
|
|
#include <Gui/ViewProvider.h>
|
|
#include <Gui/ViewProviderDocumentObject.h>
|
|
|
|
#include <Mod/Material/App/MaterialLibrary.h>
|
|
#include <Mod/Material/App/PropertyMaterial.h>
|
|
|
|
#include "DlgInspectMaterial.h"
|
|
#include "ui_DlgInspectMaterial.h"
|
|
|
|
|
|
using namespace MatGui;
|
|
|
|
/* TRANSLATOR MatGui::DlgInspectMaterial */
|
|
|
|
DlgInspectMaterial::DlgInspectMaterial(QWidget* parent)
|
|
: QWidget(parent)
|
|
, ui(new Ui_DlgInspectMaterial)
|
|
{
|
|
ui->setupUi(this);
|
|
|
|
auto tree = ui->treeMaterials;
|
|
auto model = new QStandardItemModel();
|
|
tree->setModel(model);
|
|
|
|
tree->setHeaderHidden(true);
|
|
|
|
|
|
std::vector<Gui::ViewProvider*> views = getSelection();
|
|
update(views);
|
|
|
|
connect(ui->buttonClipboard, &QPushButton::clicked, this, &DlgInspectMaterial::onClipboard);
|
|
|
|
Gui::Selection().Attach(this);
|
|
}
|
|
|
|
DlgInspectMaterial::~DlgInspectMaterial()
|
|
{
|
|
Gui::Selection().Detach(this);
|
|
}
|
|
|
|
bool DlgInspectMaterial::accept()
|
|
{
|
|
return true;
|
|
}
|
|
|
|
void DlgInspectMaterial::onClipboard(bool checked)
|
|
{
|
|
Q_UNUSED(checked)
|
|
|
|
QApplication::clipboard()->setText(clipboardText);
|
|
}
|
|
|
|
std::vector<Gui::ViewProvider*> DlgInspectMaterial::getSelection() const
|
|
{
|
|
std::vector<Gui::ViewProvider*> views;
|
|
|
|
// get a single selection
|
|
std::vector<Gui::SelectionSingleton::SelObj> sel =
|
|
Gui::Selection().getSelection(nullptr, Gui::ResolveMode::OldStyleElement, true);
|
|
for (const auto& it : sel) {
|
|
Gui::ViewProvider* view =
|
|
Gui::Application::Instance->getDocument(it.pDoc)->getViewProvider(it.pObject);
|
|
views.push_back(view);
|
|
}
|
|
|
|
return views;
|
|
}
|
|
|
|
/// @cond DOXERR
|
|
void DlgInspectMaterial::OnChange(Gui::SelectionSingleton::SubjectType& rCaller,
|
|
Gui::SelectionSingleton::MessageType Reason)
|
|
{
|
|
Q_UNUSED(rCaller);
|
|
|
|
if (Reason.Type == Gui::SelectionChanges::AddSelection
|
|
|| Reason.Type == Gui::SelectionChanges::RmvSelection
|
|
|| Reason.Type == Gui::SelectionChanges::SetSelection
|
|
|| Reason.Type == Gui::SelectionChanges::ClrSelection) {
|
|
std::vector<Gui::ViewProvider*> views = getSelection();
|
|
update(views);
|
|
}
|
|
}
|
|
/// @endcond
|
|
|
|
void DlgInspectMaterial::appendClip(QString text)
|
|
{
|
|
// Need to add indent
|
|
QString indent(clipboardIndent * 4, QLatin1Char(' '));
|
|
clipboardText += indent + text + QLatin1String("\n");
|
|
}
|
|
|
|
QStandardItem* DlgInspectMaterial::clipItem(QString text)
|
|
{
|
|
appendClip(text);
|
|
auto item = new QStandardItem(text);
|
|
return item;
|
|
}
|
|
|
|
void DlgInspectMaterial::indent()
|
|
{
|
|
clipboardIndent += 1;
|
|
}
|
|
|
|
void DlgInspectMaterial::unindent()
|
|
{
|
|
if (clipboardIndent > 0) {
|
|
clipboardIndent -= 1;
|
|
}
|
|
}
|
|
|
|
void DlgInspectMaterial::update(std::vector<Gui::ViewProvider*>& views)
|
|
{
|
|
clipboardText = QLatin1String("");
|
|
clipboardIndent = 0;
|
|
App::Document* doc = App::GetApplication().getActiveDocument();
|
|
if (doc) {
|
|
appendClip(tr("Document: ") + QString::fromUtf8(doc->Label.getValue()));
|
|
ui->editDocument->setText(QString::fromUtf8(doc->Label.getValue()));
|
|
|
|
if (views.size() == 1) {
|
|
auto view = dynamic_cast<Gui::ViewProviderDocumentObject*>(views[0]);
|
|
if (!view) {
|
|
return;
|
|
}
|
|
auto* obj = view->getObject();
|
|
if (!obj) {
|
|
return;
|
|
}
|
|
auto* labelProp = dynamic_cast<App::PropertyString*>(obj->getPropertyByName("Label"));
|
|
if (labelProp) {
|
|
ui->editObjectLabel->setText(QString::fromUtf8(labelProp->getValue()));
|
|
appendClip(tr("Label: ") + QString::fromUtf8(labelProp->getValue()));
|
|
}
|
|
else {
|
|
ui->editObjectLabel->setText(QLatin1String(""));
|
|
}
|
|
ui->editObjectName->setText(QLatin1String(obj->getNameInDocument()));
|
|
appendClip(tr("Internal Name: ") + QString::fromUtf8(obj->getNameInDocument()));
|
|
|
|
auto subElement = Gui::Selection().getSelectionEx();
|
|
if (subElement.size() > 0) {
|
|
auto& subObject = subElement[0];
|
|
if (subObject.getSubNames().size() > 0) {
|
|
ui->editSubShape->setText(QString::fromStdString(subObject.getSubNames()[0]));
|
|
}
|
|
else {
|
|
ui->editSubShape->setText(QLatin1String(""));
|
|
}
|
|
}
|
|
else {
|
|
ui->editSubShape->setText(QLatin1String(""));
|
|
}
|
|
|
|
auto subShapeType = QString::fromUtf8(obj->getTypeId().getName());
|
|
subShapeType.remove(subShapeType.indexOf(QLatin1String("::")), subShapeType.size());
|
|
appendClip(tr("Type: ") + subShapeType);
|
|
ui->editSubShapeType->setText(subShapeType);
|
|
appendClip(tr("TypeID: ") + QString::fromUtf8(obj->getTypeId().getName()));
|
|
ui->editShapeType->setText(QString::fromUtf8(obj->getTypeId().getName()));
|
|
|
|
if (labelProp && QString::fromUtf8(labelProp->getValue()).size() > 0) {
|
|
auto* prop = dynamic_cast<Materials::PropertyMaterial*>(
|
|
obj->getPropertyByName("ShapeMaterial"));
|
|
if (prop) {
|
|
updateMaterialTree(prop->getValue());
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
void DlgInspectMaterial::updateMaterialTree(const Materials::Material& material)
|
|
{
|
|
Base::Console().Log("Material '%s'\n", material.getName().toStdString().c_str());
|
|
|
|
auto tree = ui->treeMaterials;
|
|
auto model = dynamic_cast<QStandardItemModel*>(tree->model());
|
|
model->clear();
|
|
|
|
addMaterial(tree, model, material);
|
|
}
|
|
|
|
void DlgInspectMaterial::addMaterial(QTreeView* tree,
|
|
QStandardItemModel* parent,
|
|
const Materials::Material& material)
|
|
{
|
|
auto card = clipItem(tr("Name: ") + material.getName());
|
|
addExpanded(tree, parent, card);
|
|
|
|
indent();
|
|
addMaterialDetails(tree, card, material);
|
|
unindent();
|
|
}
|
|
|
|
void DlgInspectMaterial::addMaterial(QTreeView* tree,
|
|
QStandardItem* parent,
|
|
const Materials::Material& material)
|
|
{
|
|
auto card = clipItem(tr("Name: ") + material.getName());
|
|
addExpanded(tree, parent, card);
|
|
|
|
indent();
|
|
addMaterialDetails(tree, card, material);
|
|
unindent();
|
|
}
|
|
|
|
void DlgInspectMaterial::addModels(QTreeView* tree,
|
|
QStandardItem* parent,
|
|
const QSet<QString>* models)
|
|
{
|
|
if (models->isEmpty()) {
|
|
auto none = clipItem(tr("None"));
|
|
addExpanded(tree, parent, none);
|
|
}
|
|
else {
|
|
for (const QString& uuid : *models) {
|
|
auto model = modelManager.getModel(uuid);
|
|
auto name = clipItem(tr("Name: ") + model->getName());
|
|
addExpanded(tree, parent, name);
|
|
|
|
indent();
|
|
addModelDetails(tree, name, model);
|
|
unindent();
|
|
}
|
|
}
|
|
}
|
|
|
|
void DlgInspectMaterial::addModelDetails(QTreeView* tree,
|
|
QStandardItem* parent,
|
|
std::shared_ptr<Materials::Model>& model)
|
|
{
|
|
auto uuid = clipItem(tr("UUID: ") + model->getUUID());
|
|
addExpanded(tree, parent, uuid);
|
|
|
|
auto library = clipItem(tr("Library: ") + model->getLibrary()->getName());
|
|
addExpanded(tree, parent, library);
|
|
|
|
auto libraryPath =
|
|
clipItem(tr("Library Directory: ") + model->getLibrary()->getDirectoryPath());
|
|
addExpanded(tree, parent, libraryPath);
|
|
|
|
auto directory = clipItem(tr("Sub Directory: ") + model->getDirectory());
|
|
addExpanded(tree, parent, directory);
|
|
|
|
auto inherits = clipItem(tr("Inherits:"));
|
|
addExpanded(tree, parent, inherits);
|
|
|
|
auto& inheritedUuids = model->getInheritance();
|
|
indent();
|
|
if (inheritedUuids.isEmpty()) {
|
|
auto none = clipItem(tr("None"));
|
|
addExpanded(tree, inherits, none);
|
|
}
|
|
else {
|
|
for (const QString& inherited : inheritedUuids) {
|
|
auto inheritedModel = modelManager.getModel(inherited);
|
|
|
|
auto name = clipItem(tr("Name: ") + inheritedModel->getName());
|
|
addExpanded(tree, inherits, name);
|
|
|
|
indent();
|
|
addModelDetails(tree, name, inheritedModel);
|
|
unindent();
|
|
}
|
|
}
|
|
unindent();
|
|
}
|
|
|
|
void DlgInspectMaterial::addProperties(
|
|
QTreeView* tree,
|
|
QStandardItem* parent,
|
|
const std::map<QString, std::shared_ptr<Materials::MaterialProperty>>& properties)
|
|
{
|
|
if (properties.empty()) {
|
|
auto none = clipItem(tr("None"));
|
|
addExpanded(tree, parent, none);
|
|
}
|
|
else {
|
|
for (auto& property : properties) {
|
|
auto name = clipItem(tr("Name: ") + property.second->getName());
|
|
addExpanded(tree, parent, name);
|
|
|
|
indent();
|
|
addPropertyDetails(tree, name, property.second);
|
|
unindent();
|
|
}
|
|
}
|
|
}
|
|
|
|
void DlgInspectMaterial::addPropertyDetails(
|
|
QTreeView* tree,
|
|
QStandardItem* parent,
|
|
const std::shared_ptr<Materials::MaterialProperty>& property)
|
|
{
|
|
auto uuid = clipItem(tr("Model UUID: ") + property->getModelUUID());
|
|
addExpanded(tree, parent, uuid);
|
|
auto type = clipItem(tr("Type: ") + property->getPropertyType());
|
|
addExpanded(tree, parent, type);
|
|
auto hasValue = clipItem(tr("Has value: ") + (property->isNull() ? tr("No") : tr("Yes")));
|
|
addExpanded(tree, parent, hasValue);
|
|
}
|
|
|
|
void DlgInspectMaterial::addMaterialDetails(QTreeView* tree,
|
|
QStandardItem* parent,
|
|
const Materials::Material& material)
|
|
{
|
|
auto uuid = clipItem(tr("UUID: ") + material.getUUID());
|
|
addExpanded(tree, parent, uuid);
|
|
auto library = clipItem(tr("Library: ") + material.getLibrary()->getName());
|
|
addExpanded(tree, parent, library);
|
|
auto libraryPath =
|
|
clipItem(tr("Library Directory: ") + material.getLibrary()->getDirectoryPath());
|
|
addExpanded(tree, parent, libraryPath);
|
|
auto directory = clipItem(tr("Sub Directory: ") + material.getDirectory());
|
|
addExpanded(tree, parent, directory);
|
|
auto inherits = clipItem(tr("Inherits:"));
|
|
addExpanded(tree, parent, inherits);
|
|
|
|
indent();
|
|
auto parentUUID = material.getParentUUID();
|
|
if (!parentUUID.isEmpty()) {
|
|
auto parentMaterial = materialManager.getMaterial(material.getParentUUID());
|
|
addMaterial(tree, inherits, *parentMaterial);
|
|
}
|
|
else {
|
|
auto none = clipItem(tr("None"));
|
|
addExpanded(tree, inherits, none);
|
|
}
|
|
unindent();
|
|
|
|
auto appearance = clipItem(tr("Appearance Models:"));
|
|
addExpanded(tree, parent, appearance);
|
|
indent();
|
|
addModels(tree, appearance, material.getAppearanceModels());
|
|
unindent();
|
|
|
|
auto physical = clipItem(tr("Physical Models:"));
|
|
addExpanded(tree, parent, physical);
|
|
indent();
|
|
addModels(tree, physical, material.getPhysicalModels());
|
|
unindent();
|
|
|
|
auto appearanceProperties = clipItem(tr("Appearance Properties:"));
|
|
addExpanded(tree, parent, appearanceProperties);
|
|
indent();
|
|
addProperties(tree, appearanceProperties, material.getAppearanceProperties());
|
|
unindent();
|
|
|
|
auto physicalProperties = clipItem(tr("Physical Properties:"));
|
|
addExpanded(tree, parent, physicalProperties);
|
|
indent();
|
|
addProperties(tree, physicalProperties, material.getPhysicalProperties());
|
|
unindent();
|
|
}
|
|
|
|
void DlgInspectMaterial::addExpanded(QTreeView* tree,
|
|
QStandardItemModel* parent,
|
|
QStandardItem* child)
|
|
{
|
|
parent->appendRow(child);
|
|
tree->setExpanded(child->index(), true);
|
|
}
|
|
|
|
void DlgInspectMaterial::addExpanded(QTreeView* tree, QStandardItem* parent, QStandardItem* child)
|
|
{
|
|
parent->appendRow(child);
|
|
tree->setExpanded(child->index(), true);
|
|
}
|
|
|
|
/* TRANSLATOR MatGui::TaskInspectMaterial */
|
|
|
|
TaskInspectMaterial::TaskInspectMaterial()
|
|
{
|
|
widget = new DlgInspectMaterial();
|
|
addTaskBox(Gui::BitmapFactory().pixmap("Part_Loft"), widget);
|
|
}
|
|
|
|
TaskInspectMaterial::~TaskInspectMaterial() = default;
|
|
|
|
void TaskInspectMaterial::open()
|
|
{}
|
|
|
|
void TaskInspectMaterial::clicked(int)
|
|
{}
|
|
|
|
bool TaskInspectMaterial::accept()
|
|
{
|
|
return widget->accept();
|
|
}
|
|
|
|
#include "moc_DlgInspectMaterial.cpp"
|