VTK  9.0.1
vtkTextActor3D.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkTextActor3D.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 =========================================================================*/
33 #ifndef vtkTextActor3D_h
34 #define vtkTextActor3D_h
35 
36 #include "vtkProp3D.h"
37 #include "vtkRenderingCoreModule.h" // For export macro
38 #include <string> // for ivar
39 
40 class vtkImageActor;
41 class vtkImageData;
42 class vtkTextProperty;
43 
44 class VTKRENDERINGCORE_EXPORT vtkTextActor3D : public vtkProp3D
45 {
46 public:
47  static vtkTextActor3D* New();
48  vtkTypeMacro(vtkTextActor3D, vtkProp3D);
49  void PrintSelf(ostream& os, vtkIndent indent) override;
50 
52 
55  vtkSetStringMacro(Input);
56  vtkGetStringMacro(Input);
58 
60 
63  virtual void SetTextProperty(vtkTextProperty* p);
64  vtkGetObjectMacro(TextProperty, vtkTextProperty);
66 
73  static int GetRenderedDPI() { return 72; }
74 
79  void ShallowCopy(vtkProp* prop) override;
80 
84  double* GetBounds() VTK_SIZEHINT(6) override;
85  void GetBounds(double bounds[6]) { this->vtkProp3D::GetBounds(bounds); }
86 
92  int GetBoundingBox(int bbox[4]);
93 
102 
107  virtual void SetForceOpaque(bool opaque);
108  virtual bool GetForceOpaque();
109  virtual void ForceOpaqueOn();
110  virtual void ForceOpaqueOff();
111  virtual void SetForceTranslucent(bool trans);
112  virtual bool GetForceTranslucent();
113  virtual void ForceTranslucentOn();
114  virtual void ForceTranslucentOff();
123  int RenderOpaqueGeometry(vtkViewport* viewport) override;
125  int RenderOverlay(vtkViewport* viewport) override;
127 
132 
133 protected:
135  ~vtkTextActor3D() override;
136 
137  char* Input;
138 
142 
145 
146  virtual int UpdateImageActor();
147 
148 private:
149  vtkTextActor3D(const vtkTextActor3D&) = delete;
150  void operator=(const vtkTextActor3D&) = delete;
151 };
152 
153 #endif
vtkTextActor3D::HasTranslucentPolygonalGeometry
vtkTypeBool HasTranslucentPolygonalGeometry() override
Does this prop have some translucent polygonal geometry?
vtkTextActor3D::GetForceTranslucent
virtual bool GetForceTranslucent()
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
vtkTextActor3D::ReleaseGraphicsResources
void ReleaseGraphicsResources(vtkWindow *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
vtkTextActor3D
An actor that displays text.
Definition: vtkTextActor3D.h:45
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:33
vtkTextActor3D::ImageActor
vtkImageActor * ImageActor
Definition: vtkTextActor3D.h:139
vtkTextActor3D::New
static vtkTextActor3D * New()
vtkTextActor3D::SetTextProperty
virtual void SetTextProperty(vtkTextProperty *p)
Set/Get the text property.
vtkTextActor3D::GetRenderedDPI
static int GetRenderedDPI()
Since a 3D text actor is not pixel-aligned and positioned in 3D space, the text is rendered at a cons...
Definition: vtkTextActor3D.h:73
vtkTextActor3D::ForceTranslucentOff
virtual void ForceTranslucentOff()
Force the actor to render during the opaque or translucent pass.
vtkProp3D::GetBounds
double * GetBounds() override=0
Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
vtkTextActor3D::SetForceOpaque
virtual void SetForceOpaque(bool opaque)
Force the actor to render during the opaque or translucent pass.
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:35
vtkTextActor3D::ShallowCopy
void ShallowCopy(vtkProp *prop) override
Shallow copy of this text actor.
vtkTextActor3D::UpdateImageActor
virtual int UpdateImageActor()
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:45
vtkTextActor3D::GetBounds
double * GetBounds() override
Get the bounds for this Prop3D as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
vtkTextActor3D::BuildTime
vtkTimeStamp BuildTime
Definition: vtkTextActor3D.h:143
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:42
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:34
vtkTextActor3D::TextProperty
vtkTextProperty * TextProperty
Definition: vtkTextActor3D.h:141
vtkTextActor3D::RenderOverlay
int RenderOverlay(vtkViewport *viewport) override
vtkTextActor3D::GetBoundingBox
int GetBoundingBox(int bbox[4])
Get the vtkTextRenderer-derived bounding box for the given vtkTextProperty and text string str.
vtkTextActor3D::RenderTranslucentPolygonalGeometry
int RenderTranslucentPolygonalGeometry(vtkViewport *viewport) override
vtkTextActor3D::ForceOpaqueOff
virtual void ForceOpaqueOff()
Force the actor to render during the opaque or translucent pass.
vtkViewport
abstract specification for Viewports
Definition: vtkViewport.h:45
vtkTextActor3D::GetForceOpaque
virtual bool GetForceOpaque()
Force the actor to render during the opaque or translucent pass.
vtkTextProperty
represent text properties.
Definition: vtkTextProperty.h:34
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:48
vtkX3D::string
@ string
Definition: vtkX3D.h:496
vtkTextActor3D::ForceOpaqueOn
virtual void ForceOpaqueOn()
Force the actor to render during the opaque or translucent pass.
vtkTextActor3D::RenderOpaqueGeometry
int RenderOpaqueGeometry(vtkViewport *viewport) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
vtkTextActor3D::SetForceTranslucent
virtual void SetForceTranslucent(bool trans)
Force the actor to render during the opaque or translucent pass.
vtkTextActor3D::~vtkTextActor3D
~vtkTextActor3D() override
vtkTextActor3D::ForceTranslucentOn
virtual void ForceTranslucentOn()
Force the actor to render during the opaque or translucent pass.
vtkTextActor3D::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkImageActor
draw an image in a rendered 3D scene
Definition: vtkImageActor.h:43
vtkTextActor3D::Input
char * Input
Definition: vtkTextActor3D.h:137
vtkTextActor3D::ImageData
vtkImageData * ImageData
Definition: vtkTextActor3D.h:140
vtkTextActor3D::vtkTextActor3D
vtkTextActor3D()
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkProp3D.h
vtkTextActor3D::LastInputString
std::string LastInputString
Definition: vtkTextActor3D.h:144