ImplicitDataSetClipping
Repository source: ImplicitDataSetClipping
Description¶
This example demonstrates how to clip one object with another.
Other languages
See (PythonicAPI)
Question
If you have a question about this example, please use the VTK Discourse Forum
Code¶
ImplicitDataSetClipping.cxx
#include <vtkActor.h>
#include <vtkBox.h>
#include <vtkCamera.h>
#include <vtkCellData.h>
#include <vtkClipPolyData.h>
#include <vtkCubeSource.h>
#include <vtkDataSetWriter.h>
#include <vtkIdTypeArray.h>
#include <vtkNamedColors.h>
#include <vtkNew.h>
#include <vtkPolyDataMapper.h>
#include <vtkProperty.h>
#include <vtkRenderWindow.h>
#include <vtkRenderWindowInteractor.h>
#include <vtkRenderer.h>
#include <vtkSphereSource.h>
#include <vtkVersion.h>
#include <vtkXMLPolyDataWriter.h>
#if VTK_VERSION_NUMBER >= 89000000000ULL
#define VTK890 1
#endif
// vtkGenerateIds was introduced in VTK build version 20240504
#if VTK_BUILD_VERSION >= 20240504
#define USE_USE_GENERATE_IDS
#include <vtkGenerateIds.h>
#else
#include <vtkIdFilter.h>
#endif
#include <iostream>
#include <string>
namespace {
void WritePolyData(vtkPolyData* const polyData, const std::string& filename);
void WriteDataSet(vtkDataSet* const dataSet, const std::string& filename);
} // namespace
int main(int, char*[])
{
vtkNew<vtkNamedColors> colors;
// colors->SetColor("Bkg", 0.2, 0.3, 0.4);
vtkNew<vtkSphereSource> sphereSource;
sphereSource->SetCenter(.75, 0, 0);
unsigned int res = 10;
sphereSource->SetThetaResolution(res);
sphereSource->SetPhiResolution(res);
sphereSource->Update();
std::cout << "The sphere has "
<< sphereSource->GetOutput()->GetNumberOfPoints() << " points."
<< " and " << sphereSource->GetOutput()->GetNumberOfCells()
<< " cells. " << std::endl;
// Add ids to the points and cells of the sphere.
#ifdef USE_USE_GENERATE_IDS
vtkNew<vtkGenerateIds> cellIdFilter;
#else
vtkNew<vtkIdFilter> cellIdFilter;
#endif
cellIdFilter->SetInputConnection(sphereSource->GetOutputPort());
cellIdFilter->SetCellIds(true);
cellIdFilter->SetPointIds(false);
#if VTK890
cellIdFilter->SetCellIdsArrayName("CellIds");
#else
cellIdFilter->SetIdsArrayName("CellIds");
#endif
cellIdFilter->Update();
#ifdef USE_USE_GENERATE_IDS
WriteDataSet(cellIdFilter->GetPolyDataOutput(), "CellIdFilter.vtp");
#else
WriteDataSet(cellIdFilter->GetOutput(), "CellIdFilter.vtp");
#endif
#ifdef USE_USE_GENERATE_IDS
vtkNew<vtkGenerateIds> pointIdFilter;
#else
vtkNew<vtkIdFilter> pointIdFilter;
#endif
pointIdFilter->SetInputConnection(cellIdFilter->GetOutputPort());
pointIdFilter->SetCellIds(false);
pointIdFilter->SetPointIds(true);
#if VTK890
pointIdFilter->SetPointIdsArrayName("PointIds");
#else
pointIdFilter->SetIdsArrayName("PointIds");
#endif
pointIdFilter->Update();
#ifdef USE_USE_GENERATE_IDS
vtkDataSet* sphereWithIds = pointIdFilter->GetPolyDataOutput();
#else
vtkDataSet* sphereWithIds = pointIdFilter->GetOutput();
#endif
WriteDataSet(sphereWithIds, "BothIdFilter.vtp");
vtkNew<vtkCubeSource> cubeSource;
cubeSource->Update();
vtkNew<vtkBox> implicitCube;
implicitCube->SetBounds(cubeSource->GetOutput()->GetBounds());
vtkNew<vtkClipPolyData> clipper;
clipper->SetClipFunction(implicitCube);
clipper->SetInputData(sphereWithIds);
clipper->InsideOutOn();
clipper->Update();
WriteDataSet(clipper->GetOutput(), "clipper.vtp");
// Get the clipped cell ids.
vtkPolyData* clipped = clipper->GetOutput();
std::cout << "There are " << clipped->GetNumberOfPoints()
<< " clipped points." << std::endl;
std::cout << "There are " << clipped->GetNumberOfCells() << " clipped cells."
<< std::endl;
vtkIdTypeArray* clippedCellIds = dynamic_cast<vtkIdTypeArray*>(
clipped->GetCellData()->GetArray("CellIds"));
for (vtkIdType i = 0; i < clippedCellIds->GetNumberOfTuples(); i++)
{
std::cout << "Clipped cell id " << i << " : " << clippedCellIds->GetValue(i)
<< std::endl;
}
// Create a mapper and actor for clipped sphere.
vtkNew<vtkPolyDataMapper> clippedMapper;
clippedMapper->SetInputConnection(clipper->GetOutputPort());
clippedMapper->ScalarVisibilityOff();
vtkNew<vtkActor> clippedActor;
clippedActor->SetMapper(clippedMapper);
clippedActor->GetProperty()->SetRepresentationToWireframe();
clippedActor->GetProperty()->SetColor(colors->GetColor3d("Yellow").GetData());
// Create a mapper and actor for cube.
vtkNew<vtkPolyDataMapper> cubeMapper;
cubeMapper->SetInputConnection(cubeSource->GetOutputPort());
vtkNew<vtkActor> cubeActor;
cubeActor->SetMapper(cubeMapper);
cubeActor->GetProperty()->SetRepresentationToWireframe();
cubeActor->GetProperty()->SetOpacity(0.5);
cubeActor->GetProperty()->SetColor(colors->GetColor3d("Blue").GetData());
// Create a renderer, render window, and interactor.
vtkNew<vtkRenderer> renderer;
vtkNew<vtkRenderWindow> renderWindow;
renderWindow->AddRenderer(renderer);
renderWindow->SetWindowName("ImplicitDataSetClipping");
vtkNew<vtkRenderWindowInteractor> renderWindowInteractor;
renderWindowInteractor->SetRenderWindow(renderWindow);
// Add the actor to the scene.
renderer->AddActor(clippedActor);
renderer->AddActor(cubeActor);
renderer->SetBackground(colors->GetColor3d("SlateGray").GetData());
// Generate an interesting view.
renderer->ResetCamera();
renderer->GetActiveCamera()->Azimuth(-30);
renderer->GetActiveCamera()->Elevation(30);
renderer->GetActiveCamera()->Dolly(1.0);
renderer->ResetCameraClippingRange();
// Render and interact.
renderWindow->Render();
renderWindowInteractor->Start();
return EXIT_SUCCESS;
}
namespace {
void WritePolyData(vtkPolyData* const polyData, const std::string& filename)
{
vtkNew<vtkXMLPolyDataWriter> writer;
writer->SetInputData(polyData);
writer->SetFileName(filename.c_str());
writer->Write();
}
void WriteDataSet(vtkDataSet* const dataSet, const std::string& filename)
{
vtkNew<vtkDataSetWriter> writer;
writer->SetInputData(dataSet);
writer->SetFileName(filename.c_str());
writer->Write();
}
} // namespace
CMakeLists.txt¶
cmake_minimum_required(VERSION 3.12 FATAL_ERROR)
project(ImplicitDataSetClipping)
find_package(VTK COMPONENTS
CommonColor
CommonCore
CommonDataModel
FiltersCore
FiltersSources
IOLegacy
IOXML
InteractionStyle
RenderingContextOpenGL2
RenderingCore
RenderingFreeType
RenderingGL2PSOpenGL2
RenderingOpenGL2
)
if (NOT VTK_FOUND)
message(FATAL_ERROR "ImplicitDataSetClipping: 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(ImplicitDataSetClipping MACOSX_BUNDLE ImplicitDataSetClipping.cxx )
target_link_libraries(ImplicitDataSetClipping PRIVATE ${VTK_LIBRARIES}
)
# vtk_module_autoinit is needed
vtk_module_autoinit(
TARGETS ImplicitDataSetClipping
MODULES ${VTK_LIBRARIES}
)
Download and Build ImplicitDataSetClipping¶
Click here to download ImplicitDataSetClipping and its CMakeLists.txt file. Once the tarball ImplicitDataSetClipping.tar has been downloaded and extracted,
cd ImplicitDataSetClipping/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:
./ImplicitDataSetClipping
WINDOWS USERS
Be sure to add the VTK bin directory to your path. This will resolve the VTK dll's at run time.