vtkBatchedLabeledDataMapper.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 vtkBatchedLabeledDataMapper_h
#define vtkBatchedLabeledDataMapper_h

#include "vtkLabeledDataMapper.h"
#include "vtkRenderingLabelModule.h" // For export macro
#include "vtkWrappingHints.h"        // For VTK_MARSHALMANUAL

#include <memory> // For unique_ptr

VTK_ABI_NAMESPACE_BEGIN
class vtkDataSet;
class vtkFloatArray;
class vtkImageData;
class vtkIntArray;
class vtkPolyData;
class vtkTextProperty;
VTK_ABI_NAMESPACE_END

VTK_ABI_NAMESPACE_BEGIN
class VTKRENDERINGLABEL_EXPORT VTK_MARSHALMANUAL vtkBatchedLabeledDataMapper
  : public vtkLabeledDataMapper
{
public:
  static vtkBatchedLabeledDataMapper* New();
  vtkTypeMacro(vtkBatchedLabeledDataMapper, vtkLabeledDataMapper);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  static constexpr int MaxTextProperties = 128;
  static constexpr int GlyphAtlasPadding = 5;
  static constexpr int GlyphAtlasColumnSize = 10;


  void SetLabelTextProperty(vtkTextProperty* p) override { this->SetLabelTextProperty(p, 0); }
  vtkTextProperty* GetLabelTextProperty() override { return this->GetLabelTextProperty(0); }
  void SetLabelTextProperty(vtkTextProperty* p, int type) override;
  vtkTextProperty* GetLabelTextProperty(int type) override;

  vtkSetStringMacro(FrameColorsName);
  vtkGetStringMacro(FrameColorsName);


  enum TextAnchorTypes
  {
    LowerLeft = 0,  
    LowerRight = 1, 
    UpperLeft = 2,  
    UpperRight = 3, 
    LowerEdge = 4,  
    RightEdge = 5,  
    LeftEdge = 6,   
    UpperEdge = 7,  
    Center = 8      
  };


  vtkSetClampMacro(TextAnchor, int, LowerLeft, Center);
  vtkGetMacro(TextAnchor, int);


  vtkSetVector2Macro(DisplayOffset, int);
  vtkGetVector2Macro(DisplayOffset, int);

  vtkMTimeType GetMTime() override;

  void RenderOpaqueGeometry(vtkViewport*, vtkActor2D*) override {}
  void RenderOverlay(vtkViewport*, vtkActor2D*) override {}
  void ReleaseGraphicsResources(vtkWindow*) override;

protected:
  vtkBatchedLabeledDataMapper();
  ~vtkBatchedLabeledDataMapper() override;

  int FillInputPortInformation(int, vtkInformation*) override;

  void AllocateLabels(int numLabels) override;

  void BuildLabels() override;

  void BuildLabelsInternal(vtkDataSet*) override;

  void MakeShaderArrays(int numCurLabels, const std::vector<std::string>&, vtkIntArray*,
    vtkFloatArray*, const std::vector<bool>& visible);

  virtual void UploadGlyphAtlas(vtkImageData* atlas);

  virtual void ActivateGlyphTexture();
  virtual void DeactivateGlyphTexture();


  vtkImageData* GetGlyphAtlas() const;
  vtkPolyData* GetPreparedPolyData() const;
  const float* GetBackgroundColors() const;
  const int* GetFrameWidths() const;
  const int* GetMaxGlyphHeights() const;
  const int* GetDescenders() const;

  void UpdateRenderWindowDPI(int dpi);

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

  int TextAnchor = vtkBatchedLabeledDataMapper::Center;
  int DisplayOffset[2] = { 0, 0 };

  char* FrameColorsName = nullptr;

  class vtkInternals;
  std::unique_ptr<vtkInternals> Impl;

  struct vtkBatchedLabeledDataMapperFormatter;
};
VTK_ABI_NAMESPACE_END

#endif