vtkBillboardTextActor3D.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkBillboardTextActor3D.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkBillboardTextActor3D_h
#define vtkBillboardTextActor3D_h
 
#include "vtkNew.h" // For.... vtkNew!
#include "vtkProp3D.h"
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkSmartPointer.h"        // For.... vtkSmartPointer!
 
class vtkActor;
class vtkImageData;
class vtkPolyData;
class vtkPolyDataMapper;
class vtkRenderer;
class vtkTextProperty;
class vtkTextRenderer;
class vtkTexture;
 
class VTKRENDERINGCORE_EXPORT vtkBillboardTextActor3D : public vtkProp3D
{
public:
  static vtkBillboardTextActor3D* New();
  vtkTypeMacro(vtkBillboardTextActor3D, vtkProp3D);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void SetInput(const char* in);
  vtkGetStringMacro(Input);
  vtkGetVector2Macro(DisplayOffset, int);
  vtkSetVector2Macro(DisplayOffset, int);
  void SetTextProperty(vtkTextProperty* tprop);
  vtkGetObjectMacro(TextProperty, vtkTextProperty);
  virtual void SetForceOpaque(bool opaque);
  virtual bool GetForceOpaque();
  virtual void ForceOpaqueOn();
  virtual void ForceOpaqueOff();
  virtual void SetForceTranslucent(bool trans);
  virtual bool GetForceTranslucent();
  virtual void ForceTranslucentOn();
  virtual void ForceTranslucentOff();
  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(AnchorDC, double);
 
protected:
  vtkBillboardTextActor3D();
  ~vtkBillboardTextActor3D() 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;
 
  // Offset in display coordinates.
  int DisplayOffset[2];
 
  // 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<vtkTexture> Texture;
  vtkNew<vtkPolyData> Quad;
  vtkNew<vtkPolyDataMapper> QuadMapper;
  vtkNew<vtkActor> QuadActor;
 
  // Display coordinate for anchor position. Z value is in NDC.
  // Cached for GL2PS export on OpenGL2:
  double AnchorDC[3];
 
private:
  vtkBillboardTextActor3D(const vtkBillboardTextActor3D&) = delete;
  void operator=(const vtkBillboardTextActor3D&) = delete;
};
 
#endif // vtkBillboardTextActor3D_h