vtkFastLabeledDataMapper.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 vtkFastLabeledDataMapper_h
#define vtkFastLabeledDataMapper_h

#include "vtkDeprecation.h"                // For VTK_DEPRECATED_IN_9_7_0
#include "vtkLabeledDatatypeDefinitions.h" // For Data type Definitions
#include "vtkOpenGLPolyDataMapper.h"
#include "vtkRenderingOpenGL2Module.h" // For export macro
#include "vtkWrappingHints.h"          // For VTK_MARSHALAUTO

#include <memory> // For unique_ptr

VTK_ABI_NAMESPACE_BEGIN
class vtkDataObject;
class vtkDataSet;
class vtkFloatArray;
class vtkIntArray;
class vtkTextProperty;
class vtkTransform;
VTK_ABI_NAMESPACE_END

VTK_ABI_NAMESPACE_BEGIN
class VTK_DEPRECATED_IN_9_7_0("Use vtkBatchedLabeledDataMapper instead.") VTKRENDERINGOPENGL2_EXPORT
  VTK_MARSHALAUTO vtkFastLabeledDataMapper : public vtkOpenGLPolyDataMapper
{
public:
  static vtkFastLabeledDataMapper* New();
  vtkTypeMacro(vtkFastLabeledDataMapper, vtkOpenGLPolyDataMapper);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void SetLabelFormat(const char* format);
  vtkGetStringMacro(LabelFormat);


  vtkSetMacro(LabeledComponent, int);
  vtkGetMacro(LabeledComponent, int);


  vtkSetMacro(ComponentSeparator, char);
  vtkGetMacro(ComponentSeparator, char);


  vtkSetClampMacro(FieldDataArray, int, 0, VTK_INT_MAX);
  vtkGetMacro(FieldDataArray, int);


  vtkSetStringMacro(FieldDataName)
  vtkGetStringMacro(FieldDataName);


  vtkSetMacro(LabelMode, int);
  vtkGetMacro(LabelMode, int);
  void SetLabelModeToLabelIds() { this->SetLabelMode(VTK_LABEL_IDS); };
  void SetLabelModeToLabelScalars() { this->SetLabelMode(VTK_LABEL_SCALARS); };
  void SetLabelModeToLabelVectors() { this->SetLabelMode(VTK_LABEL_VECTORS); };
  void SetLabelModeToLabelNormals() { this->SetLabelMode(VTK_LABEL_NORMALS); };
  void SetLabelModeToLabelTCoords() { this->SetLabelMode(VTK_LABEL_TCOORDS); };
  void SetLabelModeToLabelTensors() { this->SetLabelMode(VTK_LABEL_TENSORS); };
  void SetLabelModeToLabelFieldData() { this->SetLabelMode(VTK_LABEL_FIELD_DATA); };


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

  vtkSetStringMacro(FrameColorsName);
  vtkGetStringMacro(FrameColorsName);


  enum TextAnchor
  {
    LowerLeft = 0, 
    LowerRight,    
    UpperLeft,     
    UpperRight,    
    LowerEdge,     
    RightEdge,     
    LeftEdge,      
    UpperEdge,     
    Center         
  };


  vtkSetMacro(TextAnchor, int);
  vtkGetMacro(TextAnchor, int);


  void RenderPiece(vtkRenderer* ren, vtkActor* act) override;


  void RenderPieceStart(vtkRenderer* ren, vtkActor* act) override;


  void RenderPieceFinish(vtkRenderer* ren, vtkActor* act) override;


  virtual void SetInputData(vtkDataSet*);


  vtkMTimeType GetMTime() override;


  void ReleaseGraphicsResources(vtkWindow*) override;

protected:
  vtkFastLabeledDataMapper();
  ~vtkFastLabeledDataMapper() override;


  void SetMapperShaderParameters(vtkOpenGLHelper& cellBO, vtkRenderer* ren, vtkActor* act) override;


  int FillInputPortInformation(int, vtkInformation*) override;

  void AllocateLabels(int numLabels);
  void BuildLabels();
  void BuildLabelsInternal(vtkDataSet*);
  void MakeShaderArrays(
    int numCurLabels, const std::vector<std::string>&, vtkIntArray*, vtkFloatArray*);
  void MakeupShaders(vtkOpenGLShaderProperty* sp);

  vtkDataSet* Input = nullptr;
  char* LabelFormat = nullptr;
  int LabelMode = VTK_LABEL_IDS;
  int LabeledComponent = -1;
  int FieldDataArray = 0;
  char* FieldDataName = nullptr;
  char ComponentSeparator = ' ';
  int TextAnchor = vtkFastLabeledDataMapper::Center;

  int NumberOfLabels;
  int NumberOfLabelsAllocated = 0;

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

  char* FrameColorsName = nullptr;

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

  struct vtkFastLabeledDataMapperFunctor;

protected:
  void BuildShaders(
    std::map<vtkShader::Type, vtkShader*> shaders, vtkRenderer* ren, vtkActor* act) override;
};
VTK_ABI_NAMESPACE_END

#endif