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=========================================================================*/
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
28class vtkActor;
29class vtkImageData;
30class vtkPolyData;
32class vtkRenderer;
33class vtkTextProperty;
34class vtkTextRenderer;
35class vtkTexture;
36
37class VTKRENDERINGCORE_EXPORT vtkBillboardTextActor3D : public vtkProp3D
38{
39public:
42 void PrintSelf(ostream& os, vtkIndent indent) override;
43
53
59
64 void SetInput(const char* in);
65 vtkGetStringMacro(Input);
73 vtkGetVector2Macro(DisplayOffset, int);
74 vtkSetVector2Macro(DisplayOffset, int);
82 vtkGetObjectMacro(TextProperty, vtkTextProperty);
89 virtual void SetForceOpaque(bool opaque);
90 virtual bool GetForceOpaque();
91 virtual void ForceOpaqueOn();
92 virtual void ForceOpaqueOff();
93 virtual void SetForceTranslucent(bool trans);
94 virtual bool GetForceTranslucent();
95 virtual void ForceTranslucentOn();
96 virtual void ForceTranslucentOff();
103
108
114
116 double* GetBounds() override;
117 using Superclass::GetBounds;
118
123 vtkGetVector3Macro(AnchorDC, double);
124
125protected:
128
130
132
135
138
139 // Used by the opaque pass to tell the translucent pass not to render.
141 bool IsValid();
142
143 // Used to sync the internal actor's state.
144 void PreRender();
145
146 // Text specification:
147 char* Input;
149
150 // Offset in display coordinates.
151 int DisplayOffset[2];
152
153 // Cached metadata to determine if things need rebuildin'
156
157 // We cache this so we can recompute the bounds between renders, if needed.
159
160 // Rendering stuffies
167
168 // Display coordinate for anchor position. Z value is in NDC.
169 // Cached for GL2PS export on OpenGL2:
170 double AnchorDC[3];
171
172private:
174 void operator=(const vtkBillboardTextActor3D&) = delete;
175};
176
177#endif // vtkBillboardTextActor3D_h
represents an object (geometry & properties) in a rendered scene
Definition vtkActor.h:46
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.
double * GetBounds() override
Return a reference to the Prop3D's composite transform.
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.
static vtkBillboardTextActor3D * New()
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.
virtual void ForceTranslucentOn()
Force the actor to render during the opaque or translucent pass.
void GenerateTexture(vtkRenderer *ren)
vtkNew< vtkPolyDataMapper > QuadMapper
void UpdateInternals(vtkRenderer *ren)
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
a simple class to control print indentation
Definition vtkIndent.h:34
Allocate and hold a VTK object.
Definition vtkNew.h:56
map vtkPolyData to graphics primitives
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition vtkPolyData.h:85
represents an 3D object for placement in a rendered scene
Definition vtkProp3D.h:47
an ordered list of Props
abstract specification for renderers
Definition vtkRenderer.h:67
Hold a reference to a vtkObjectBase instance.
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:66
record modification and/or execution time
abstract specification for Viewports
Definition vtkViewport.h:50
window superclass for vtkRenderWindow
Definition vtkWindow.h:39
int vtkTypeBool
Definition vtkABI.h:69