Implemented help button on model viewer to show help page for selected item in model tree. (#259)

Author: SteveMaas1978

FEBioLink/FEBioClass.cpp

@@ -366,7 +366,7 @@ FEBioClassInfo FEBio::GetClassInfo(int classId)
 	ci.classId = classId;
 	ci.baseClassId = baseClassIndex(fac->GetBaseClassName());
 	ci.sztype = fac->GetTypeStr();
-	ci.szmod = fecore.GetModuleName(modId - 1);
+	ci.szmod = (modId == 0 ? "core" : fecore.GetModuleName(modId - 1));
     ci.superClassName = FECoreKernel::SuperClassString(fac->GetSuperClassID());
 	ci.spec = fac->GetSpecID();
     ci.allocId = fac->GetAllocatorID();

FEBioStudio/DlgAddPhysicsItem.cpp

@@ -232,11 +232,11 @@ void CDlgAddPhysicsItem::UpdateHelpURL()
     {
         int classID = ui->type->currentItem()->data(0, Qt::UserRole).toInt();
 
-        SetURL(classID);
+        SetURL(ClassIDToURL(classID));
     }
     else
     {
-        SetURL(-1);
+		SetURL(QString());
     }
 }
 

FEBioStudio/HelpDialog.cpp

@@ -40,7 +40,6 @@ SOFTWARE.*/
 #include <FEBioLink/FEBioClass.h>
 
 #define MANUAL_PATH "https://febiosoftware.github.io/febio-feature-manual/features/"
-#define UNSELECTED_HELP "unselected_help"
 
 class Ui::CHelpDialog
 {
@@ -74,7 +73,7 @@ class Ui::CHelpDialog
 };
 
 
-CHelpDialog::CHelpDialog(QWidget* parent) : QDialog(parent), ui(new Ui::CHelpDialog), m_url(UNSELECTED_HELP)
+CHelpDialog::CHelpDialog(QWidget* parent) : QDialog(parent), ui(new Ui::CHelpDialog)
 {
 	ui->setupUi(this);
 
@@ -83,17 +82,22 @@ CHelpDialog::CHelpDialog(QWidget* parent) : QDialog(parent), ui(new Ui::CHelpDia
 
 CHelpDialog::~CHelpDialog() { delete ui; }
 
+void ShowHelp(const QString& url)
+{
+	QDesktopServices::openUrl(QUrl(QString(MANUAL_PATH) + url));
+}
+
 void CHelpDialog::on_help_clicked()
 {
     UpdateHelpURL();
 
-    if(m_url == UNSELECTED_HELP)
+    if(m_url.isEmpty())
     {
         QMessageBox::information(this, "Help", "Please select an item before clicking Help.");
     }
     else
     {
-        QDesktopServices::openUrl(QUrl(QString(MANUAL_PATH) + m_url));
+		ShowHelp(m_url);
     }
 }
 
@@ -102,19 +106,23 @@ void CHelpDialog::SetLeftSideLayout(QLayout* layout)
 	ui->helpLayout->insertLayout(0, layout);
 }
 
-void CHelpDialog::SetURL(int classID)
+QString ClassIDToURL(int classID)
 {
-    if(classID == -1)
-    {
-        m_url = UNSELECTED_HELP;
-        return;
-    }
+	QString url;
+	if (classID != -1)
+	{
+		FEBio::FEBioClassInfo classInfo = FEBio::GetClassInfo(classID);
 
-    FEBio::FEBioClassInfo classInfo = FEBio::GetClassInfo(classID);
+		QString superClass = classInfo.superClassName;
+		superClass.remove(0, 2).remove("_ID");
 
-    QString superClass = classInfo.superClassName;
-    superClass.remove(0,2).remove("_ID");
+		QString tmp = QString(classInfo.szmod) + "_" + superClass + "_" + QString(classInfo.sztype);
+		url = tmp.replace(" ", "_").toLower();
+	}
+	return url;
+}
 
-    QString url = QString(classInfo.szmod) + "_" + superClass + "_" + QString(classInfo.sztype);
-    m_url = url.replace(" ", "_").toLower();
-}
+void CHelpDialog::SetURL(const QString& url)
+{
+	m_url = url;
+}

FEBioStudio/HelpDialog.h

@@ -27,8 +27,6 @@ SOFTWARE.*/
 #pragma once
 #include <QDialog>
 
-#define UNSELECTED_HELP "unselected_help"
-
 class QLayout;
 
 namespace Ui {
@@ -52,7 +50,7 @@ protected slots:
 	virtual void UpdateHelpURL() = 0;
 
 protected:
-    void SetURL(int classID);
+    void SetURL(const QString& url);
 
 protected:
 	int		m_module;
@@ -61,3 +59,6 @@ protected slots:
 private:
 	Ui::CHelpDialog* ui;
 };
+
+QString ClassIDToURL(int classID);
+void ShowHelp(const QString& url);

FEBioStudio/ModelViewer.cpp

@@ -60,6 +60,7 @@ SOFTWARE.*/
 #include "FEObjectProps.h"
 #include "GLHighlighter.h"
 #include "Command.h"
+#include "HelpDialog.h" // for ShowHelp
 using namespace std;
 
 class CDlgWarnings : public QDialog
@@ -403,6 +404,44 @@ void CModelViewer::on_refreshButton_clicked()
 	Update(false);
 }
 
+void CModelViewer::on_helpButton_clicked()
+{
+	// make sure we have something selected
+	if (m_currentObject == nullptr)
+	{
+		QMessageBox::information(this, "Help", "No item selected!");
+		return;
+	}
+
+	// find the class ID
+	int classID = -1;
+	GMaterial* gmat = dynamic_cast<GMaterial*>(m_currentObject);
+	if (gmat)
+	{
+		FEBioMaterial* pm = dynamic_cast<FEBioMaterial*>(gmat->GetMaterialProperties());
+		if (pm)
+		{
+			classID = FEBio::GetClassId(pm->GetSuperClassID(), pm->GetTypeString());
+		}
+	}
+	FSModelComponent* pmc = dynamic_cast<FSModelComponent*>(m_currentObject);
+	if (pmc)
+	{
+		classID = FEBio::GetClassId(pmc->GetSuperClassID(), pmc->GetTypeString());
+	}
+
+	// show the help page
+	QString url = ClassIDToURL(classID);
+	if (url.isEmpty())
+	{
+		QMessageBox::critical(this, "Help", "No help available for this item.");
+	}
+	else
+	{
+		ShowHelp(url);
+	}
+}
+
 bool CModelViewer::IsHighlightSelectionEnabled() const
 {
 	return ui->highlightButton->isChecked();

FEBioStudio/ModelViewer.h

@@ -115,6 +115,7 @@ public slots:
 	void on_syncButton_clicked();
 	void on_refreshButton_clicked();
 	void on_highlightButton_toggled(bool);
+	void on_helpButton_clicked();
 	void on_props_nameChanged(const QString& txt);
 	void on_props_selectionChanged();
 	void on_props_dataChanged(bool b);

FEBioStudio/ui_modelviewer.h

@@ -129,6 +129,12 @@ class Ui::CModelViewer
 		highlightButton->setCheckable(true);
 		highlightButton->setChecked(false);
 
+		QToolButton* helpButton = new QToolButton;
+		helpButton->setIcon(QIcon(":/icons/help.png"));
+		helpButton->setObjectName("helpButton");
+		helpButton->setAutoRaise(true);
+		helpButton->setToolTip("<font color=\"black\">Help");
+
 		// filter box
 		m_filter = new QComboBox;
 		m_filter->addItems(QStringList() << "All items" << "Geometry" << "Materials" << "Physics" << "Steps" << "Jobs" << "Studies" << "Images");
@@ -184,6 +190,7 @@ class Ui::CModelViewer
 		buttonLayout->addWidget(srcButton);
 		buttonLayout->addWidget(syncButton);
 		buttonLayout->addWidget(refreshButton);
+		buttonLayout->addWidget(helpButton);
 		buttonLayout->addStretch();
 		buttonLayout->setContentsMargins(0,0,0,0);
 

febiostudio.qrc

@@ -212,5 +212,6 @@
         <file>icons/helix.png</file>
         <file>icons/teapot.png</file>
         <file>icons/foam.png</file>
+        <file>icons/help.png</file>
 	</qresource>
 </RCC>