Custom Control Object Dialog

The DtCustomControlObjectDefinitionDialog and its associated logic and creator classes handles the creation, definition and function of the dialog associated with the creation of the custom control object. The dialog is derived from the DtShapeObjectDefinitionDialog and modified to display GUI elements allowing the user to input the custom parameters.

---

customControlObjectDefinitionDialog.h Header file

/******************************************************************************
** Copyright (c) 2021 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/

//\file DtCustomControlObjectDialog.h
//\brief Contains DtCustomControlObjectDialog class.

#pragma once

#include <vrfGuiCoreQt/shapeObjectDefinitionDialog.h>
#include <vlpi/entityType.h>
#include <vrvCore/DtUniqueID.h>
#include <string>

class QLineEdit;

namespace vrfCustomControlObjectExample
{
   class DtCustomControlObjectDefinitionDialog;

   const DtEntityType DtCustomControlObjectType = DtEntityType(18,-1,-1,1,0,0,101);

   class DtCustomControlObjectDefinitionDialogLogic : public makVrf::DtShapeObjectDefinitionDialogLogic
   {
   public:
      DtCustomControlObjectDefinitionDialogLogic(makVrv::DtDe& de, DtCustomControlObjectDefinitionDialog* iface);

      virtual ~DtCustomControlObjectDefinitionDialogLogic() override;

      virtual void setUserData(const std::string);

      virtual std::string userData();

      virtual void processUserDataChanged();

      virtual void processPopulateDialog(const makVrv::DtUniqueID& id) override;

   protected:

      DtCustomControlObjectDefinitionDialog* myCustomDialog;

   };


   class DtCustomControlObjectDefinitionDialog : public makVrf::DtShapeObjectDefinitionDialog
   {
      Q_OBJECT

   public:
      DtCustomControlObjectDefinitionDialog(makVrv::DtDe& de, QWidget* parent, const QString& title="", DtDialogInteractionMode mode=DtCreationMode);

      virtual ~DtCustomControlObjectDefinitionDialog() override;

      virtual int parameterOne();

      virtual double parameterTwo();

      virtual void setParameterOne(int);

      virtual void setParameterTwo(double);

   protected:

      virtual void setupGui() override;

      virtual void setupConnections() override;

      virtual makVrf::DtShapeObjectDefinitionDialogLogic* createLogic() override;

   protected slots:

      void slot_onUserDataChanged();

   protected:
      QLineEdit* myParamOneLineEdit;
      QLineEdit* myParamTwoLineEdit;
    };


   class DtCustomControlObjectDefinitionDialogCreator : public makVrf::DtShapeObjectDefinitionDialogCreator
   {
   public:
      virtual makVrf::DtCreateAndEditObjectDialogInterface* createDialog(makVrv::DtDe& de, QWidget* parent,
         const QString& title, makVrf::DtCreateAndEditObjectDialogInterface::DtDialogInteractionMode mode) override;
   };
}

---

customControlObjectDefinitionDialog.cxx

/******************************************************************************
** Copyright (c) 2013 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/

//\file DtCustomControlObjectDialog.cxx
//\brief Contains DtCustomControlObjectDialog

#include <vrfGuiCoreQt/shapeObjectDefinitionDialog.h>

#include "customControlObjectDefinitionDialog.h"

#include <vrvCore/DtDeSharedState.h>
#include <vrvCoreQt/DtQtDeMainWindow.h>
#include <vlpi/entityType.h>
#include <vrvCore/DtUniqueID.h>
#include <vrfGuiCore/vrfShapeManipulationHandler.h>
#include <vlutil/vlString.h>
#include <vrfStateData/environmentalStateComponent.h>
#include <vrfGuiCore/vrfGuiSimObjectManager.h>

// Qt includes
#include <QBoxLayout>
#include <QLabel>
#include <QLineEdit>
#include <QDoubleValidator>
#include <QIntValidator>

using namespace makVrf;

//The Logic class should 
namespace vrfCustomControlObjectExample
{
   DtCustomControlObjectDefinitionDialogLogic::DtCustomControlObjectDefinitionDialogLogic(makVrv::DtDe& de, DtCustomControlObjectDefinitionDialog* iface)
      : DtShapeObjectDefinitionDialogLogic(de, iface)
      , myCustomDialog(iface)
   {

   }

   DtCustomControlObjectDefinitionDialogLogic::~DtCustomControlObjectDefinitionDialogLogic()
   {
      myCustomDialog = 0;
   }

   void DtCustomControlObjectDefinitionDialogLogic::setUserData(const std::string userData)
   {
      if (userData == "")
      {
         return;
      }

      DtString firstString(userData.c_str());
      DtString secondString(userData.c_str());
      firstString.snipBack(',');
      secondString.snipFront(',');

       myCustomDialog->setParameterOne(firstString.toInt());
       myCustomDialog->setParameterTwo(secondString.toDouble());
   }

   std::string DtCustomControlObjectDefinitionDialogLogic::userData()
   {
      DtString fullString(myCustomDialog->parameterOne());
      fullString = fullString + "," + myCustomDialog->parameterTwo();
      return fullString.c_str();
   }

   void DtCustomControlObjectDefinitionDialogLogic::processUserDataChanged()
   {
      //This code is executed when either of the userData fields are modified
      DtVrfShapeManipulationHandler* handler = dynamic_cast<DtVrfShapeManipulationHandler*>
         (DtVrfObjectManipulationManager::instance(myDe).currentObjectManipulationHandler());

      handler->setUserData(userData());
   }

   void DtCustomControlObjectDefinitionDialogLogic::processPopulateDialog(const makVrv::DtUniqueID& id )
   {
      DtShapeObjectDefinitionDialogLogic::processPopulateDialog(id);

      DtSimObjectReference ref = DtVrfGuiSimObjectManager::instance(myDe).lookup(id);

      if (ref.isValid())
      {
         setUserData(ref->getStateComponent<DtEnvironmentalStateComponent>()->userData().c_str());
      }

   }

   //========Dialog class ===============

   DtCustomControlObjectDefinitionDialog::DtCustomControlObjectDefinitionDialog(makVrv::DtDe& de, QWidget* parent, 
      const QString& title, DtDialogInteractionMode mode)         
      :DtShapeObjectDefinitionDialog(de, parent, title,  mode)
      , myParamOneLineEdit(0)
      , myParamTwoLineEdit(0)
   {
   } 

   DtCustomControlObjectDefinitionDialog::~DtCustomControlObjectDefinitionDialog()
   {
      disconnect(myParamTwoLineEdit, SIGNAL(textChanged(const QString&)), 
         this, SLOT(slot_onUserDataChanged()));
      disconnect(myParamOneLineEdit, SIGNAL(textChanged(const QString&)), 
         this, SLOT(slot_onUserDataChanged()));
      myParamOneLineEdit = 0;
      myParamTwoLineEdit = 0;
   }

   DtShapeObjectDefinitionDialogLogic* DtCustomControlObjectDefinitionDialog::
      createLogic()
   {
      return new DtCustomControlObjectDefinitionDialogLogic(myDe, this);
   }

   void DtCustomControlObjectDefinitionDialog::setupConnections()
   {
      DtShapeObjectDefinitionDialog::setupConnections();
      connect(myParamOneLineEdit, SIGNAL(textChanged(const QString&)), 
         this, SLOT(slot_onUserDataChanged()));
      connect(myParamTwoLineEdit, SIGNAL(textChanged(const QString&)), 
         this, SLOT(slot_onUserDataChanged()));
   }

   void DtCustomControlObjectDefinitionDialog::slot_onUserDataChanged()
   {
      DtCustomControlObjectDefinitionDialogLogic* logic = 
         dynamic_cast<DtCustomControlObjectDefinitionDialogLogic*>(myLogic);
      if (logic)
      {
         logic->processUserDataChanged();
      }
   }

   int DtCustomControlObjectDefinitionDialog::parameterOne()
   {
      return myParamOneLineEdit->text().toInt();
   }

   double DtCustomControlObjectDefinitionDialog::parameterTwo()
   {
      return myParamTwoLineEdit->text().toDouble();
   }

   void DtCustomControlObjectDefinitionDialog::setParameterOne(int inParameterOne)
   {
      myParamOneLineEdit->setText(QString::number(inParameterOne));
   }

   void DtCustomControlObjectDefinitionDialog::setParameterTwo(double inParameterTwo)
   {
      myParamTwoLineEdit->setText(QString::number(inParameterTwo));
   }

   void DtCustomControlObjectDefinitionDialog::setupGui()
   {
      DtShapeObjectDefinitionDialog::setupGui();

      //Create an Hbox to be inserted
      QHBoxLayout* myQtHboxForParams = new QHBoxLayout();
      myQtHboxForParams->setObjectName(QString::fromUtf8("myQtHboxForParams"));

      //Add and populate parameter one label
      QLabel* myParamOneLabel = new QLabel();
      myParamOneLabel->setObjectName(QString::fromUtf8("myParamOneLabel"));
      myParamOneLabel->setToolTip(QApplication::translate("myUiImpl", 
         "Custom integer parameter.", 0));
      myParamOneLabel->setText(QApplication::translate("myUiImpl", 
         "Integer:", 0));

      //Add a lineEdit box for parameter one
      myParamOneLineEdit = new QLineEdit();
      myParamOneLineEdit->setObjectName(QString::fromUtf8("myParamOneLineEdit"));
      myParamOneLineEdit->setValidator(new QIntValidator(myParamOneLineEdit));

      //Add and populate parameter Two label
      QLabel* myParamTwoLabel = new QLabel();
      myParamTwoLabel->setObjectName(QString::fromUtf8("myParamTwoLabel"));
      myParamTwoLabel->setToolTip(QApplication::translate("myUiImpl", 
         "Custom double parameter.", 0));
      myParamTwoLabel->setText(QApplication::translate("myUiImpl", 
         "Double:", 0));

      //Add a lineEdit box for parameter Two
      myParamTwoLineEdit = new QLineEdit();
      myParamTwoLineEdit->setObjectName(QString::fromUtf8("myParamTwoLineEdit"));
      myParamTwoLineEdit->setValidator(new QDoubleValidator(myParamTwoLineEdit));

      //Put these elements into the Hbox
      myQtHboxForParams->addWidget(myParamOneLabel);
      myQtHboxForParams->addWidget(myParamOneLineEdit);
      myQtHboxForParams->addWidget(myParamTwoLabel);
      myQtHboxForParams->addWidget(myParamTwoLineEdit);

      //insert the new Hbox into the UI
      myUiImpl.verticalLayout->insertLayout(4,myQtHboxForParams);
   }

   //===============CREATOR CLASS=========================
   DtCreateAndEditObjectDialogInterface* DtCustomControlObjectDefinitionDialogCreator::createDialog(makVrv::DtDe& de, QWidget* parent, const QString& title,
      DtCreateAndEditObjectDialogInterface::DtDialogInteractionMode mode)
   {
      return new DtCustomControlObjectDefinitionDialog(de, parent, title, mode);
   }
}