BorderWidgetQt
vtk-examples/Cxx/Qt/BorderWidgetQt
Description¶
This example draws a border around a region selected with the mouse. Note that the default border color is white - so if you have a white background you will not see anything!
Also see the BorderWidget example.
Question
If you have a question about this example, please use the VTK Discourse Forum
Code¶
BorderWidgetQt.cxx
#include "BorderWidgetQt.h"
#include "ui_BorderWidgetQt.h"
#include <vtkBorderWidget.h>
#include <vtkCommand.h>
#include <vtkGenericOpenGLRenderWindow.h>
#include <vtkNamedColors.h>
#include <vtkNew.h>
#include <vtkPolyDataMapper.h>
#include <vtkProperty.h>
#include <vtkRenderWindow.h>
#include <vtkRenderer.h>
#include <vtkSphereSource.h>
#include <vtkVersion.h>
#if VTK_VERSION_NUMBER >= 89000000000ULL
#define VTK890 1
#endif
class BorderCallback : public vtkCommand
{
public:
BorderCallback()
{
}
static BorderCallback* New()
{
return new BorderCallback;
}
virtual void Execute(vtkObject* vtkNotUsed(caller), unsigned long, void*)
{
// vtkBorderWidget *borderWidget =
// reinterpret_cast<vtkBorderWidget*>(caller);
}
};
// Constructor
BorderWidgetQt::BorderWidgetQt(QWidget* parent)
: QMainWindow(parent), ui(new Ui::BorderWidgetQt)
{
this->ui->setupUi(this);
vtkNew<vtkNamedColors> colors;
vtkNew<vtkGenericOpenGLRenderWindow> renderWindow;
#if VTK890
this->ui->qvtkWidget->setRenderWindow(renderWindow);
#else
this->ui->qvtkWidget->SetRenderWindow(renderWindow);
#endif
// Sphere
vtkNew<vtkSphereSource> sphereSource;
sphereSource->Update();
vtkNew<vtkPolyDataMapper> sphereMapper;
sphereMapper->SetInputConnection(sphereSource->GetOutputPort());
vtkNew<vtkActor> sphereActor;
sphereActor->SetMapper(sphereMapper);
sphereActor->GetProperty()->SetColor(colors->GetColor4d("Tomato").GetData());
// VTK Renderer
vtkNew<vtkRenderer> renderer;
renderer->AddActor(sphereActor);
renderer->SetBackground(colors->GetColor3d("SteelBlue").GetData());
// Connect VTK with Qt
#if VTK890
this->ui->qvtkWidget->renderWindow()->AddRenderer(renderer);
#else
this->ui->qvtkWidget->GetRenderWindow()->AddRenderer(renderer);
#endif
// Add a border widget to the renderer
vtkNew<vtkBorderWidget> bw;
this->BorderWidget = bw;
#if VTK890
this->BorderWidget->SetInteractor(this->ui->qvtkWidget->interactor());
#else
this->BorderWidget->SetInteractor(this->ui->qvtkWidget->GetInteractor());
#endif
this->BorderWidget->On();
}
BorderWidgetQt::~BorderWidgetQt()
{
delete this->ui;
}
BorderWidgetQtDriver.cxx
#include <QApplication>
#include <QSurfaceFormat>
#include <QVTKOpenGLNativeWidget.h>
#include "BorderWidgetQt.h"
int main(int argc, char* argv[])
{
// needed to ensure appropriate OpenGL context is created for VTK rendering.
QSurfaceFormat::setDefaultFormat(QVTKOpenGLNativeWidget::defaultFormat());
QApplication app( argc, argv );
BorderWidgetQt borderWidgetQt;
borderWidgetQt.show();
return app.exec();
}
BorderWidgetQt.ui
<?xml version="1.0" encoding="UTF-8"?>
<ui version="4.0">
<class>BorderWidgetQt</class>
<widget class="QMainWindow" name="BorderWidgetQt">
<property name="geometry">
<rect>
<x>0</x>
<y>0</y>
<width>572</width>
<height>583</height>
</rect>
</property>
<property name="windowTitle">
<string>BorderWidgetQt</string>
</property>
<property name="windowIcon">
<iconset resource="Icons/icons.qrc">
<normaloff>:/Icons/help.png</normaloff>:/Icons/help.png</iconset>
</property>
<property name="iconSize">
<size>
<width>22</width>
<height>22</height>
</size>
</property>
<widget class="QWidget" name="centralwidget">
<widget class="QVTKOpenGLNativeWidget" name="qvtkWidget" native="true">
<property name="geometry">
<rect>
<x>10</x>
<y>20</y>
<width>511</width>
<height>541</height>
</rect>
</property>
</widget>
</widget>
<action name="actionOpenFile">
<property name="enabled">
<bool>true</bool>
</property>
<property name="icon">
<iconset resource="Icons/icons.qrc">
<normaloff>:/Icons/fileopen.png</normaloff>:/Icons/fileopen.png</iconset>
</property>
<property name="text">
<string>Open File...</string>
</property>
</action>
<action name="actionExit">
<property name="icon">
<iconset>
<normaloff/>
</iconset>
</property>
<property name="text">
<string>Exit</string>
</property>
</action>
<action name="actionPrint">
<property name="icon">
<iconset resource="Icons/icons.qrc">
<normaloff>:/Icons/print.png</normaloff>:/Icons/print.png</iconset>
</property>
<property name="text">
<string>Print</string>
</property>
</action>
<action name="actionHelp">
<property name="icon">
<iconset resource="Icons/icons.qrc">
<normaloff>:/Icons/help.png</normaloff>:/Icons/help.png</iconset>
</property>
<property name="text">
<string>Help</string>
</property>
</action>
<action name="actionSave">
<property name="icon">
<iconset resource="Icons/icons.qrc">
<normaloff>:/Icons/filesave.png</normaloff>:/Icons/filesave.png</iconset>
</property>
<property name="text">
<string>Save</string>
</property>
</action>
</widget>
<customwidgets>
<customwidget>
<class>QVTKOpenGLNativeWidget</class>
<extends>QWidget</extends>
<header>QVTKOpenGLNativeWidget.h</header>
</customwidget>
</customwidgets>
<resources>
<include location="Icons/icons.qrc"/>
</resources>
<connections/>
</ui>
BorderWidgetQt.h
#ifndef BorderWidgetQt_H
#define BorderWidgetQt_H
#include <QMainWindow>
#include <vtkSmartPointer.h>
class vtkBorderWidget;
/*
* See "The Single Inheritance Approach" in this link:
* [Using a Designer UI File in Your C++
* Application](https://doc.qt.io/qt-5/designer-using-a-ui-file.html)
*/
namespace Ui {
class BorderWidgetQt;
}
class BorderWidgetQt : public QMainWindow
{
Q_OBJECT
public:
// Constructor/Destructor
explicit BorderWidgetQt(QWidget* parent = nullptr);
virtual ~BorderWidgetQt();
private:
vtkSmartPointer<vtkBorderWidget> BorderWidget;
// Designer form
Ui::BorderWidgetQt* ui;
};
#endif
CMakeLists.txt¶
cmake_minimum_required(VERSION 3.12 FATAL_ERROR)
if(POLICY CMP0020)
cmake_policy(SET CMP0020 NEW)
cmake_policy(SET CMP0071 NEW)
endif()
PROJECT(BorderWidgetQt)
find_package(VTK COMPONENTS
vtkCommonColor
vtkCommonCore
vtkFiltersSources
vtkInteractionStyle
vtkInteractionWidgets
vtkRenderingContextOpenGL2
vtkRenderingCore
vtkRenderingFreeType
vtkRenderingGL2PSOpenGL2
vtkRenderingOpenGL2
vtkGUISupportQt
vtkRenderingQt
QUIET
)
if(NOT VTK_FOUND)
message(FATAL_ERROR "BorderWidgetQt: ${VTK_NOT_FOUND_MESSAGE}")
endif()
if(NOT(vtkGUISupportQt_LOADED OR TARGET VTK::GUISupportQt))
message(FATAL_ERROR "BorderWidgetQt: VTK not built with Qt support.")
endif()
if(NOT DEFINED VTK_QT_VERSION)
set(VTK_QT_VERSION 5)
endif()
set(qt_components Core Gui Widgets)
if(${VTK_QT_VERSION} VERSION_GREATER_EQUAL 6)
list(APPEND qt_components OpenGLWidgets)
endif()
list(SORT qt_components)
# We have ui files, so this will also bring in the macro:
# qt5_wrap_ui or qt_wrap_ui from Widgets.
find_package(Qt${VTK_QT_VERSION} QUIET
REQUIRED COMPONENTS ${qt_components}
)
foreach(_qt_comp IN LISTS qt_components)
list(APPEND qt_modules "Qt${VTK_QT_VERSION}::${_qt_comp}")
endforeach()
message (STATUS "VTK_VERSION: ${VTK_VERSION}, Qt Version: ${Qt${VTK_QT_VERSION}Widgets_VERSION}")
if (VTK_VERSION VERSION_LESS "8.90.0")
# Instruct CMake to run moc automatically when needed.
set(CMAKE_AUTOMOC ON)
else()
# Instruct CMake to run moc and uic automatically when needed.
set(CMAKE_AUTOMOC ON)
set(CMAKE_AUTOUIC ON)
endif()
include_directories(${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR})
file(GLOB UI_FILES *.ui)
file(GLOB QT_WRAP *.h)
file(GLOB CXX_FILES *.cxx)
# For VTK versions greater than or equal to 8.90.0:
# CMAKE_AUTOUIC is ON so we handle uic automatically for Qt targets.
# CMAKE_AUTOMOC is ON so we handle moc automatically for Qt targets.
# However we have to do the following for VTK versions less than 8.90.0,
# and we also assume, in this case, that Qt5 is being used.
if (VTK_VERSION VERSION_LESS "8.90.0")
qt5_wrap_ui(UISrcs ${EXAMPLE}.ui)
endif()
if (VTK_VERSION VERSION_LESS "8.90.0")
# old system
include(${VTK_USE_FILE})
# CMAKE_AUTOMOC in ON so the MOC headers will be automatically wrapped.
add_executable(BorderWidgetQt MACOSX_BUNDLE
${CXX_FILES} ${UISrcs} ${QT_WRAP})
if (Qt${VTK_QT_VERSION}Widgets_VERSION VERSION_LESS "5.11.0")
qt5_use_modules(BorderWidgetQt ${qt_components})
else()
target_link_libraries(BorderWidgetQt ${qt_modules})
endif()
target_link_libraries(BorderWidgetQt ${VTK_LIBRARIES})
else()
# Prevent a "command line is too long" failure in Windows.
set(CMAKE_NINJA_FORCE_RESPONSE_FILE "ON" CACHE BOOL "Force Ninja to use response files.")
# CMAKE_AUTOMOC in ON so the MOC headers will be automatically wrapped.
add_executable(BorderWidgetQt MACOSX_BUNDLE
${CXX_FILES} ${UISrcs} ${QT_WRAP})
if (Qt${VTK_QT_VERSION}Widgets_VERSION VERSION_LESS "5.11.0")
qt5_use_modules(BorderWidgetQt ${qt_components})
else()
target_link_libraries(BorderWidgetQt ${qt_modules})
endif()
target_link_libraries(BorderWidgetQt ${VTK_LIBRARIES})
# vtk_module_autoinit is needed
vtk_module_autoinit(
TARGETS BorderWidgetQt
MODULES ${VTK_LIBRARIES}
)
endif()
Download and Build BorderWidgetQt¶
Click here to download BorderWidgetQt and its CMakeLists.txt file. Once the tarball BorderWidgetQt.tar has been downloaded and extracted,
cd BorderWidgetQt/build
This example requires Qt and VTK.
If VTK and Qt are installed:
cmake ..
If VTK is not installed but compiled on your system, you will need to specify the path to your VTK build:
cmake -DVTK_DIR:PATH=/home/me/vtk_build ..
If Qt is not found on your system, you will need to tell CMake where to find qmake:
cmake -DQT_QMAKE_EXECUTABLE:FILEPATH=/usr/something/qmake ..
Build the project:
make
and run it:
./BorderWidgetQt
WINDOWS USERS
Be sure to add the VTK bin directory to your path. This will resolve the VTK dll's at run time. You may also need to add a Qt related path.