vtkCornerAnnotation.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 vtkCornerAnnotation_h
#define vtkCornerAnnotation_h

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

VTK_ABI_NAMESPACE_BEGIN
class vtkTextMapper;
class vtkImageMapToWindowLevelColors;
class vtkImageActor;
class vtkTextProperty;

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

  static vtkCornerAnnotation* New();


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

  vtkTypeBool HasTranslucentPolygonalGeometry() override;


  vtkSetMacro(MaximumLineHeight, double);
  vtkGetMacro(MaximumLineHeight, double);


  vtkSetMacro(MinimumFontSize, int);
  vtkGetMacro(MinimumFontSize, int);
  vtkSetMacro(MaximumFontSize, int);
  vtkGetMacro(MaximumFontSize, int);


  vtkSetMacro(LinearFontScaleFactor, double);
  vtkGetMacro(LinearFontScaleFactor, double);
  vtkSetMacro(NonlinearFontScaleFactor, double);
  vtkGetMacro(NonlinearFontScaleFactor, double);

  void ReleaseGraphicsResources(vtkWindow*) override;


  enum TextPosition
  {
    LowerLeft = 0, 
    LowerRight,    
    UpperLeft,     
    UpperRight,    
    LowerEdge,     
    RightEdge,     
    LeftEdge,      
    UpperEdge      
  };
  static const int NumTextPositions = 8;


  void SetText(int i, const char* text);
  const char* GetText(int i);
  void ClearAllTexts();
  void CopyAllTextsFrom(vtkCornerAnnotation* ca);
  std::vector<std::string> GetAllTexts() const;
  void SetAllTexts(const std::vector<std::string>& values);


  void SetImageActor(vtkImageActor*);
  vtkGetObjectMacro(ImageActor, vtkImageActor);


  void SetWindowLevel(vtkImageMapToWindowLevelColors*);
  vtkGetObjectMacro(WindowLevel, vtkImageMapToWindowLevelColors);


  vtkSetMacro(LevelShift, double);
  vtkGetMacro(LevelShift, double);


  vtkSetMacro(LevelScale, double);
  vtkGetMacro(LevelScale, double);


  virtual void SetTextProperty(vtkTextProperty* p);
  vtkGetObjectMacro(TextProperty, vtkTextProperty);


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

protected:
  vtkCornerAnnotation();
  ~vtkCornerAnnotation() override;

  double MaximumLineHeight;

  vtkTextProperty* TextProperty;

  vtkImageMapToWindowLevelColors* WindowLevel;
  double LevelShift;
  double LevelScale;
  vtkImageActor* ImageActor;
  vtkImageActor* LastImageActor;

  char* CornerText[NumTextPositions];

  int FontSize;
  vtkActor2D* TextActor[NumTextPositions];
  vtkTimeStamp BuildTime;
  int LastSize[2];
  vtkTextMapper* TextMapper[NumTextPositions];

  int MinimumFontSize;
  int MaximumFontSize;

  double LinearFontScaleFactor;
  double NonlinearFontScaleFactor;

  vtkTypeBool ShowSliceAndImage;

  virtual void TextReplace(vtkImageActor* ia, vtkImageMapToWindowLevelColors* wl);


  virtual void SetTextActorsPosition(const int vsize[2]);
  virtual void SetTextActorsJustification();

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

VTK_ABI_NAMESPACE_END
#endif