ENH: Initial VR home widget implementation

CMakeLists.txt

@@ -57,6 +57,8 @@ endif()
 #-----------------------------------------------------------------------------
 # Extension modules
 add_subdirectory(VirtualReality)
+add_subdirectory(GUIWidgets)
+add_subdirectory(PointerSimulator)
 ## NEXT_MODULE
 
 #-----------------------------------------------------------------------------

GUIWidgets/CMakeLists.txt

@@ -0,0 +1,81 @@
+
+#-----------------------------------------------------------------------------
+set(MODULE_NAME GUIWidgets)
+set(MODULE_TITLE ${MODULE_NAME})
+
+string(TOUPPER ${MODULE_NAME} MODULE_NAME_UPPER)
+
+#-----------------------------------------------------------------------------
+add_subdirectory(MRML)
+add_subdirectory(Logic)
+add_subdirectory(VTKWidgets)
+# add_subdirectory(MRMLDM)
+# add_subdirectory(Widgets)
+
+#-----------------------------------------------------------------------------
+set(MODULE_EXPORT_DIRECTIVE "Q_SLICER_QTMODULES_${MODULE_NAME_UPPER}_EXPORT")
+
+# Current_{source,binary} and Slicer_{Libs,Base} already included
+set(MODULE_INCLUDE_DIRECTORIES
+  ${CMAKE_CURRENT_SOURCE_DIR}/MRML
+  ${CMAKE_CURRENT_BINARY_DIR}/MRML
+  ${CMAKE_CURRENT_SOURCE_DIR}/Logic
+  ${CMAKE_CURRENT_BINARY_DIR}/Logic
+  ${CMAKE_CURRENT_SOURCE_DIR}/VTKWidgets
+  ${CMAKE_CURRENT_BINARY_DIR}/VTKWidgets
+  # ${CMAKE_CURRENT_SOURCE_DIR}/Widgets
+  # ${CMAKE_CURRENT_BINARY_DIR}/Widgets
+  ${qSlicerMarkupsModuleWidgets_INCLUDE_DIRS}
+  ${qSlicerVirtualRealityModuleWidgets_INCLUDE_DIRS}
+  )
+
+set(MODULE_SRCS
+  qSlicer${MODULE_NAME}Module.cxx
+  qSlicer${MODULE_NAME}Module.h
+  qSlicer${MODULE_NAME}ModuleWidget.cxx
+  qSlicer${MODULE_NAME}ModuleWidget.h
+  )
+
+set(MODULE_MOC_SRCS
+  qSlicer${MODULE_NAME}Module.h
+  qSlicer${MODULE_NAME}ModuleWidget.h
+  )
+
+set(MODULE_UI_SRCS
+  Resources/UI/qSlicer${MODULE_NAME}ModuleWidget.ui
+  )
+
+set(MODULE_TARGET_LIBRARIES
+  vtkSlicer${MODULE_NAME}ModuleMRML
+  vtkSlicer${MODULE_NAME}ModuleLogic
+  vtkSlicer${MODULE_NAME}ModuleVTKWidgets
+  # vtkSlicer${MODULE_NAME}ModuleMRMLDisplayableManager
+  # qSlicer${MODULE_NAME}ModuleWidgets
+  vtkSlicerMarkupsModuleMRMLDisplayableManager
+  qSlicerMarkupsModuleWidgets
+  qSlicerVirtualRealityModuleWidgets
+  vtkSlicerVirtualRealityModuleLogic
+  )
+
+set(MODULE_RESOURCES
+  Resources/qSlicer${MODULE_NAME}Module.qrc
+  )
+
+#-----------------------------------------------------------------------------
+slicerMacroBuildLoadableModule(
+  NAME ${MODULE_NAME}
+  TITLE ${MODULE_TITLE}
+  EXPORT_DIRECTIVE ${MODULE_EXPORT_DIRECTIVE}
+  INCLUDE_DIRECTORIES ${MODULE_INCLUDE_DIRECTORIES}
+  SRCS ${MODULE_SRCS}
+  MOC_SRCS ${MODULE_MOC_SRCS}
+  UI_SRCS ${MODULE_UI_SRCS}
+  TARGET_LIBRARIES ${MODULE_TARGET_LIBRARIES}
+  RESOURCES ${MODULE_RESOURCES}
+  WITH_GENERIC_TESTS
+  )
+
+#-----------------------------------------------------------------------------
+if(BUILD_TESTING)
+  add_subdirectory(Testing)
+endif()

GUIWidgets/Logic/CMakeLists.txt

@@ -0,0 +1,27 @@
+project(vtkSlicer${MODULE_NAME}ModuleLogic)
+
+set(KIT ${PROJECT_NAME})
+
+set(${KIT}_EXPORT_DIRECTIVE "VTK_SLICER_${MODULE_NAME_UPPER}_MODULE_LOGIC_EXPORT")
+
+set(${KIT}_INCLUDE_DIRECTORIES
+  )
+
+set(${KIT}_SRCS
+  vtkSlicer${MODULE_NAME}Logic.cxx
+  vtkSlicer${MODULE_NAME}Logic.h
+  )
+
+set(${KIT}_TARGET_LIBRARIES
+  vtkSlicer${MODULE_NAME}ModuleMRML
+  vtkSlicerMarkupsModuleLogic
+  )
+
+#-----------------------------------------------------------------------------
+SlicerMacroBuildModuleLogic(
+  NAME ${KIT}
+  EXPORT_DIRECTIVE ${${KIT}_EXPORT_DIRECTIVE}
+  INCLUDE_DIRECTORIES ${${KIT}_INCLUDE_DIRECTORIES}
+  SRCS ${${KIT}_SRCS}
+  TARGET_LIBRARIES ${${KIT}_TARGET_LIBRARIES}
+  )

GUIWidgets/Logic/vtkSlicerGUIWidgetsLogic.cxx

@@ -0,0 +1,143 @@
+/*==============================================================================
+
+  Program: 3D Slicer
+
+  Portions (c) Copyright Brigham and Women's Hospital (BWH) All Rights Reserved.
+
+  See COPYRIGHT.txt
+  or http://www.slicer.org/copyright/copyright.txt for details.
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+==============================================================================*/
+
+// GUIWidgets Logic includes
+#include "vtkSlicerGUIWidgetsLogic.h"
+
+// GUIWidgets MRML includes
+#include "vtkMRMLGUIWidgetNode.h"
+#include "vtkMRMLGUIWidgetDisplayNode.h"
+
+// MRML includes
+#include <vtkMRMLScene.h>
+#include <vtkMRMLSelectionNode.h>
+
+// Markups logic includes
+#include <vtkSlicerMarkupsLogic.h>
+
+// VTK includes
+#include <vtkIntArray.h>
+#include <vtkNew.h>
+#include <vtkObjectFactory.h>
+
+// STD includes
+#include <cassert>
+
+//----------------------------------------------------------------------------
+vtkStandardNewMacro(vtkSlicerGUIWidgetsLogic);
+
+//----------------------------------------------------------------------------
+vtkSlicerGUIWidgetsLogic::vtkSlicerGUIWidgetsLogic()
+{
+}
+
+//----------------------------------------------------------------------------
+vtkSlicerGUIWidgetsLogic::~vtkSlicerGUIWidgetsLogic()
+{
+}
+
+//----------------------------------------------------------------------------
+void vtkSlicerGUIWidgetsLogic::PrintSelf(ostream& os, vtkIndent indent)
+{
+  this->Superclass::PrintSelf(os, indent);
+}
+
+//---------------------------------------------------------------------------
+void vtkSlicerGUIWidgetsLogic::SetMRMLSceneInternal(vtkMRMLScene * newScene)
+{
+  vtkNew<vtkIntArray> events;
+  events->InsertNextValue(vtkMRMLScene::NodeAddedEvent);
+  events->InsertNextValue(vtkMRMLScene::NodeRemovedEvent);
+  events->InsertNextValue(vtkMRMLScene::EndBatchProcessEvent);
+  this->SetAndObserveMRMLSceneEventsInternal(newScene, events.GetPointer());
+}
+
+//---------------------------------------------------------------------------
+void vtkSlicerGUIWidgetsLogic::ObserveMRMLScene()
+{
+  if (!this->GetMRMLScene())
+  {
+    return;
+  }
+
+  vtkMRMLApplicationLogic* mrmlAppLogic = this->GetMRMLApplicationLogic();
+  if (!mrmlAppLogic)
+  {
+    vtkErrorMacro("ObserveMRMLScene: invalid MRML Application Logic");
+    return;
+  }
+
+  vtkMRMLNode* node = this->GetMRMLScene()->GetNodeByID(this->GetSelectionNodeID().c_str());
+  if (!node)
+  {
+    vtkErrorMacro("Observe MRMLScene: invalid Selection Node");
+    return;
+  }
+
+  // add known markup types to the selection node
+  vtkMRMLSelectionNode* selectionNode = vtkMRMLSelectionNode::SafeDownCast(node);
+  if (selectionNode)
+  {
+    // got into batch process mode so that an update on the mouse mode tool
+    // bar is triggered when leave it
+    this->GetMRMLScene()->StartState(vtkMRMLScene::BatchProcessState);
+
+    auto guiWidgetNode = vtkSmartPointer<vtkMRMLGUIWidgetNode>::New();
+    selectionNode->AddNewPlaceNodeClassNameToList(
+      guiWidgetNode->GetClassName(), guiWidgetNode->GetAddIcon(), guiWidgetNode->GetMarkupType());
+
+    // trigger an update on the mouse mode toolbar
+    this->GetMRMLScene()->EndState(vtkMRMLScene::BatchProcessState);
+  }
+
+ this->Superclass::ObserveMRMLScene();
+}
+
+//-----------------------------------------------------------------------------
+void vtkSlicerGUIWidgetsLogic::RegisterNodes()
+{
+  vtkMRMLScene* scene = this->GetMRMLScene(); 
+  if (!scene)
+  {
+    vtkErrorMacro("RegisterNodes: Invalid MRML scene");
+    return;
+  }
+  if (!scene->IsNodeClassRegistered("vtkMRMLGUIWidgetNode"))
+  {
+    scene->RegisterNodeClass(vtkSmartPointer<vtkMRMLGUIWidgetNode>::New());
+  }
+  if (!scene->IsNodeClassRegistered("vtkMRMLGUIWidgetDisplayNode"))
+  {
+    scene->RegisterNodeClass(vtkSmartPointer<vtkMRMLGUIWidgetDisplayNode>::New());
+  }
+}
+
+//---------------------------------------------------------------------------
+void vtkSlicerGUIWidgetsLogic::UpdateFromMRMLScene()
+{
+  assert(this->GetMRMLScene() != 0);
+}
+
+//---------------------------------------------------------------------------
+void vtkSlicerGUIWidgetsLogic::OnMRMLSceneNodeAdded(vtkMRMLNode* vtkNotUsed(node))
+{
+}
+
+//---------------------------------------------------------------------------
+void vtkSlicerGUIWidgetsLogic::OnMRMLSceneNodeRemoved(vtkMRMLNode* vtkNotUsed(node))
+{
+}

GUIWidgets/Logic/vtkSlicerGUIWidgetsLogic.h

@@ -0,0 +1,63 @@
+/*==============================================================================
+
+  Program: 3D Slicer
+
+  Portions (c) Copyright Brigham and Women's Hospital (BWH) All Rights Reserved.
+
+  See COPYRIGHT.txt
+  or http://www.slicer.org/copyright/copyright.txt for details.
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+==============================================================================*/
+
+// .NAME vtkSlicerGUIWidgetsLogic - slicer logic class for volumes manipulation
+// .SECTION Description
+// This class manages the logic associated with reading, saving,
+// and changing propertied of the volumes
+
+
+#ifndef __vtkSlicerGUIWidgetsLogic_h
+#define __vtkSlicerGUIWidgetsLogic_h
+
+// Slicer includes
+#include <vtkSlicerMarkupsLogic.h>
+
+// MRML includes
+
+#include "vtkSlicerGUIWidgetsModuleLogicExport.h"
+
+/// \ingroup Slicer_QtModules_ExtensionTemplate
+class VTK_SLICER_GUIWIDGETS_MODULE_LOGIC_EXPORT vtkSlicerGUIWidgetsLogic :
+  public vtkSlicerMarkupsLogic
+{
+public:
+
+  static vtkSlicerGUIWidgetsLogic *New();
+  vtkTypeMacro(vtkSlicerGUIWidgetsLogic, vtkSlicerMarkupsLogic);
+  void PrintSelf(ostream& os, vtkIndent indent) override;
+
+protected:
+  vtkSlicerGUIWidgetsLogic();
+  virtual ~vtkSlicerGUIWidgetsLogic();
+
+  /// Initialize listening to MRML events
+  void SetMRMLSceneInternal(vtkMRMLScene* newScene) override;
+  void ObserveMRMLScene() override;
+
+  /// Register MRML Node classes to Scene. Gets called automatically when the MRMLScene is attached to this logic class.
+  void RegisterNodes() override;
+  void UpdateFromMRMLScene() override;
+  void OnMRMLSceneNodeAdded(vtkMRMLNode* node) override;
+  void OnMRMLSceneNodeRemoved(vtkMRMLNode* node) override;
+private:
+
+  vtkSlicerGUIWidgetsLogic(const vtkSlicerGUIWidgetsLogic&); // Not implemented
+  void operator=(const vtkSlicerGUIWidgetsLogic&); // Not implemented
+};
+
+#endif

GUIWidgets/MRML/CMakeLists.txt

@@ -0,0 +1,29 @@
+project(vtkSlicer${MODULE_NAME}ModuleMRML)
+
+set(KIT ${PROJECT_NAME})
+
+set(${KIT}_EXPORT_DIRECTIVE "VTK_SLICER_${MODULE_NAME_UPPER}_MODULE_MRML_EXPORT")
+
+set(${KIT}_INCLUDE_DIRECTORIES
+  ${vtkSlicer${MODULE_NAME}ModuleVTKWidgets_SOURCE_DIR}
+  ${vtkSlicer${MODULE_NAME}ModuleVTKWidgets_BINARY_DIR}
+  )
+
+set(${KIT}_SRCS
+  vtkMRMLGUIWidgetNode.cxx
+  vtkMRMLGUIWidgetDisplayNode.cxx
+  )
+
+set(${KIT}_TARGET_LIBRARIES
+  ${MRML_LIBRARIES}
+  vtkSlicerMarkupsModuleMRML
+  )
+
+#-----------------------------------------------------------------------------
+SlicerMacroBuildModuleMRML(
+  NAME ${KIT}
+  EXPORT_DIRECTIVE ${${KIT}_EXPORT_DIRECTIVE}
+  INCLUDE_DIRECTORIES ${${KIT}_INCLUDE_DIRECTORIES}
+  SRCS ${${KIT}_SRCS}
+  TARGET_LIBRARIES ${${KIT}_TARGET_LIBRARIES}
+  )

GUIWidgets/MRML/vtkMRMLGUIWidgetDisplayNode.cxx

@@ -0,0 +1,35 @@
+/*==============================================================================
+
+  Program: 3D Slicer
+
+  Portions (c) Copyright Brigham and Women's Hospital (BWH) All Rights Reserved.
+
+  See COPYRIGHT.txt
+  or http://www.slicer.org/copyright/copyright.txt for details.
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+  This file was originally developed by Csaba Pinter, EBATINCA, S.L., and
+  development was supported by "ICEX Espana Exportacion e Inversiones" under
+  the program "Inversiones de Empresas Extranjeras en Actividades de I+D
+  (Fondo Tecnologico)- Convocatoria 2021"
+
+==============================================================================*/
+
+// MRML includes
+#include "vtkMRMLGUIWidgetDisplayNode.h"
+
+//----------------------------------------------------------------------------
+vtkMRMLNodeNewMacro(vtkMRMLGUIWidgetDisplayNode);
+
+//----------------------------------------------------------------------------
+vtkMRMLGUIWidgetDisplayNode::vtkMRMLGUIWidgetDisplayNode()
+{
+}
+
+//----------------------------------------------------------------------------
+vtkMRMLGUIWidgetDisplayNode::~vtkMRMLGUIWidgetDisplayNode() = default;