VTK  9.5.20250810
vtkTextActor3D.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
24#ifndef vtkTextActor3D_h
25#define vtkTextActor3D_h
26
27#include "vtkProp3D.h"
28#include "vtkRenderingCoreModule.h" // For export macro
29#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
30#include <string> // for ivar
31
32VTK_ABI_NAMESPACE_BEGIN
33class vtkImageActor;
34class vtkImageData;
35class vtkTextProperty;
36
37class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkTextActor3D : public vtkProp3D
38{
39public:
41 vtkTypeMacro(vtkTextActor3D, vtkProp3D);
42 void PrintSelf(ostream& os, vtkIndent indent) override;
43
45
48 vtkSetStringMacro(Input);
49 vtkGetStringMacro(Input);
51
53
57 vtkGetObjectMacro(TextProperty, vtkTextProperty);
59
66 static int GetRenderedDPI() { return 72; }
67
72 void ShallowCopy(vtkProp* prop) override;
73
77 double* GetBounds() VTK_SIZEHINT(6) override;
78 void GetBounds(double bounds[6]) { this->vtkProp3D::GetBounds(bounds); }
79
85 int GetBoundingBox(int bbox[4]);
86
95
100 virtual void SetForceOpaque(bool opaque);
101 virtual bool GetForceOpaque();
102 virtual void ForceOpaqueOn();
103 virtual void ForceOpaqueOff();
104 virtual void SetForceTranslucent(bool trans);
105 virtual bool GetForceTranslucent();
106 virtual void ForceTranslucentOn();
107 virtual void ForceTranslucentOff();
111
116 int RenderOpaqueGeometry(vtkViewport* viewport) override;
118 int RenderOverlay(vtkViewport* viewport) override;
120
125
126protected:
128 ~vtkTextActor3D() override;
129
130 char* Input;
131
135
137 std::string LastInputString;
138
139 virtual int UpdateImageActor();
140
141private:
142 vtkTextActor3D(const vtkTextActor3D&) = delete;
143 void operator=(const vtkTextActor3D&) = delete;
144};
145
146VTK_ABI_NAMESPACE_END
147#endif
draw an image in a rendered 3D scene
topologically and geometrically regular array of data
a simple class to control print indentation
Definition vtkIndent.h:108
represents an 3D object for placement in a rendered scene
Definition vtkProp3D.h:89
double * GetBounds() override=0
Return a reference to the Prop3D's composite transform.
abstract superclass for all actors, volumes and annotations
Definition vtkProp.h:69
An actor that displays text.
static int GetRenderedDPI()
Since a 3D text actor is not pixel-aligned and positioned in 3D space, the text is rendered at a cons...
virtual void SetForceOpaque(bool opaque)
Force the actor to render during the opaque or translucent pass.
vtkImageActor * ImageActor
virtual void ForceOpaqueOn()
Force the actor to render during the opaque or translucent pass.
virtual bool GetForceOpaque()
Force the actor to render during the opaque or translucent pass.
int RenderOpaqueGeometry(vtkViewport *viewport) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
virtual void SetTextProperty(vtkTextProperty *p)
Set/Get the text property.
virtual void ForceOpaqueOff()
Force the actor to render during the opaque or translucent pass.
double * GetBounds() override
Get the bounds for this Prop3D as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
int RenderTranslucentPolygonalGeometry(vtkViewport *viewport) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
int GetBoundingBox(int bbox[4])
Get the vtkTextRenderer-derived bounding box for the given vtkTextProperty and text string str.
static vtkTextActor3D * New()
vtkImageData * ImageData
std::string LastInputString
virtual void ForceTranslucentOff()
Force the actor to render during the opaque or translucent pass.
void ReleaseGraphicsResources(vtkWindow *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
vtkTextProperty * TextProperty
~vtkTextActor3D() override
virtual void SetForceTranslucent(bool trans)
Force the actor to render during the opaque or translucent pass.
int RenderOverlay(vtkViewport *viewport) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
vtkTimeStamp BuildTime
void ShallowCopy(vtkProp *prop) override
Shallow copy of this text actor.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void ForceTranslucentOn()
Force the actor to render during the opaque or translucent pass.
vtkTypeBool HasTranslucentPolygonalGeometry() override
Does this prop have some translucent polygonal geometry?
virtual int UpdateImageActor()
virtual bool GetForceTranslucent()
Force the actor to render during the opaque or translucent pass.
represent text properties.
record modification and/or execution time
abstract specification for Viewports
Definition vtkViewport.h:66
window superclass for vtkRenderWindow
Definition vtkWindow.h:48
int vtkTypeBool
Definition vtkABI.h:64
#define VTK_SIZEHINT(...)
#define VTK_MARSHALAUTO