vtkFlagpoleLabel.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 vtkFlagpoleLabel_h
#define vtkFlagpoleLabel_h
 
#include "vtkActor.h"
#include "vtkNew.h"                 // For.... vtkNew!
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkSmartPointer.h"        // For.... vtkSmartPointer!
#include "vtkWrappingHints.h"       // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkActor;
class vtkImageData;
class vtkLineSource;
class vtkPolyData;
class vtkPolyDataMapper;
class vtkRenderer;
class vtkTextProperty;
class vtkTextRenderer;
 
class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkFlagpoleLabel : public vtkActor
{
public:
  static vtkFlagpoleLabel* New();
  vtkTypeMacro(vtkFlagpoleLabel, vtkActor);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void SetInput(const char* in);
  vtkGetStringMacro(Input);

  void SetTextProperty(vtkTextProperty* tprop);
  vtkGetObjectMacro(TextProperty, vtkTextProperty);

  void SetForceOpaque(bool opaque) override;
  bool GetForceOpaque() VTK_FUTURE_CONST override;
  void ForceOpaqueOn() override;
  void ForceOpaqueOff() override;
  void SetForceTranslucent(bool trans) override;
  bool GetForceTranslucent() VTK_FUTURE_CONST override;
  void ForceTranslucentOn() override;
  void ForceTranslucentOff() override;

  vtkTypeBool HasTranslucentPolygonalGeometry() override;

  int RenderOpaqueGeometry(vtkViewport* vp) override;

  int RenderTranslucentPolygonalGeometry(vtkViewport* vp) override;
 
  void ReleaseGraphicsResources(vtkWindow* win) override;
  double* GetBounds() override;
  using Superclass::GetBounds;

  vtkGetVector3Macro(BasePosition, double);
  void SetBasePosition(double x, double y, double z);

  vtkGetVector3Macro(TopPosition, double);
  void SetTopPosition(double x, double y, double z);

  vtkGetMacro(FlagSize, double);
  vtkSetMacro(FlagSize, double);
 
protected:
  vtkFlagpoleLabel();
  ~vtkFlagpoleLabel() override;
 
  bool InputIsValid();
 
  void UpdateInternals(vtkRenderer* ren);
 
  bool TextureIsStale(vtkRenderer* ren);
  void GenerateTexture(vtkRenderer* ren);
 
  bool QuadIsStale(vtkRenderer* ren);
  void GenerateQuad(vtkRenderer* ren);
 
  // Used by the opaque pass to tell the translucent pass not to render.
  void Invalidate();
  bool IsValid();
 
  // Used to sync the internal actor's state.
  void PreRender();
 
  // Text specification:
  char* Input;
  vtkTextProperty* TextProperty;
 
  // Cached metadata to determine if things need rebuildin'
  int RenderedDPI;
  vtkTimeStamp InputMTime;
 
  // We cache this so we can recompute the bounds between renders, if needed.
  vtkSmartPointer<vtkRenderer> RenderedRenderer;
 
  // Rendering stuffies
  vtkNew<vtkTextRenderer> TextRenderer;
  vtkNew<vtkImageData> Image;
  vtkNew<vtkPolyData> Quad;
  vtkNew<vtkPolyDataMapper> QuadMapper;
  vtkNew<vtkActor> QuadActor;
 
  vtkNew<vtkPolyDataMapper> PoleMapper;
  vtkNew<vtkLineSource> LineSource;
  vtkNew<vtkActor> PoleActor;
 
  double TopPosition[3];
  double BasePosition[3];
  double FlagSize;
 
private:
  vtkFlagpoleLabel(const vtkFlagpoleLabel&) = delete;
  void operator=(const vtkFlagpoleLabel&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkFlagpoleLabel_h