vtkLegendBoxActor.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkLegendBoxActor_h
#define vtkLegendBoxActor_h

#include "vtkActor2D.h"
#include "vtkNew.h"                       // for vtkNew
#include "vtkRenderingAnnotationModule.h" // For export macro
#include "vtkWrappingHints.h"             // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkActor;
class vtkDoubleArray;
class vtkImageData;
class vtkLegendBoxEntryInternal;
class vtkPolyData;
class vtkPolyDataMapper2D;
class vtkPolyDataMapper;
class vtkPlaneSource;
class vtkTextMapper;
class vtkTextProperty;
class vtkTexturedActor2D;
class vtkTransform;
class vtkTransformFilter;
class vtkProperty2D;

class VTKRENDERINGANNOTATION_EXPORT VTK_MARSHALAUTO vtkLegendBoxActor : public vtkActor2D
{
public:
  vtkTypeMacro(vtkLegendBoxActor, vtkActor2D);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkLegendBoxActor* New();

  void SetNumberOfEntries(int num);
  int GetNumberOfEntries() { return this->NumberOfEntries; }


  void SetEntry(int i, vtkPolyData* symbol, const char* string, double color[3]);
  void SetEntry(int i, vtkImageData* symbol, const char* string, double color[3]);
  void SetEntry(
    int i, vtkPolyData* symbol, vtkImageData* icon, const char* string, double color[3]);

  void SetEntrySymbol(int i, vtkPolyData* symbol);
  void SetEntryIcon(int i, vtkImageData* icon);
  void SetEntryString(int i, const char* string);
  void SetEntryColor(int i, double color[3]);
  void SetEntryColor(int i, double r, double g, double b);

  vtkPolyData* GetEntrySymbol(int i);
  vtkImageData* GetEntryIcon(int i);
  const char* GetEntryString(int i);
  double* GetEntryColor(int i) VTK_SIZEHINT(3);

  int GetNumberOfEntrySymbols() { return NumberOfEntries; }
  int GetNumberOfEntryColors() { return NumberOfEntries; }
  int GetNumberOfEntryStrings() { return NumberOfEntries; }
  int GetNumberOfEntryIcons() { return NumberOfEntries; }

  virtual void SetEntryTextProperty(vtkTextProperty* p);
  vtkGetObjectMacro(EntryTextProperty, vtkTextProperty);


  vtkSetMacro(Border, vtkTypeBool);
  vtkGetMacro(Border, vtkTypeBool);
  vtkBooleanMacro(Border, vtkTypeBool);


  vtkSetMacro(LockBorder, vtkTypeBool);
  vtkGetMacro(LockBorder, vtkTypeBool);
  vtkBooleanMacro(LockBorder, vtkTypeBool);


  vtkSetMacro(Box, vtkTypeBool);
  vtkGetMacro(Box, vtkTypeBool);
  vtkBooleanMacro(Box, vtkTypeBool);

  vtkProperty2D* GetBoxProperty() { return this->BoxActor->GetProperty(); }


  vtkSetClampMacro(Padding, int, 0, 50);
  vtkGetMacro(Padding, int);


  vtkSetMacro(ScalarVisibility, vtkTypeBool);
  vtkGetMacro(ScalarVisibility, vtkTypeBool);
  vtkBooleanMacro(ScalarVisibility, vtkTypeBool);


  vtkSetMacro(UseBackground, vtkTypeBool);
  vtkGetMacro(UseBackground, vtkTypeBool);
  vtkBooleanMacro(UseBackground, vtkTypeBool);


  vtkSetVector3Macro(BackgroundColor, double);
  vtkGetVector3Macro(BackgroundColor, double);


  vtkSetClampMacro(BackgroundOpacity, double, 0.0, 1.0);
  vtkGetMacro(BackgroundOpacity, double);

  void ShallowCopy(vtkProp* prop) override;

  void ReleaseGraphicsResources(vtkWindow*) override;


  int RenderOpaqueGeometry(vtkViewport* viewport) override;
  int RenderTranslucentPolygonalGeometry(vtkViewport*) override { return 0; }
  int RenderOverlay(vtkViewport* viewport) override;

  vtkTypeBool HasTranslucentPolygonalGeometry() override;

protected:
  vtkLegendBoxActor();
  ~vtkLegendBoxActor() override;

  void InitializeEntries();

  vtkPolyData createTexturedPlane();

  vtkTypeBool Border;
  vtkTypeBool Box;
  int Padding;
  vtkTypeBool LockBorder;
  vtkTypeBool ScalarVisibility;
  double BoxOpacity;

  int NumberOfEntries;

  vtkPolyData* BorderPolyData;
  vtkPolyDataMapper2D* BorderMapper;
  vtkActor2D* BorderActor;
  vtkPolyData* BoxPolyData;
  vtkPolyDataMapper2D* BoxMapper;
  vtkActor2D* BoxActor;
  vtkTextProperty* EntryTextProperty;

  // Background plane.
  vtkTypeBool UseBackground;
  double BackgroundOpacity;
  double BackgroundColor[3];
  vtkPlaneSource* Background;

  // May use texture.
  vtkTexturedActor2D* BackgroundActor;
  vtkPolyDataMapper2D* BackgroundMapper;

  // Used to control whether the stuff is recomputed
  int LegendEntriesVisible;
  int CachedSize[2];
  vtkTimeStamp BuildTime;

private:
  vtkLegendBoxActor(const vtkLegendBoxActor&) = delete;
  void operator=(const vtkLegendBoxActor&) = delete;

  std::vector<std::unique_ptr<vtkLegendBoxEntryInternal>> Entries;
};

VTK_ABI_NAMESPACE_END
#endif