Skip to content

ZBuffer

vtk-examples/Cxx/Utilities/ZBuffer

Question

If you have a question about this example, please use the VTK Discourse Forum

Code

ZBuffer.cxx

// This demo creates depth map for a polydata instance by extracting
// exact ZBuffer values.
#include <vtkActor.h>
#include <vtkBMPWriter.h>
#include <vtkImageShiftScale.h>
#include <vtkNamedColors.h>
#include <vtkNew.h>
#include <vtkPolyDataMapper.h>
#include <vtkProperty.h>
#include <vtkRenderWindow.h>
#include <vtkRenderWindowInteractor.h>
#include <vtkRenderer.h>
#include <vtkVersion.h>
#include <vtkWindowToImageFilter.h>
#include <vtkXMLPolyDataReader.h>

int main(int argc, char* argv[])
{
  vtkNew<vtkNamedColors> colors;

  if (argc < 3)
  {
    std::cout << "Usage: " << argv[0] << " input(.vtp) output(.bmp)"
              << std::endl;
    return EXIT_FAILURE;
  }

  vtkNew<vtkPolyDataMapper> mapper;
  vtkNew<vtkActor> actor;
  vtkNew<vtkRenderer> renderer;
  vtkNew<vtkRenderWindow> renWin;
  vtkNew<vtkRenderWindowInteractor> interactor;
  vtkNew<vtkXMLPolyDataReader> fileReader;
  vtkNew<vtkWindowToImageFilter> filter;
  vtkNew<vtkBMPWriter> imageWriter;
  vtkNew<vtkImageShiftScale> scale;

  // Read .vtp file
  fileReader->SetFileName(argv[1]);

  // Build visualization enviroment
  mapper->SetInputConnection(fileReader->GetOutputPort());
  actor->SetMapper(mapper);
  actor->GetProperty()->SetColor(colors->GetColor3d("Tan").GetData());

  renderer->AddActor(actor);
  renderer->SetBackground(colors->GetColor3d("SlateGray").GetData());

  renWin->AddRenderer(renderer);
  renWin->SetWindowName("WindowModifiedEvent");

  interactor->SetRenderWindow(renWin);
  renWin->Render();

  // Create Depth Map
  filter->SetInput(renWin);
#if VTK_MAJOR_VERSION >= 8 || VTK_MAJOR_VERSION == 8 && VTK_MINOR_VERSION >= 90
  filter->SetScale(1);
#else
  filter->SetMagnification(1);
#endif
  filter->SetInputBufferTypeToZBuffer(); // Extract z buffer value

  scale->SetOutputScalarTypeToUnsignedChar();
  scale->SetInputConnection(filter->GetOutputPort());
  scale->SetShift(0);
  scale->SetScale(-255);

  // Write depth map as a .bmp image
  imageWriter->SetFileName(argv[2]);
  imageWriter->SetInputConnection(scale->GetOutputPort());
  imageWriter->Write();

  return EXIT_SUCCESS;
}

CMakeLists.txt

cmake_minimum_required(VERSION 3.3 FATAL_ERROR)

project(ZBuffer)

find_package(VTK COMPONENTS 
  vtkCommonColor
  vtkCommonCore
  vtkIOImage
  vtkIOXML
  vtkImagingCore
  vtkInteractionStyle
  vtkRenderingContextOpenGL2
  vtkRenderingCore
  vtkRenderingFreeType
  vtkRenderingGL2PSOpenGL2
  vtkRenderingOpenGL2
  QUIET
)

if (NOT VTK_FOUND)
  message("Skipping ZBuffer: ${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(ZBuffer MACOSX_BUNDLE ZBuffer.cxx )
  target_link_libraries(ZBuffer PRIVATE ${VTK_LIBRARIES})
else ()
  # include all components
  add_executable(ZBuffer MACOSX_BUNDLE ZBuffer.cxx )
  target_link_libraries(ZBuffer PRIVATE ${VTK_LIBRARIES})
  # vtk_module_autoinit is needed
  vtk_module_autoinit(
    TARGETS ZBuffer
    MODULES ${VTK_LIBRARIES}
    )
endif ()

Download and Build ZBuffer

Click here to download ZBuffer and its CMakeLists.txt file. Once the tarball ZBuffer.tar has been downloaded and extracted,

cd ZBuffer/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:

./ZBuffer

WINDOWS USERS

Be sure to add the VTK bin directory to your path. This will resolve the VTK dll's at run time.