# RibbonFilter

VTKExamples/Cxx/PolyData/RibbonFilter

### Description

This example demonstrates how to draw a flat surface (a ribbon) along a line.

### Code

RibbonFilter.cxx

    #include <vtkVersion.h>
    #include <vtkSmartPointer.h>

    #include <vtkActor.h>
    #include <vtkCamera.h>
    #include <vtkCellArray.h>
    #include <vtkMath.h>
    #include <vtkLine.h>
    #include <vtkPolyData.h>
    #include <vtkPolyDataMapper.h>
    #include <vtkProperty.h>
    #include <vtkRenderWindow.h>
    #include <vtkRenderWindowInteractor.h>
    #include <vtkRenderer.h>
    #include <vtkRibbonFilter.h>

    int main(int, char *[])
    {
      // Spiral parameters
      unsigned int nV = 256;      // No. of vertices
      double vX, vY, vZ;
      double rS = 2;              // Spiral radius
      unsigned int nCyc = 3;      // No. of spiral cycles
      double h = 10;              // Height

      unsigned int i;

      // Create points and cells for a spiral
      vtkSmartPointer<vtkPoints> points = vtkSmartPointer<vtkPoints>::New();
      for(i = 0; i < nV; i++)
      {
        // Spiral coordinates
        vX = rS * cos(2 * vtkMath::Pi() * nCyc * i / (nV - 1));
        vY = rS * sin(2 * vtkMath::Pi() * nCyc * i / (nV - 1));
        vZ = h * i / nV;
        points->InsertPoint(i, vX, vY, vZ);
      }

      vtkSmartPointer<vtkCellArray> lines =
        vtkSmartPointer<vtkCellArray>::New();
      lines->InsertNextCell(nV);
      for (i = 0; i < nV; i++)
      {
        lines->InsertCellPoint(i);
      }

      vtkSmartPointer<vtkPolyData> polyData =
        vtkSmartPointer<vtkPolyData>::New();
      polyData->SetPoints(points);
      polyData->SetLines(lines);

      // Create a mapper and actor
      vtkSmartPointer<vtkPolyDataMapper> lineMapper =
        vtkSmartPointer<vtkPolyDataMapper>::New();
    #if VTK_MAJOR_VERSION <= 5
      lineMapper->SetInput(polyData);
    #else
      lineMapper->SetInputData(polyData);
    #endif

      vtkSmartPointer<vtkActor> lineActor =
        vtkSmartPointer<vtkActor>::New();
      lineActor->SetMapper(lineMapper);
      lineActor->GetProperty()->SetColor(.8, .4, .2);
      lineActor->GetProperty()->SetLineWidth(3);

      // Create a ribbon around the line
      vtkSmartPointer<vtkRibbonFilter> ribbonFilter =
        vtkSmartPointer<vtkRibbonFilter>::New();
    #if VTK_MAJOR_VERSION <= 5
      ribbonFilter->SetInput(polyData);
    #else
      ribbonFilter->SetInputData(polyData);
    #endif
      ribbonFilter->SetWidth(.4);

      // Create a mapper and actor
      vtkSmartPointer<vtkPolyDataMapper> ribbonMapper =
        vtkSmartPointer<vtkPolyDataMapper>::New();
      ribbonMapper->SetInputConnection(ribbonFilter->GetOutputPort());

      vtkSmartPointer<vtkActor> ribbonActor =
        vtkSmartPointer<vtkActor>::New();
      ribbonActor->SetMapper(ribbonMapper);

      // Create a renderer, render window, and interactor
      vtkSmartPointer<vtkRenderer> renderer =
        vtkSmartPointer<vtkRenderer>::New();

      vtkSmartPointer<vtkRenderWindow> renderWindow =
        vtkSmartPointer<vtkRenderWindow>::New();
      renderWindow->AddRenderer(renderer);

      vtkSmartPointer<vtkRenderWindowInteractor> renderWindowInteractor =
        vtkSmartPointer<vtkRenderWindowInteractor>::New();
      renderWindowInteractor->SetRenderWindow(renderWindow);

      // Add the actor to the scene
      renderer->AddActor(ribbonActor);
      renderer->AddActor(lineActor);

      // Render and interact
      renderer->SetBackground(.2, .3, .4);

      // Generate an interesting view
      renderer->GetActiveCamera()->Azimuth(40);
      renderer->GetActiveCamera()->Elevation(30);
      renderer->ResetCamera();
      renderer->ResetCameraClippingRange();

      renderWindow->Render();
      renderWindowInteractor->Start();

      return EXIT_SUCCESS;
    }

### CMakeLists.txt

    cmake_minimum_required(VERSION 2.8)

    PROJECT(RibbonFilter)

    find_package(VTK REQUIRED)
    include(${VTK_USE_FILE})

    add_executable(RibbonFilter MACOSX_BUNDLE RibbonFilter.cxx)

    target_link_libraries(RibbonFilter ${VTK_LIBRARIES})

### Download and Build RibbonFilter

Danger

The generation of tar files has not been ported to the new VTKExamples. Some tarballs may be missing or out-of-date.

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

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

    ./RibbonFilter

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