BackgroundImage
VTKEx/Cxx/Images/BackgroundImage
Description¶
This example displays an image as the "background" of a scene, and renders a superquadric in front of it.
The example accepts a jpeg file on the command line to use as a background image. If there is no file, it generates a simple background.
Other languages
See (Python)
Question
If you have a simple question about this example contact us at VTKExProject If your question is more complex and may require extended discussion, please use the VTK Discourse Forum
Code¶
BackgroundImage.cxx
#include <vtkActor.h>
#include <vtkCamera.h>
#include <vtkImageActor.h>
#include <vtkImageCanvasSource2D.h>
#include <vtkImageData.h>
#include <vtkImageReader2.h>
#include <vtkImageReader2Factory.h>
#include <vtkNamedColors.h>
#include <vtkPolyData.h>
#include <vtkPolyDataMapper.h>
#include <vtkRenderWindow.h>
#include <vtkRenderWindowInteractor.h>
#include <vtkRenderer.h>
#include <vtkSmartPointer.h>
#include <vtkSuperquadricSource.h>
#include <array>
int main(int argc, char *argv[]) {
vtkNew<vtkNamedColors> colors;
std::array<unsigned char, 4> lgtCyan = {{100, 255, 255, 255}};
std::array<unsigned char, 4> lgtMagenta = {{255, 100, 255, 255}};
colors->SetColor("light_cyan", lgtCyan.data());
colors->SetColor("light_magenta", lgtMagenta.data());
vtkSmartPointer<vtkImageData> imageData;
// Verify input arguments
if (argc > 1) {
// Read the image
vtkSmartPointer<vtkImageReader2Factory> readerFactory =
vtkSmartPointer<vtkImageReader2Factory>::New();
vtkSmartPointer<vtkImageReader2> imageReader;
imageReader.TakeReference(
readerFactory->CreateImageReader2(argv[1]));
imageReader->SetFileName(argv[1]);
imageReader->Update();
imageData = imageReader->GetOutput();
}
else
{
vtkSmartPointer<vtkImageCanvasSource2D> canvasSource =
vtkSmartPointer<vtkImageCanvasSource2D>::New();
canvasSource->SetExtent(0, 100, 0, 100, 0, 0);
canvasSource->SetScalarTypeToUnsignedChar();
canvasSource->SetNumberOfScalarComponents(3);
canvasSource->SetDrawColor(128, 128, 105);
canvasSource->FillBox(0, 100, 0, 100);
canvasSource->SetDrawColor(100, 255, 255);
canvasSource->FillTriangle(10, 10, 25, 10, 25, 25);
canvasSource->SetDrawColor(255, 100, 255);
canvasSource->FillTube(75, 75, 0, 75, 5.0);
canvasSource->Update();
imageData = canvasSource->GetOutput();
}
// Create an image actor to display the image
vtkSmartPointer<vtkImageActor> imageActor =
vtkSmartPointer<vtkImageActor>::New();
imageActor->SetInputData(imageData);
// Create a renderer to display the image in the background
vtkSmartPointer<vtkRenderer> backgroundRenderer =
vtkSmartPointer<vtkRenderer>::New();
// Create a superquadric
vtkSmartPointer<vtkSuperquadricSource> superquadricSource =
vtkSmartPointer<vtkSuperquadricSource>::New();
superquadricSource->SetPhiRoundness(1.1);
superquadricSource->SetThetaRoundness(.2);
// Create a mapper and actor
vtkSmartPointer<vtkPolyDataMapper> superquadricMapper =
vtkSmartPointer<vtkPolyDataMapper>::New();
superquadricMapper->SetInputConnection(superquadricSource->GetOutputPort());
vtkSmartPointer<vtkActor> superquadricActor =
vtkSmartPointer<vtkActor>::New();
superquadricActor->SetMapper(superquadricMapper);
vtkSmartPointer<vtkRenderer> sceneRenderer =
vtkSmartPointer<vtkRenderer>::New();
vtkSmartPointer<vtkRenderWindow> renderWindow =
vtkSmartPointer<vtkRenderWindow>::New();
// Set up the render window and renderers such that there is
// a background layer and a foreground layer
backgroundRenderer->SetLayer(0);
backgroundRenderer->InteractiveOff();
sceneRenderer->SetLayer(1);
renderWindow->SetNumberOfLayers(2);
renderWindow->AddRenderer(backgroundRenderer);
renderWindow->AddRenderer(sceneRenderer);
vtkSmartPointer<vtkRenderWindowInteractor> renderWindowInteractor =
vtkSmartPointer<vtkRenderWindowInteractor>::New();
renderWindowInteractor->SetRenderWindow(renderWindow);
// Add actors to the renderers
sceneRenderer->AddActor(superquadricActor);
backgroundRenderer->AddActor(imageActor);
// Render once to figure out where the background camera will be
renderWindow->Render();
// Set up the background camera to fill the renderer with the image
double origin[3];
double spacing[3];
int extent[6];
imageData->GetOrigin(origin);
imageData->GetSpacing(spacing);
imageData->GetExtent(extent);
vtkCamera *camera = backgroundRenderer->GetActiveCamera();
camera->ParallelProjectionOn();
double xc = origin[0] + 0.5 * (extent[0] + extent[1]) * spacing[0];
double yc = origin[1] + 0.5 * (extent[2] + extent[3]) * spacing[1];
// double xd = (extent[1] - extent[0] + 1)*spacing[0];
double yd = (extent[3] - extent[2] + 1) * spacing[1];
double d = camera->GetDistance();
camera->SetParallelScale(0.5 * yd);
camera->SetFocalPoint(xc, yc, 0.0);
camera->SetPosition(xc, yc, d);
// Render again to set the correct view
renderWindow->Render();
// Interact with the window
renderWindowInteractor->Start();
return EXIT_SUCCESS;
}
CMakeLists.txt¶
cmake_minimum_required(VERSION 3.3 FATAL_ERROR)
project(BackgroundImage)
find_package(VTK COMPONENTS
vtkvtkCommonColor
vtkvtkCommonCore
vtkvtkCommonDataModel
vtkvtkFiltersSources
vtkvtkIOImage
vtkvtkImagingSources
vtkvtkInteractionStyle
vtkvtkRenderingContextOpenGL2
vtkvtkRenderingCore
vtkvtkRenderingFreeType
vtkvtkRenderingGL2PSOpenGL2
vtkvtkRenderingOpenGL2 QUIET)
if (NOT VTK_FOUND)
message("Skipping BackgroundImage: ${VTK_NOT_FOUND_MESSAGE}")
return ()
endif()
message (STATUS "VTK_VERSION: ${VTK_VERSION}")
if (VTK_VERSION VERSION_LESS "8.90.0")
# old system
include(${VTK_USE_FILE})
add_executable(BackgroundImage MACOSX_BUNDLE BackgroundImage.cxx )
target_link_libraries(BackgroundImage PRIVATE ${VTK_LIBRARIES})
else ()
# include all components
add_executable(BackgroundImage MACOSX_BUNDLE BackgroundImage.cxx )
target_link_libraries(BackgroundImage PRIVATE ${VTK_LIBRARIES})
# vtk_module_autoinit is needed
vtk_module_autoinit(
TARGETS BackgroundImage
MODULES ${VTK_LIBRARIES}
)
endif ()
Download and Build BackgroundImage¶
Click here to download BackgroundImage and its CMakeLists.txt file. Once the tarball BackgroundImage.tar has been downloaded and extracted,
cd BackgroundImage/build
If VTK is 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 ..
Build the project:
make
and run it:
./BackgroundImage
WINDOWS USERS
Be sure to add the VTK bin directory to your path. This will resolve the VTK dll's at run time.