VTK  9.0.20210417
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 
28 class vtkActor;
29 class vtkImageData;
30 class vtkPolyData;
31 class vtkPolyDataMapper;
32 class vtkRenderer;
33 class vtkTextProperty;
34 class vtkTextRenderer;
35 class vtkTexture;
36 
37 class VTKRENDERINGCORE_EXPORT vtkBillboardTextActor3D : public vtkProp3D
38 {
39 public:
42  void PrintSelf(ostream& os, vtkIndent indent) override;
43 
52  void GetActors(vtkPropCollection*) override;
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 
115  void ReleaseGraphicsResources(vtkWindow* win) override;
116  double* GetBounds() override;
117  using Superclass::GetBounds;
118 
123  vtkGetVector3Macro(AnchorDC, double);
124 
125 protected:
128 
129  bool InputIsValid();
130 
132 
135 
138 
139  // Used by the opaque pass to tell the translucent pass not to render.
140  void Invalidate();
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 
172 private:
174  void operator=(const vtkBillboardTextActor3D&) = delete;
175 };
176 
177 #endif // vtkBillboardTextActor3D_h
vtkPolyDataMapper
map vtkPolyData to graphics primitives
Definition: vtkPolyDataMapper.h:37
vtkBillboardTextActor3D::Invalidate
void Invalidate()
vtkBillboardTextActor3D::SetForceTranslucent
virtual void SetForceTranslucent(bool trans)
Force the actor to render during the opaque or translucent pass.
vtkBillboardTextActor3D::IsValid
bool IsValid()
vtkBillboardTextActor3D::GetForceTranslucent
virtual bool GetForceTranslucent()
Force the actor to render during the opaque or translucent pass.
vtkBillboardTextActor3D::QuadMapper
vtkNew< vtkPolyDataMapper > QuadMapper
Definition: vtkBillboardTextActor3D.h:165
vtkBillboardTextActor3D::ForceOpaqueOn
virtual void ForceOpaqueOn()
Force the actor to render during the opaque or translucent pass.
vtkProp3D
represents an 3D object for placement in a rendered scene
Definition: vtkProp3D.h:44
vtkBillboardTextActor3D::ForceOpaqueOff
virtual void ForceOpaqueOff()
Force the actor to render during the opaque or translucent pass.
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:33
vtkBillboardTextActor3D::UpdateGeometry
void UpdateGeometry(vtkViewport *vp)
Updates the billboard geometry without performing any rendering, to assist GetActors().
vtkSmartPointer< vtkRenderer >
vtkBillboardTextActor3D::TextureIsStale
bool TextureIsStale(vtkRenderer *ren)
vtkBillboardTextActor3D::GetForceOpaque
virtual bool GetForceOpaque()
Force the actor to render during the opaque or translucent pass.
vtkBillboardTextActor3D
Renders pixel-aligned text, facing the camera, anchored at a 3D point.
Definition: vtkBillboardTextActor3D.h:38
vtkBillboardTextActor3D::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkBillboardTextActor3D::Image
vtkNew< vtkImageData > Image
Definition: vtkBillboardTextActor3D.h:162
vtkBillboardTextActor3D::GetBounds
double * GetBounds() override
Return a reference to the Prop3D's composite transform.
vtkBillboardTextActor3D::SetTextProperty
void SetTextProperty(vtkTextProperty *tprop)
The vtkTextProperty object that controls the rendered text.
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
vtkBillboardTextActor3D::QuadIsStale
bool QuadIsStale(vtkRenderer *ren)
vtkBillboardTextActor3D::QuadActor
vtkNew< vtkActor > QuadActor
Definition: vtkBillboardTextActor3D.h:166
vtkBillboardTextActor3D::RenderedRenderer
vtkSmartPointer< vtkRenderer > RenderedRenderer
Definition: vtkBillboardTextActor3D.h:158
vtkBillboardTextActor3D::vtkBillboardTextActor3D
vtkBillboardTextActor3D()
vtkBillboardTextActor3D::New
static vtkBillboardTextActor3D * New()
vtkTexture
handles properties associated with a texture map
Definition: vtkTexture.h:66
vtkBillboardTextActor3D::UpdateInternals
void UpdateInternals(vtkRenderer *ren)
vtkBillboardTextActor3D::GetActors
void GetActors(vtkPropCollection *) override
For some exporters and other other operations we must be able to collect all the actors or volumes.
vtkBillboardTextActor3D::~vtkBillboardTextActor3D
~vtkBillboardTextActor3D() override
vtkBillboardTextActor3D::SetInput
void SetInput(const char *in)
The UTF-8 encoded string to display.
vtkBillboardTextActor3D::InputMTime
vtkTimeStamp InputMTime
Definition: vtkBillboardTextActor3D.h:155
vtkBillboardTextActor3D::PreRender
void PreRender()
vtkActor
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:46
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:48
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:34
vtkSmartPointer.h
vtkBillboardTextActor3D::SetForceOpaque
virtual void SetForceOpaque(bool opaque)
Force the actor to render during the opaque or translucent pass.
vtkNew< vtkTextRenderer >
vtkProp::GetBounds
virtual double * GetBounds()
Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
Definition: vtkProp.h:135
vtkBillboardTextActor3D::ReleaseGraphicsResources
void ReleaseGraphicsResources(vtkWindow *win) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
vtkViewport
abstract specification for Viewports
Definition: vtkViewport.h:45
vtkBillboardTextActor3D::RenderOpaqueGeometry
int RenderOpaqueGeometry(vtkViewport *vp) override
Check/update geometry/texture in opaque pass, since it only happens once.
vtkBillboardTextActor3D::RenderedDPI
int RenderedDPI
Definition: vtkBillboardTextActor3D.h:154
vtkTextProperty
represent text properties.
Definition: vtkTextProperty.h:34
vtkBillboardTextActor3D::Quad
vtkNew< vtkPolyData > Quad
Definition: vtkBillboardTextActor3D.h:164
vtkBillboardTextActor3D::TextRenderer
vtkNew< vtkTextRenderer > TextRenderer
Definition: vtkBillboardTextActor3D.h:161
vtkBillboardTextActor3D::ForceTranslucentOff
virtual void ForceTranslucentOff()
Force the actor to render during the opaque or translucent pass.
vtkBillboardTextActor3D::InputIsValid
bool InputIsValid()
vtkNew.h
vtkTextRenderer
Interface for generating images and path data from string data, using multiple backends.
Definition: vtkTextRenderer.h:75
vtkBillboardTextActor3D::GenerateTexture
void GenerateTexture(vtkRenderer *ren)
vtkRenderer
abstract specification for renderers
Definition: vtkRenderer.h:71
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:86
vtkBillboardTextActor3D::Input
char * Input
Definition: vtkBillboardTextActor3D.h:147
vtkBillboardTextActor3D::HasTranslucentPolygonalGeometry
vtkTypeBool HasTranslucentPolygonalGeometry() override
Defers to internal actor.
vtkBillboardTextActor3D::RenderTranslucentPolygonalGeometry
int RenderTranslucentPolygonalGeometry(vtkViewport *vp) override
Just render in translucent pass, since it can execute multiple times (depth peeling,...
vtkBillboardTextActor3D::ForceTranslucentOn
virtual void ForceTranslucentOn()
Force the actor to render during the opaque or translucent pass.
vtkBillboardTextActor3D::TextProperty
vtkTextProperty * TextProperty
Definition: vtkBillboardTextActor3D.h:148
vtkPropCollection
an ordered list of Props
Definition: vtkPropCollection.h:36
vtkBillboardTextActor3D::GenerateQuad
void GenerateQuad(vtkRenderer *ren)
vtkBillboardTextActor3D::Texture
vtkNew< vtkTexture > Texture
Definition: vtkBillboardTextActor3D.h:163
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkProp3D.h