VTK
vtkTextRepresentation.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkTextRepresentation.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=========================================================================*/
30#ifndef vtkTextRepresentation_h
31#define vtkTextRepresentation_h
32
33#include "vtkInteractionWidgetsModule.h" // For export macro
35
36class vtkRenderer;
37class vtkTextActor;
38class vtkTextProperty;
39class vtkTextRepresentationObserver;
40
41class VTKINTERACTIONWIDGETS_EXPORT vtkTextRepresentation : public vtkBorderRepresentation
42{
43public:
48
50
54 void PrintSelf(ostream& os, vtkIndent indent);
56
58
62 void SetTextActor(vtkTextActor *textActor);
63 vtkGetObjectMacro(TextActor,vtkTextActor);
65
67
70 void SetText(const char* text);
71 const char* GetText();
73
77 virtual void BuildRepresentation();
78 virtual void GetSize(double size[2])
79 {size[0]=2.0; size[1]=2.0;}
80
82
93
94 enum
95 {
96 AnyLocation = 0,
102 UpperCenter
103 };
104
106
117 virtual void SetWindowLocation(int enumLocation);
118 vtkGetMacro(WindowLocation, int);
120
122
126 virtual void SetPosition(double x, double y);
127 virtual void SetPosition(double pos[2])
128 { this->SetPosition(pos[0], pos[1]);};
130
132
135 void ExecuteTextPropertyModifiedEvent(vtkObject* obj, unsigned long enumEvent, void* p);
136 void ExecuteTextActorModifiedEvent(vtkObject* obj, unsigned long enumEvent, void* p);
138
139protected:
142
143 // Initialize text actor
144 virtual void InitializeTextActor();
145
146 // Check and adjust boundaries according to the size of the text
147 virtual void CheckTextBoundary();
148
149 // the text to manage
152
153 // Window location by enumeration
155 virtual void UpdateWindowLocation();
156
157 // observer to observe internal TextActor and TextProperty
158 vtkTextRepresentationObserver *Observer;
159
160private:
161 vtkTextRepresentation(const vtkTextRepresentation&) VTK_DELETE_FUNCTION;
162 void operator=(const vtkTextRepresentation&) VTK_DELETE_FUNCTION;
163};
164
165#endif
represent a vtkBorderWidget
virtual void SetPosition(float x[2])
a simple class to control print indentation
Definition: vtkIndent.h:40
abstract base class for most VTK objects
Definition: vtkObject.h:60
a list of Props
abstract specification for renderers
Definition: vtkRenderer.h:64
An actor that displays text.
Definition: vtkTextActor.h:57
represent text properties.
represent text for vtkTextWidget
virtual int RenderOverlay(vtkViewport *)
virtual void InitializeTextActor()
virtual void CheckTextBoundary()
virtual int RenderTranslucentPolygonalGeometry(vtkViewport *)
virtual void ReleaseGraphicsResources(vtkWindow *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
virtual void SetPosition(double pos[2])
virtual void SetPosition(double x, double y)
Set the text position, by overiding the same function of vtkBorderRepresentation so that the Modified...
virtual void UpdateWindowLocation()
void SetTextActor(vtkTextActor *textActor)
Specify the vtkTextActor to manage.
void SetText(const char *text)
Get/Set the text string display by this representation.
static vtkTextRepresentation * New()
Instantiate class.
virtual int RenderOpaqueGeometry(vtkViewport *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
void ExecuteTextActorModifiedEvent(vtkObject *obj, unsigned long enumEvent, void *p)
void ExecuteTextPropertyModifiedEvent(vtkObject *obj, unsigned long enumEvent, void *p)
Internal.
vtkTextProperty * TextProperty
virtual void GetSize(double size[2])
virtual int HasTranslucentPolygonalGeometry()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
virtual void BuildRepresentation()
Satisfy the superclasses API.
const char * GetText()
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
virtual void SetWindowLocation(int enumLocation)
Set the text position, by enumeration ( AnyLocation = 0, LowerLeftCorner, LowerRightCorner,...
virtual void GetActors2D(vtkPropCollection *)
These methods are necessary to make this representation behave as a vtkProp.
vtkTextRepresentationObserver * Observer
abstract specification for Viewports
Definition: vtkViewport.h:48
window superclass for vtkRenderWindow
Definition: vtkWindow.h:35
@ size
Definition: vtkX3D.h:253