VTK  9.2.6
vtkBillboardTextActor3D.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkBillboardTextActor3D.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
42 #ifndef vtkBillboardTextActor3D_h
43 #define vtkBillboardTextActor3D_h
44 
45 #include "vtkNew.h" // For.... vtkNew!
46 #include "vtkProp3D.h"
47 #include "vtkRenderingCoreModule.h" // For export macro
48 #include "vtkSmartPointer.h" // For.... vtkSmartPointer!
49 
50 class vtkActor;
51 class vtkImageData;
52 class vtkPolyData;
53 class vtkPolyDataMapper;
54 class vtkRenderer;
55 class vtkTextProperty;
56 class vtkTextRenderer;
57 class vtkTexture;
58 
59 class VTKRENDERINGCORE_EXPORT vtkBillboardTextActor3D : public vtkProp3D
60 {
61 public:
64  void PrintSelf(ostream& os, vtkIndent indent) override;
65 
74  void GetActors(vtkPropCollection*) override;
75 
81 
86  void SetInput(const char* in);
87  vtkGetStringMacro(Input);
95  vtkGetVector2Macro(DisplayOffset, int);
96  vtkSetVector2Macro(DisplayOffset, int);
104  vtkGetObjectMacro(TextProperty, vtkTextProperty);
111  virtual void SetForceOpaque(bool opaque);
112  virtual bool GetForceOpaque();
113  virtual void ForceOpaqueOn();
114  virtual void ForceOpaqueOff();
115  virtual void SetForceTranslucent(bool trans);
116  virtual bool GetForceTranslucent();
117  virtual void ForceTranslucentOn();
118  virtual void ForceTranslucentOff();
125 
130 
136 
137  void ReleaseGraphicsResources(vtkWindow* win) override;
138  double* GetBounds() override;
139  using Superclass::GetBounds;
140 
145  vtkGetVector3Macro(AnchorDC, double);
146 
147 protected:
150 
151  bool InputIsValid();
152 
154 
157 
160 
161  // Used by the opaque pass to tell the translucent pass not to render.
162  void Invalidate();
163  bool IsValid();
164 
165  // Used to sync the internal actor's state.
166  void PreRender();
167 
168  // Text specification:
169  char* Input;
171 
172  // Offset in display coordinates.
173  int DisplayOffset[2];
174 
175  // Cached metadata to determine if things need rebuildin'
178 
179  // We cache this so we can recompute the bounds between renders, if needed.
181 
182  // Rendering stuffies
189 
190  // Display coordinate for anchor position. Z value is in NDC.
191  // Cached for GL2PS export on OpenGL2:
192  double AnchorDC[3];
193 
194 private:
196  void operator=(const vtkBillboardTextActor3D&) = delete;
197 };
198 
199 #endif // vtkBillboardTextActor3D_h
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:161
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:163
a simple class to control print indentation
Definition: vtkIndent.h:119
map vtkPolyData to graphics primitives
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:200
represents an 3D object for placement in a rendered scene
Definition: vtkProp3D.h:99
an ordered list of Props
virtual double * GetBounds()
Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
Definition: vtkProp.h:154
abstract specification for renderers
Definition: vtkRenderer.h:182
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:178
record modification and/or execution time
Definition: vtkTimeStamp.h:55
abstract specification for Viewports
Definition: vtkViewport.h:56
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
int vtkTypeBool
Definition: vtkABI.h:69