Skip to content

FilterProgress

vtk-examples/Cxx/Developers/FilterProgress

Question

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

Code

FilterProgress.cxx

#include <vtkCallbackCommand.h>
#include <vtkCommand.h>
#include <vtkPoints.h>
#include <vtkPolyData.h>
#include <vtkSmartPointer.h>
#include <vtkSphereSource.h>

#include <vtkTestFilterProgressFilter.h>

void ProgressFunction(vtkObject* caller, long unsigned int eventId,
                      void* clientData, void* callData);

int main(int, char*[])
{
  vtkSmartPointer<vtkSphereSource> sphereSource =
      vtkSmartPointer<vtkSphereSource>::New();
  sphereSource->Update();

  vtkSmartPointer<vtkTestFilterProgressFilter> testFilter =
      vtkSmartPointer<vtkTestFilterProgressFilter>::New();
  testFilter->SetInputConnection(sphereSource->GetOutputPort());
  testFilter->Update();

  return EXIT_SUCCESS;
}

vtkTestFilterProgressFilter.h

#ifndef __vtkTestFilterProgressFilter_h
#define __vtkTestFilterProgressFilter_h

#include <vtkPolyDataAlgorithm.h>

class vtkTestFilterProgressFilter : public vtkPolyDataAlgorithm
{
public:
  static vtkTestFilterProgressFilter* New();
  vtkTypeMacro(vtkTestFilterProgressFilter, vtkAlgorithm);

protected:
  vtkTestFilterProgressFilter();
  ~vtkTestFilterProgressFilter() override;

  int RequestData(vtkInformation*, vtkInformationVector**,
                  vtkInformationVector*) override;

  static void ProgressFunction(vtkObject* caller, long unsigned int eventId,
                               void* clientData, void* callData);

private:
  vtkTestFilterProgressFilter(const vtkTestFilterProgressFilter&) = delete;
  void operator=(const vtkTestFilterProgressFilterr&) = delete;
};

#endif

vtkTestFilterProgressFilter.cxx

#include <vtkSmartPointer.h>

#include <vtkCallbackCommand.h>
#include <vtkDataObject.h>
#include <vtkInformation.h>
#include <vtkInformationVector.h>
#include <vtkObjectFactory.h>
#include <vtkStreamingDemandDrivenPipeline.h>

#include "vtkTestFilterProgressFilter.h"

vtkStandardNewMacro(vtkTestFilterProgressFilter);

vtkTestFilterProgressFilter::vtkTestFilterProgressFilter()
{
  vtkSmartPointer<vtkCallbackCommand> progressCallback =
      vtkSmartPointer<vtkCallbackCommand>::New();
  progressCallback->SetCallback(this->ProgressFunction);

  this->AddObserver(vtkCommand::ProgressEvent, progressCallback);
}

void vtkTestFilterProgressFilter::ProgressFunction(vtkObject* caller,
                                                   long unsigned int eventId,
                                                   void* clientData,
                                                   void* callData)
{
  vtkTestFilterProgressFilterr* testFilter =
      static_cast<vtkTestFilterProgressFilter*>(caller);
  cout << "Progress: " << testFilter->GetProgress() << endl;
}

int vtkTestFilterProgressFilter::RequestData(
    vtkInformation* vtkNotUsed(request), vtkInformationVector** inputVector,
    vtkInformationVector* outputVector)
{

  // get the info objects
  vtkInformation* inInfo = inputVector[0]->GetInformationObject(0);
  vtkInformation* outInfo = outputVector->GetInformationObject(0);

  // get the input and ouptut
  vtkPolyData* input =
      dynamic_cast<vtkPolyData*>(inInfo->Get(vtkDataObject::DATA_OBJECT()));

  vtkPolyData* output =
      dynamic_cast<vtkPolyData*>(outInfo->Get(vtkDataObject::DATA_OBJECT()));

  for (vtkIdType i = 0; i < input->GetNumberOfPoints(); i++)
  {
    this->UpdateProgress(static_cast<double>(i) / input->GetNumberOfPoints());
  }

  output->ShallowCopy(input);

  return 1;
}

CMakeLists.txt

cmake_minimum_required(VERSION 3.12 FATAL_ERROR)

project(FilterProgress)

find_package(VTK COMPONENTS 
  CommonCore
  CommonDataModel
  FiltersSources
)

if (NOT VTK_FOUND)
  message(FATAL_ERROR "FilterProgress: Unable to find the VTK build folder.")
endif()

# 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.")
add_executable(FilterProgress MACOSX_BUNDLE FilterProgress.cxx )
  target_link_libraries(FilterProgress PRIVATE ${VTK_LIBRARIES}
)
# vtk_module_autoinit is needed
vtk_module_autoinit(
  TARGETS FilterProgress
  MODULES ${VTK_LIBRARIES}
)

Download and Build FilterProgress

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

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

./FilterProgress

WINDOWS USERS

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