vtkLabeledDataMapper.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 vtkLabeledDataMapper_h
#define vtkLabeledDataMapper_h

#include "vtkLabeledDatatypeDefinitions.h" // For Data type Definitions
#include "vtkMapper2D.h"
#include "vtkRenderingLabelModule.h" // For export macro
#include "vtkSmartPointer.h"         // For vtkSmartPointer
#include "vtkWrappingHints.h"        // For VTK_MARSHALAUTO

#include <cassert> // For assert macro
#include <memory>  // For std::unique_ptr
#include <vector>  // For std::vector

VTK_ABI_NAMESPACE_BEGIN
class vtkDataArray;
class vtkDataObject;
class vtkDataSet;
class vtkDataSetAttributes;
class vtkIntArray;
class vtkStringArray;
struct vtkLabeledFormatterInput;
class vtkTextMapper;
class vtkTextProperty;
class vtkTransform;

class VTKRENDERINGLABEL_EXPORT VTK_MARSHALAUTO vtkLabeledDataMapper : public vtkMapper2D
{
public:
  static vtkLabeledDataMapper* New();

  vtkTypeMacro(vtkLabeledDataMapper, vtkMapper2D);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetStringMacro(LabelFormat);
  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);

  virtual void SetInputData(vtkDataObject*);

  vtkDataSet* GetInput();


  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);


  void RenderOpaqueGeometry(vtkViewport* viewport, vtkActor2D* actor) override;
  void RenderOverlay(vtkViewport* viewport, vtkActor2D* actor) override;

  void ReleaseGraphicsResources(vtkWindow*) override;


  vtkGetObjectMacro(Transform, vtkTransform);
  void SetTransform(vtkTransform* t);

  enum Coordinates
  {
    WORLD = 0,  
    DISPLAY = 1 
  };


  vtkGetMacro(CoordinateSystem, int);
  vtkSetClampMacro(CoordinateSystem, int, WORLD, DISPLAY);
  void CoordinateSystemWorld() { this->SetCoordinateSystem(vtkLabeledDataMapper::WORLD); }
  void CoordinateSystemDisplay() { this->SetCoordinateSystem(vtkLabeledDataMapper::DISPLAY); }

  vtkMTimeType GetMTime() override;


  vtkGetMacro(NumberOfLabels, int);


  void GetLabelPosition(int label, double pos[3])
  {
    assert("label index range" && label >= 0 && label < this->NumberOfLabels);
    pos[0] = this->LabelPositions[3 * label];
    pos[1] = this->LabelPositions[3 * label + 1];
    pos[2] = this->LabelPositions[3 * label + 2];
  }

  const char* GetLabelText(int label);

protected:
  vtkLabeledDataMapper();
  ~vtkLabeledDataMapper() override;

  vtkDataSet* Input;

  char* LabelFormat;
  int LabelMode;
  int LabeledComponent;
  int FieldDataArray;
  char* FieldDataName;
  int CoordinateSystem;

  char ComponentSeparator;

  vtkTimeStamp BuildTime;

  int NumberOfLabels;
  int NumberOfLabelsAllocated;
  std::vector<vtkSmartPointer<vtkTextMapper>> TextMappers;
  std::vector<double> LabelPositions;
  vtkTransform* Transform;

  int FillInputPortInformation(int, vtkInformation*) override;

  virtual void AllocateLabels(int numLabels);
  virtual void BuildLabels();
  virtual void BuildLabelsInternal(vtkDataSet*);

  vtkLabeledFormatterInput ResolveLabeledFormatterInput(
    vtkDataSetAttributes* pd, int numItems, vtkDataObject* inputObj);

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

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

  struct vtkLabeledDataMapperFormatter;
};

VTK_ABI_NAMESPACE_END
#endif