vtkCaptionRepresentation.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 vtkCaptionRepresentation_h
#define vtkCaptionRepresentation_h

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

VTK_ABI_NAMESPACE_BEGIN
class vtkRenderer;
class vtkCaptionActor2D;
class vtkConeSource;
class vtkPointHandleRepresentation3D;

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


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


  void SetAnchorPosition(double pos[3]);
  void GetAnchorPosition(double pos[3]);


  void SetCaptionActor2D(vtkCaptionActor2D* captionActor);
  vtkGetObjectMacro(CaptionActor2D, vtkCaptionActor2D);


  void SetAnchorRepresentation(vtkPointHandleRepresentation3D*);
  vtkGetObjectMacro(AnchorRepresentation, vtkPointHandleRepresentation3D);

  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;


  vtkSetClampMacro(FontFactor, double, 0.1, 10.0);
  vtkGetMacro(FontFactor, double);

  enum FitType
  {
    VTK_FIT_TO_BORDER = 0,
    VTK_FIT_TO_TEXT
  };
  vtkSetClampMacro(Fit, int, VTK_FIT_TO_BORDER, VTK_FIT_TO_TEXT);
  vtkGetMacro(Fit, int);
  void SetFitToBorder() { this->SetFit(VTK_FIT_TO_BORDER); }
  void SetFitToText() { this->SetFit(VTK_FIT_TO_TEXT); }
  const char* GetFitAsString();

protected:
  vtkCaptionRepresentation();
  ~vtkCaptionRepresentation() override;

  // the text to manage
  vtkCaptionActor2D* CaptionActor2D;
  vtkConeSource* CaptionGlyph;

  int PointWidgetState;
  int DisplayAttachmentPoint[2];
  double FontFactor;
  int Fit;

  // Internal representation for the anchor
  vtkPointHandleRepresentation3D* AnchorRepresentation;

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

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

VTK_ABI_NAMESPACE_END
#endif