Legend
Repository source: Legend
Other languages
See (Java)
Question
If you have a question about this example, please use the VTK Discourse Forum
Code¶
Legend.cxx
#include <vtkActor.h>
#include <vtkCubeSource.h>
#include <vtkLegendBoxActor.h>
#include <vtkNamedColors.h>
#include <vtkNew.h>
#include <vtkPolyData.h>
#include <vtkPolyDataMapper.h>
#include <vtkProperty.h>
#include <vtkRenderWindow.h>
#include <vtkRenderWindowInteractor.h>
#include <vtkRenderer.h>
#include <vtkSphereSource.h>
int main(int, char*[])
{
  vtkNew<vtkNamedColors> colors;
  vtkNew<vtkSphereSource> sphereSource;
  sphereSource->SetCenter(0.0, 0.0, 0.0);
  sphereSource->SetRadius(5000.0);
  sphereSource->Update();
  vtkPolyData* polydata = sphereSource->GetOutput();
  // Create a mapper
  vtkNew<vtkPolyDataMapper> mapper;
  mapper->SetInputData(polydata);
  // Create an actor
  vtkNew<vtkActor> actor;
  actor->SetMapper(mapper);
  actor->GetProperty()->SetColor(colors->GetColor3d("MistyRose").GetData());
  // A renderer and render window
  vtkNew<vtkRenderer> renderer;
  vtkNew<vtkRenderWindow> renderWindow;
  renderWindow->AddRenderer(renderer);
  renderWindow->SetWindowName("Legend");
  // An interactor
  vtkNew<vtkRenderWindowInteractor> renderWindowInteractor;
  renderWindowInteractor->SetRenderWindow(renderWindow);
  vtkNew<vtkLegendBoxActor> legend;
  legend->SetNumberOfEntries(2);
  double color[4];
  vtkNew<vtkCubeSource> legendBox;
  legendBox->Update();
  colors->GetColor("Tomato", color);
  legend->SetEntry(0, legendBox->GetOutput(), "Box", color);
  colors->GetColor("Banana", color);
  legend->SetEntry(1, sphereSource->GetOutput(), "Ball", color);
  // place legend in lower right
  legend->GetPositionCoordinate()->SetCoordinateSystemToView();
  legend->GetPositionCoordinate()->SetValue(0.5, -1.0);
  legend->GetPosition2Coordinate()->SetCoordinateSystemToView();
  legend->GetPosition2Coordinate()->SetValue(1.0, -0.5);
  legend->UseBackgroundOn();
  double background[4];
  colors->GetColor("SlateGray", background);
  legend->SetBackgroundColor(background);
  // Add the actors to the scene
  renderer->AddActor(actor);
  renderer->AddActor(legend);
  renderer->SetBackground(colors->GetColor3d("DarkGreen").GetData());
  // Render an image (lights and cameras are created automatically)
  renderWindow->Render();
  // Begin mouse interaction
  renderWindowInteractor->Start();
  return EXIT_SUCCESS;
}
CMakeLists.txt¶
cmake_minimum_required(VERSION 3.12 FATAL_ERROR)
project(Legend)
find_package(VTK COMPONENTS 
  CommonColor
  CommonCore
  CommonDataModel
  FiltersSources
  InteractionStyle
  RenderingAnnotation
  RenderingContextOpenGL2
  RenderingCore
  RenderingFreeType
  RenderingGL2PSOpenGL2
  RenderingOpenGL2
)
if (NOT VTK_FOUND)
  message(FATAL_ERROR "Legend: 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(Legend MACOSX_BUNDLE Legend.cxx )
  target_link_libraries(Legend PRIVATE ${VTK_LIBRARIES}
)
# vtk_module_autoinit is needed
vtk_module_autoinit(
  TARGETS Legend
  MODULES ${VTK_LIBRARIES}
)
Download and Build Legend¶
Click here to download Legend and its CMakeLists.txt file. Once the tarball Legend.tar has been downloaded and extracted,
cd Legend/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:
./Legend
WINDOWS USERS
Be sure to add the VTK bin directory to your path. This will resolve the VTK dll's at run time.
