vtkTextActor.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 vtkTextActor_h
#define vtkTextActor_h

#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkTexturedActor2D.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

#include "vtkDeprecation.h" // For deprecation macro

VTK_ABI_NAMESPACE_BEGIN
class vtkImageData;
class vtkPoints;
class vtkPolyData;
class vtkPolyDataMapper2D;
class vtkProperty2D;
class vtkTextProperty;
class vtkTextRenderer;
class vtkTransform;

class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkTextActor : public vtkTexturedActor2D
{
public:
  vtkTypeMacro(vtkTextActor, vtkTexturedActor2D);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkTextActor* New();

  void ShallowCopy(vtkProp* prop) override;


  void SetInput(const char* inputString);
  char* GetInput();


  vtkSetVector2Macro(MinimumSize, int);
  vtkGetVector2Macro(MinimumSize, int);


  vtkSetMacro(MaximumLineHeight, float);
  vtkGetMacro(MaximumLineHeight, float);


  vtkSetClampMacro(TextScaleMode, int, TEXT_SCALE_MODE_NONE, TEXT_SCALE_MODE_VIEWPORT);
  vtkGetMacro(TextScaleMode, int);
  void SetTextScaleModeToNone() { this->SetTextScaleMode(TEXT_SCALE_MODE_NONE); }
  void SetTextScaleModeToProp() { this->SetTextScaleMode(TEXT_SCALE_MODE_PROP); }
  void SetTextScaleModeToViewport() { this->SetTextScaleMode(TEXT_SCALE_MODE_VIEWPORT); }

  enum
  {
    TEXT_SCALE_MODE_NONE = 0,
    TEXT_SCALE_MODE_PROP,
    TEXT_SCALE_MODE_VIEWPORT
  };


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


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  VTK_DEPRECATED_IN_9_6_0("Please use vtkTextProperty Justification instead.")
  void SetAlignmentPoint(int point);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  VTK_DEPRECATED_IN_9_6_0("Please use vtkTextProperty Justification instead.")
  int GetAlignmentPoint();


  void SetOrientation(float orientation);
  vtkGetMacro(Orientation, float);


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

  virtual void GetBoundingBox(vtkViewport* vport, double bbox[4]);

  virtual void GetSize(vtkViewport* vport, double size[2]);


  virtual int SetConstrainedFontSize(vtkViewport*, int targetWidth, int targetHeight);
  static int SetConstrainedFontSize(vtkTextActor*, vtkViewport*, int targetWidth, int targetHeight);

  static int SetMultipleConstrainedFontSize(vtkViewport*, int targetWidth, int targetHeight,
    vtkTextActor** actors, int nbOfActors, int* maxResultingSize);

  virtual void SetNonLinearFontScale(double exponent, int target);


  vtkGetMacro(FontScaleExponent, double);
  vtkSetMacro(FontScaleExponent, double);

  void SpecifiedToDisplay(double* pos, vtkViewport* vport, int specified);

  void DisplayToSpecified(double* pos, vtkViewport* vport, int specified);

  virtual void ComputeScaledFont(vtkViewport* viewport);


  vtkGetObjectMacro(ScaledTextProperty, vtkTextProperty);

  static float GetFontScale(vtkViewport* viewport);

  void ReleaseGraphicsResources(vtkWindow*) override;


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

  vtkTypeBool HasTranslucentPolygonalGeometry() override;

protected:
  virtual bool RenderImage(vtkTextProperty* tprop, vtkViewport* viewport);

  virtual bool GetImageBoundingBox(vtkTextProperty* tprop, vtkViewport* viewport, int bbox[4]);

  vtkTextActor();
  ~vtkTextActor() override;

  int MinimumSize[2];
  float MaximumLineHeight;
  double FontScaleExponent;
  int TextScaleMode;
  float Orientation;
  vtkTypeBool UseBorderAlign;

  vtkTextProperty* TextProperty;
  vtkImageData* ImageData;
  vtkTextRenderer* TextRenderer;
  vtkTimeStamp BuildTime;
  vtkTransform* Transform;
  int LastSize[2];
  int LastOrigin[2];
  char* Input;
  bool InputRendered;
  double FormerOrientation;
  int RenderedDPI;

  vtkTextProperty* ScaledTextProperty;

  // Stuff needed to display the image text as a texture map.
  vtkPolyData* Rectangle;
  vtkPoints* RectanglePoints;

  virtual void ComputeRectangle(vtkViewport* viewport);

  virtual int UpdateRectangle(vtkViewport* viewport);

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

VTK_ABI_NAMESPACE_END
#endif