vtkTextRepresentation.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 vtkTextRepresentation_h
#define vtkTextRepresentation_h

#include "vtkBorderRepresentation.h"
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkWrappingHints.h"            // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkRenderer;
class vtkTextActor;
class vtkTextProperty;
class vtkTextRepresentationObserver;

class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkTextRepresentation
  : public vtkBorderRepresentation
{
public:
  static vtkTextRepresentation* New();


  vtkTypeMacro(vtkTextRepresentation, vtkBorderRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void SetTextActor(vtkTextActor* textActor);
  vtkGetObjectMacro(TextActor, vtkTextActor);


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetText(const char* text);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  const char* GetText();

  void BuildRepresentation() override;
  void GetSize(double size[2]) override
  {
    size[0] = 2.0;
    size[1] = 2.0;
  }


  void GetActors2D(vtkPropCollection*) override;
  void ReleaseGraphicsResources(vtkWindow*) override;
  int RenderOverlay(vtkViewport*) override;
  int RenderOpaqueGeometry(vtkViewport*) override;
  int RenderTranslucentPolygonalGeometry(vtkViewport*) override;
  vtkTypeBool HasTranslucentPolygonalGeometry() override;

  void SetWindowLocation(int enumLocation) override;


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetPosition(double x, double y) override;
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetPosition(double pos[2]) override { this->SetPosition(pos[0], pos[1]); }


  void ExecuteTextPropertyModifiedEvent(vtkObject* obj, unsigned long enumEvent, void* p);
  void ExecuteTextActorModifiedEvent(vtkObject* obj, unsigned long enumEvent, void* p);


  vtkSetClampMacro(PaddingLeft, int, 0, 4000);
  vtkGetMacro(PaddingLeft, int);


  vtkSetClampMacro(PaddingRight, int, 0, 4000);
  vtkGetMacro(PaddingRight, int);


  vtkSetClampMacro(PaddingTop, int, 0, 4000);
  vtkGetMacro(PaddingTop, int);


  vtkSetClampMacro(PaddingBottom, int, 0, 4000);
  vtkGetMacro(PaddingBottom, int);


  void SetPadding(int padding);

protected:
  vtkTextRepresentation();
  ~vtkTextRepresentation() override;

  // Initialize text actor
  virtual void InitializeTextActor();

  // Check and adjust boundaries according to the size of the text
  virtual void CheckTextBoundary();

  // the text to manage
  vtkTextActor* TextActor;
  vtkTextProperty* TextProperty;

  // observer to observe internal TextActor and TextProperty
  vtkTextRepresentationObserver* Observer;

  int PaddingLeft = 0;
  int PaddingRight = 0;
  int PaddingTop = 0;
  int PaddingBottom = 0;

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

VTK_ABI_NAMESPACE_END
#endif