VTK
9.3.20240831
|
widget for placing text on overlay plane More...
#include <vtkTextWidget.h>
Public Member Functions | |
void | SetRepresentation (vtkTextRepresentation *r) |
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. | |
void | CreateDefaultRepresentation () override |
Create the default widget representation if one is not set. | |
void | SetTextActor (vtkTextActor *textActor) |
Specify a vtkTextActor to manage. | |
vtkTextActor * | GetTextActor () |
Specify a vtkTextActor to manage. | |
![]() | |
void | SetRepresentation (vtkBorderRepresentation *r) |
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. | |
vtkBorderRepresentation * | GetBorderRepresentation () |
Return the representation as a vtkBorderRepresentation. | |
void | CreateDefaultRepresentation () override |
Create the default widget representation if one is not set. | |
vtkTypeBool | GetProcessEvents () override |
Reimplement ProcessEvents to disable it when using relative location with windowLocation. | |
virtual void | SetSelectable (vtkTypeBool) |
Indicate whether the interior region of the widget can be selected or not. | |
virtual vtkTypeBool | GetSelectable () |
Indicate whether the interior region of the widget can be selected or not. | |
virtual void | SelectableOn () |
Indicate whether the interior region of the widget can be selected or not. | |
virtual void | SelectableOff () |
Indicate whether the interior region of the widget can be selected or not. | |
virtual void | SetResizable (vtkTypeBool) |
Indicate whether the boundary of the widget can be resized. | |
virtual vtkTypeBool | GetResizable () |
Indicate whether the boundary of the widget can be resized. | |
virtual void | ResizableOn () |
Indicate whether the boundary of the widget can be resized. | |
virtual void | ResizableOff () |
Indicate whether the boundary of the widget can be resized. | |
vtkBorderWidget * | NewInstance () const |
Standard methods for class. | |
![]() | |
void | SetEnabled (int) override |
Methods for activating this widget. | |
vtkWidgetEventTranslator * | GetEventTranslator () |
Get the event translator. | |
virtual void | CreateDefaultRepresentation ()=0 |
Create the default widget representation if one is not set. | |
void | Render () |
This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor. | |
void | SetParent (vtkAbstractWidget *parent) |
Specifying a parent to this widget is used when creating composite widgets. | |
virtual vtkAbstractWidget * | GetParent () |
void | SetPriority (float) override |
Override the superclass method. | |
virtual void | SetProcessEvents (vtkTypeBool) |
Methods to change whether the widget responds to interaction. | |
virtual void | ProcessEventsOn () |
Methods to change whether the widget responds to interaction. | |
virtual void | ProcessEventsOff () |
Methods to change whether the widget responds to interaction. | |
vtkWidgetRepresentation * | GetRepresentation () |
Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. | |
virtual void | SetManagesCursor (vtkTypeBool) |
Turn on or off the management of the cursor. | |
virtual vtkTypeBool | GetManagesCursor () |
Turn on or off the management of the cursor. | |
virtual void | ManagesCursorOn () |
Turn on or off the management of the cursor. | |
virtual void | ManagesCursorOff () |
Turn on or off the management of the cursor. | |
vtkAbstractWidget * | NewInstance () const |
Standard macros implementing standard VTK methods. | |
![]() | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkInteractorObserver * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | SetEnabled (int) |
Methods for turning the interactor observer on and off, and determining its state. | |
int | GetEnabled () |
void | EnabledOn () |
void | EnabledOff () |
void | On () |
void | Off () |
virtual void | OnChar () |
Sets up the keypress-i event. | |
virtual void | SetInteractor (vtkRenderWindowInteractor *iren) |
This method is used to associate the widget with the render window interactor. | |
virtual vtkRenderWindowInteractor * | GetInteractor () |
This method is used to associate the widget with the render window interactor. | |
virtual float | GetPriority () |
Set/Get the priority at which events are processed. | |
virtual void | PickingManagedOn () |
Enable/Disable the use of a manager to process the picking. | |
virtual void | PickingManagedOff () |
Enable/Disable the use of a manager to process the picking. | |
virtual void | SetPickingManaged (bool managed) |
Enable/Disable the use of a manager to process the picking. | |
virtual bool | GetPickingManaged () |
Enable/Disable the use of a manager to process the picking. | |
virtual void | SetKeyPressActivation (vtkTypeBool) |
Enable/Disable of the use of a keypress to turn on and off the interactor observer. | |
virtual vtkTypeBool | GetKeyPressActivation () |
Enable/Disable of the use of a keypress to turn on and off the interactor observer. | |
virtual void | KeyPressActivationOn () |
Enable/Disable of the use of a keypress to turn on and off the interactor observer. | |
virtual void | KeyPressActivationOff () |
Enable/Disable of the use of a keypress to turn on and off the interactor observer. | |
virtual void | SetKeyPressActivationValue (char) |
Specify which key press value to use to activate the interactor observer (if key press activation is enabled). | |
virtual char | GetKeyPressActivationValue () |
Specify which key press value to use to activate the interactor observer (if key press activation is enabled). | |
virtual vtkRenderer * | GetDefaultRenderer () |
Set/Get the default renderer to use when activating the interactor observer. | |
virtual void | SetDefaultRenderer (vtkRenderer *) |
Set/Get the default renderer to use when activating the interactor observer. | |
virtual vtkRenderer * | GetCurrentRenderer () |
Set/Get the current renderer. | |
virtual void | SetCurrentRenderer (vtkRenderer *) |
Set/Get the current renderer. | |
void | GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. | |
void | ReleaseFocus () |
These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. | |
![]() | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
vtkTypeBool | HasObserver (unsigned long event) |
vtkTypeBool | HasObserver (const char *event) |
vtkTypeBool | InvokeEvent (unsigned long event) |
vtkTypeBool | InvokeEvent (const char *event) |
std::string | GetObjectDescription () const override |
The object description printed in messages and PrintSelf output. | |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Allow user to set the AbortFlagOn() with the return value of the callback method. | |
vtkTypeBool | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
vtkTypeBool | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
virtual void | SetObjectName (const std::string &objectName) |
Set/get the name of this object for reporting purposes. | |
virtual std::string | GetObjectName () const |
Set/get the name of this object for reporting purposes. | |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual std::string | GetObjectDescription () const |
The object description printed in messages and PrintSelf output. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual bool | UsesGarbageCollector () const |
Indicate whether the class uses vtkGarbageCollector or not. | |
Static Public Member Functions | |
static vtkTextWidget * | New () |
Instantiate class. | |
![]() | |
static vtkBorderWidget * | New () |
Method to instantiate class. | |
static vtkTypeBool | IsTypeOf (const char *type) |
Standard methods for class. | |
static vtkBorderWidget * | SafeDownCast (vtkObjectBase *o) |
Standard methods for class. | |
![]() | |
static vtkTypeBool | IsTypeOf (const char *type) |
Standard macros implementing standard VTK methods. | |
static vtkAbstractWidget * | SafeDownCast (vtkObjectBase *o) |
Standard macros implementing standard VTK methods. | |
![]() | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkInteractorObserver * | SafeDownCast (vtkObjectBase *o) |
static void | ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4]) |
Convenience methods for outside classes. | |
static void | ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3]) |
Convenience methods for outside classes. | |
![]() | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (vtkTypeBool val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static vtkTypeBool | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
![]() | |
static vtkTypeBool | IsTypeOf (const char *name) |
Return 1 if this class type is the same type of (or a subclass of) the named class. | |
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. | |
Protected Member Functions | |
vtkTextWidget () | |
~vtkTextWidget () override | |
![]() | |
vtkBorderWidget () | |
~vtkBorderWidget () override | |
virtual void | SelectRegion (double eventPos[2]) |
Subclasses generally implement this method. | |
virtual int | SubclassSelectAction () |
virtual int | SubclassTranslateAction () |
virtual int | SubclassEndSelectAction () |
virtual int | SubclassMoveAction () |
void | SetCursor (int State) override |
![]() | |
vtkAbstractWidget () | |
~vtkAbstractWidget () override | |
void | SetWidgetRepresentation (vtkWidgetRepresentation *r) |
virtual void | SetCursor (int vtkNotUsed(state)) |
![]() | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkInteractorObserver () | |
~vtkInteractorObserver () override | |
virtual void | RegisterPickers () |
Register internal Pickers in the Picking Manager. | |
void | UnRegisterPickers () |
Unregister internal pickers from the Picking Manager. | |
vtkPickingManager * | GetPickingManager () |
Return the picking manager associated on the context on which the observer currently belong. | |
vtkAssemblyPath * | GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker) |
Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path. | |
int | RequestCursorShape (int requestedShape) |
virtual void | StartInteraction () |
Utility routines used to start and end interaction. | |
virtual void | EndInteraction () |
Utility routines used to start and end interaction. | |
void | ComputeDisplayToWorld (double x, double y, double z, double worldPt[4]) |
Helper method for subclasses. | |
void | ComputeWorldToDisplay (double x, double y, double z, double displayPt[3]) |
Helper method for subclasses. | |
![]() | |
vtkObject () | |
~vtkObject () override | |
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
These methods allow a command to exclusively grab all events. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
virtual void | ObjectFinalize () |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
typedef vtkBorderWidget | Superclass |
Standard VTK methods. | |
static vtkTypeBool | IsTypeOf (const char *type) |
Standard VTK methods. | |
static vtkTextWidget * | SafeDownCast (vtkObjectBase *o) |
Standard VTK methods. | |
virtual vtkTypeBool | IsA (const char *type) |
Standard VTK methods. | |
vtkTextWidget * | NewInstance () const |
Standard VTK methods. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Standard VTK methods. | |
virtual vtkObjectBase * | NewInstanceInternal () const |
Standard VTK methods. | |
widget for placing text on overlay plane
This class provides support for interactively placing text on the 2D overlay plane. The text is defined by an instance of vtkTextActor. It uses the event bindings of its superclass (vtkBorderWidget). In addition, when the text is selected, the widget emits a WidgetActivateEvent that observers can watch for. This is useful for opening GUI dialogues to adjust font characteristics, etc. (Please see the superclass for a description of event bindings.)
Definition at line 51 of file vtkTextWidget.h.
Standard VTK methods.
Definition at line 63 of file vtkTextWidget.h.
|
protected |
|
overrideprotected |
|
static |
Instantiate class.
|
static |
Standard VTK methods.
|
virtual |
Standard VTK methods.
Reimplemented from vtkBorderWidget.
|
static |
Standard VTK methods.
|
protectedvirtual |
Standard VTK methods.
Reimplemented from vtkBorderWidget.
vtkTextWidget * vtkTextWidget::NewInstance | ( | ) | const |
Standard VTK methods.
|
overridevirtual |
Standard VTK methods.
Reimplemented from vtkBorderWidget.
void vtkTextWidget::SetRepresentation | ( | vtkTextRepresentation * | r | ) |
Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene.
Note that the representation is a subclass of vtkProp so it can be added to the renderer independent of the widget.
void vtkTextWidget::SetTextActor | ( | vtkTextActor * | textActor | ) |
Specify a vtkTextActor to manage.
This is a convenient, alternative method to specify the representation for the widget (i.e., used instead of SetRepresentation()). It internally creates a vtkTextRepresentation and then invokes vtkTextRepresentation::SetTextActor().
vtkTextActor * vtkTextWidget::GetTextActor | ( | ) |
Specify a vtkTextActor to manage.
This is a convenient, alternative method to specify the representation for the widget (i.e., used instead of SetRepresentation()). It internally creates a vtkTextRepresentation and then invokes vtkTextRepresentation::SetTextActor().
|
overridevirtual |
Create the default widget representation if one is not set.
Reimplemented from vtkBorderWidget.