vtkLabelPlacer.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
#ifndef vtkLabelPlacer_h
#define vtkLabelPlacer_h

#include "vtkDeprecation.h" // For deprecation macro
#include "vtkPolyDataAlgorithm.h"
#include "vtkRenderingLabelModule.h" // For export macro

VTK_ABI_NAMESPACE_BEGIN
class vtkRenderer;
class vtkCoordinate;
class vtkSelectVisiblePoints;

class VTK_DEPRECATED_IN_9_6_0(
  "Please use vtkLabelPlacementMapper instead") VTKRENDERINGLABEL_EXPORT vtkLabelPlacer
  : public vtkPolyDataAlgorithm
{
public:
  static vtkLabelPlacer* New();
  vtkTypeMacro(vtkLabelPlacer, vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkGetObjectMacro(Renderer, vtkRenderer);
  virtual void SetRenderer(vtkRenderer*);

  vtkGetObjectMacro(AnchorTransform, vtkCoordinate);

  enum LabelGravity
  {
    VerticalBottomBit = 1,
    VerticalBaselineBit = 2,
    VerticalCenterBit = 4,
    VerticalTopBit = 8,
    HorizontalLeftBit = 16,
    HorizontalCenterBit = 32,
    HorizontalRightBit = 64,
    VerticalBitMask = 15,
    HorizontalBitMask = 112,

    LowerLeft = 17, 
    LowerCenter =
      33, 
    LowerRight = 65, 

    BaselineLeft = 18,   
    BaselineCenter = 34, 
    BaselineRight = 66,  

    CenterLeft = 20, 
    CenterCenter =
      36, 
    CenterRight = 68, 

    UpperLeft = 24,   
    UpperCenter = 40, 
    UpperRight = 72   
  };

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


  virtual void SetGravity(int gravity);
  vtkGetMacro(Gravity, int);


  vtkSetClampMacro(MaximumLabelFraction, double, 0., 1.);
  vtkGetMacro(MaximumLabelFraction, double);


  vtkSetMacro(IteratorType, int);
  vtkGetMacro(IteratorType, int);

  vtkMTimeType GetMTime() override;


  vtkGetMacro(PositionsAsNormals, bool);
  vtkSetMacro(PositionsAsNormals, bool);
  vtkBooleanMacro(PositionsAsNormals, bool);


  vtkGetMacro(GeneratePerturbedLabelSpokes, bool);
  vtkSetMacro(GeneratePerturbedLabelSpokes, bool);
  vtkBooleanMacro(GeneratePerturbedLabelSpokes, bool);


  vtkGetMacro(UseDepthBuffer, bool);
  vtkSetMacro(UseDepthBuffer, bool);
  vtkBooleanMacro(UseDepthBuffer, bool);


  vtkGetMacro(OutputTraversedBounds, bool);
  vtkSetMacro(OutputTraversedBounds, bool);
  vtkBooleanMacro(OutputTraversedBounds, bool);


  vtkGetMacro(OutputCoordinateSystem, int);
  vtkSetClampMacro(OutputCoordinateSystem, int, WORLD, DISPLAY);
  void OutputCoordinateSystemWorld() { this->SetOutputCoordinateSystem(vtkLabelPlacer::WORLD); }
  void OutputCoordinateSystemDisplay() { this->SetOutputCoordinateSystem(vtkLabelPlacer::DISPLAY); }

protected:
  vtkLabelPlacer();
  ~vtkLabelPlacer() override;

  virtual void SetAnchorTransform(vtkCoordinate*);

  int FillInputPortInformation(int port, vtkInformation* info) override;
  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  class Internal;
  Internal* Buckets;

  vtkRenderer* Renderer;
  vtkCoordinate* AnchorTransform;
  vtkSelectVisiblePoints* VisiblePoints;
  int Gravity;
  double MaximumLabelFraction;
  bool PositionsAsNormals;
  bool OutputTraversedBounds;
  bool GeneratePerturbedLabelSpokes;
  bool UseDepthBuffer;

  int LastRendererSize[2];
  double LastCameraPosition[3];
  double LastCameraFocalPoint[3];
  double LastCameraViewUp[3];
  double LastCameraParallelScale;
  int IteratorType;
  int OutputCoordinateSystem;

private:
  vtkLabelPlacer(const vtkLabelPlacer&) = delete;
  void operator=(const vtkLabelPlacer&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif // vtkLabelPlacer_h