VTK  9.3.0
vtkBillboardTextActor3D.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
20 #ifndef vtkBillboardTextActor3D_h
21 #define vtkBillboardTextActor3D_h
22 
23 #include "vtkNew.h" // For.... vtkNew!
24 #include "vtkProp3D.h"
25 #include "vtkRenderingCoreModule.h" // For export macro
26 #include "vtkSmartPointer.h" // For.... vtkSmartPointer!
27 
28 VTK_ABI_NAMESPACE_BEGIN
29 class vtkActor;
30 class vtkImageData;
31 class vtkPolyData;
32 class vtkPolyDataMapper;
33 class vtkRenderer;
34 class vtkTextProperty;
35 class vtkTextRenderer;
36 class vtkTexture;
37 
38 class VTKRENDERINGCORE_EXPORT vtkBillboardTextActor3D : public vtkProp3D
39 {
40 public:
43  void PrintSelf(ostream& os, vtkIndent indent) override;
44 
53  void GetActors(vtkPropCollection*) override;
54 
60 
65  void SetInput(const char* in);
66  vtkGetStringMacro(Input);
74  vtkGetVector2Macro(DisplayOffset, int);
75  vtkSetVector2Macro(DisplayOffset, int);
83  vtkGetObjectMacro(TextProperty, vtkTextProperty);
90  virtual void SetForceOpaque(bool opaque);
91  virtual bool GetForceOpaque();
92  virtual void ForceOpaqueOn();
93  virtual void ForceOpaqueOff();
94  virtual void SetForceTranslucent(bool trans);
95  virtual bool GetForceTranslucent();
96  virtual void ForceTranslucentOn();
97  virtual void ForceTranslucentOff();
104 
109 
115 
116  void ReleaseGraphicsResources(vtkWindow* win) override;
117  double* GetBounds() override;
118  using Superclass::GetBounds;
119 
124  vtkGetVector3Macro(AnchorDC, double);
125 
126 protected:
129 
130  bool InputIsValid();
131 
133 
136 
139 
140  // Used by the opaque pass to tell the translucent pass not to render.
141  void Invalidate();
142  bool IsValid();
143 
144  // Used to sync the internal actor's state.
145  void PreRender();
146 
147  // Text specification:
148  char* Input;
150 
151  // Offset in display coordinates.
152  int DisplayOffset[2];
153 
154  // Cached metadata to determine if things need rebuildin'
157 
158  // We cache this so we can recompute the bounds between renders, if needed.
160 
161  // Rendering stuffies
168 
169  // Display coordinate for anchor position. Z value is in NDC.
170  // Cached for GL2PS export on OpenGL2:
171  double AnchorDC[3];
172 
173 private:
175  void operator=(const vtkBillboardTextActor3D&) = delete;
176 };
177 
178 VTK_ABI_NAMESPACE_END
179 #endif // vtkBillboardTextActor3D_h
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:50
Renders pixel-aligned text, facing the camera, anchored at a 3D point.
void SetTextProperty(vtkTextProperty *tprop)
The vtkTextProperty object that controls the rendered text.
vtkNew< vtkTextRenderer > TextRenderer
virtual bool GetForceOpaque()
Force the actor to render during the opaque or translucent pass.
bool TextureIsStale(vtkRenderer *ren)
void SetInput(const char *in)
The UTF-8 encoded string to display.
int RenderTranslucentPolygonalGeometry(vtkViewport *vp) override
Just render in translucent pass, since it can execute multiple times (depth peeling,...
virtual bool GetForceTranslucent()
Force the actor to render during the opaque or translucent pass.
int RenderOpaqueGeometry(vtkViewport *vp) override
Check/update geometry/texture in opaque pass, since it only happens once.
void ReleaseGraphicsResources(vtkWindow *win) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
virtual void SetForceTranslucent(bool trans)
Force the actor to render during the opaque or translucent pass.
bool QuadIsStale(vtkRenderer *ren)
virtual void ForceOpaqueOff()
Force the actor to render during the opaque or translucent pass.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void ForceOpaqueOn()
Force the actor to render during the opaque or translucent pass.
void GenerateQuad(vtkRenderer *ren)
vtkSmartPointer< vtkRenderer > RenderedRenderer
virtual void ForceTranslucentOff()
Force the actor to render during the opaque or translucent pass.
virtual void SetForceOpaque(bool opaque)
Force the actor to render during the opaque or translucent pass.
double * GetBounds() override
Return a reference to the Prop3D's composite transform.
virtual void ForceTranslucentOn()
Force the actor to render during the opaque or translucent pass.
vtkNew< vtkImageData > Image
void GenerateTexture(vtkRenderer *ren)
vtkNew< vtkPolyDataMapper > QuadMapper
void UpdateInternals(vtkRenderer *ren)
static vtkBillboardTextActor3D * New()
void UpdateGeometry(vtkViewport *vp)
Updates the billboard geometry without performing any rendering, to assist GetActors().
vtkTypeBool HasTranslucentPolygonalGeometry() override
Defers to internal actor.
void GetActors(vtkPropCollection *) override
For some exporters and other other operations we must be able to collect all the actors or volumes.
~vtkBillboardTextActor3D() override
topologically and geometrically regular array of data
Definition: vtkImageData.h:52
a simple class to control print indentation
Definition: vtkIndent.h:38
map vtkPolyData to graphics primitives
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:89
represents an 3D object for placement in a rendered scene
Definition: vtkProp3D.h:48
an ordered list of Props
virtual double * GetBounds()
Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
Definition: vtkProp.h:133
abstract specification for renderers
Definition: vtkRenderer.h:71
represent text properties.
Interface for generating images and path data from string data, using multiple backends.
handles properties associated with a texture map
Definition: vtkTexture.h:67
record modification and/or execution time
Definition: vtkTimeStamp.h:34
abstract specification for Viewports
Definition: vtkViewport.h:54
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
int vtkTypeBool
Definition: vtkABI.h:64