vtkTextWidget Class Reference

#include <vtkTextWidget.h>

Inheritance diagram for vtkTextWidget:

Inheritance graph
[legend]
Collaboration diagram for vtkTextWidget:

Collaboration graph
[legend]

List of all members.


Detailed Description

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.)

See also:
vtkBorderWidget vtkCaptionWidget
Tests:
vtkTextWidget (Tests)

Definition at line 41 of file vtkTextWidget.h.

typedef vtkBorderWidget Superclass
static int IsTypeOf (const char *type)
static vtkTextWidgetSafeDownCast (vtkObject *o)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

Public Member Functions

virtual void CreateDefaultRepresentation ()
void SetRepresentation (vtkTextRepresentation *r)
void SetTextActor (vtkTextActor *textActor)
vtkTextActorGetTextActor ()

Static Public Member Functions

static vtkTextWidgetNew ()

Protected Member Functions

 vtkTextWidget ()
 ~vtkTextWidget ()

Member Typedef Documentation

Standard VTK methods.

Reimplemented from vtkBorderWidget.

Definition at line 49 of file vtkTextWidget.h.


Constructor & Destructor Documentation

vtkTextWidget::vtkTextWidget (  )  [protected]

vtkTextWidget::~vtkTextWidget (  )  [protected]


Member Function Documentation

static vtkTextWidget* vtkTextWidget::New (  )  [static]

Instantiate class.

Reimplemented from vtkBorderWidget.

virtual const char* vtkTextWidget::GetClassName (  )  [virtual]

Standard VTK methods.

Reimplemented from vtkBorderWidget.

static int vtkTextWidget::IsTypeOf ( const char *  type  )  [static]

Standard VTK methods.

Reimplemented from vtkBorderWidget.

virtual int vtkTextWidget::IsA ( const char *  type  )  [virtual]

Standard VTK methods.

Reimplemented from vtkBorderWidget.

static vtkTextWidget* vtkTextWidget::SafeDownCast ( vtkObject o  )  [static]

Standard VTK methods.

Reimplemented from vtkBorderWidget.

void vtkTextWidget::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Standard VTK methods.

Reimplemented from vtkBorderWidget.

void vtkTextWidget::SetRepresentation ( vtkTextRepresentation r  )  [inline]

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.

Definition at line 57 of file vtkTextWidget.h.

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().

virtual void vtkTextWidget::CreateDefaultRepresentation (  )  [virtual]

Create the default widget representation if one is not set.

Reimplemented from vtkBorderWidget.


The documentation for this class was generated from the following file:

Generated on Wed Aug 24 12:13:14 2011 for VTK by  doxygen 1.5.6