VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkTextWidget Class Reference

widget for placing text on overlay plane More...

#include <vtkTextWidget.h>

Inheritance diagram for vtkTextWidget:
[legend]
Collaboration diagram for vtkTextWidget:
[legend]

Public Member Functions

virtual void CreateDefaultRepresentation ()
 
void SetRepresentation (vtkTextRepresentation *r)
 
void SetTextActor (vtkTextActor *textActor)
 
vtkTextActor * GetTextActor ()
 
- Public Member Functions inherited from vtkBorderWidget
virtual void SetSelectable (int)
 
virtual int GetSelectable ()
 
virtual void SelectableOn ()
 
virtual void SelectableOff ()
 
virtual void SetResizable (int)
 
virtual int GetResizable ()
 
virtual void ResizableOn ()
 
virtual void ResizableOff ()
 
void SetRepresentation (vtkBorderRepresentation *r)
 
vtkBorderRepresentationGetBorderRepresentation ()
 
vtkBorderWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
- Public Member Functions inherited from vtkAbstractWidget
virtual void SetEnabled (int)
 
void Render ()
 
virtual void SetPriority (float)
 
virtual void SetProcessEvents (int)
 
virtual int GetProcessEvents ()
 
virtual void ProcessEventsOn ()
 
virtual void ProcessEventsOff ()
 
vtkWidgetEventTranslatorGetEventTranslator ()
 
void SetParent (vtkAbstractWidget *parent)
 
virtual vtkAbstractWidgetGetParent ()
 
vtkWidgetRepresentationGetRepresentation ()
 
virtual void SetManagesCursor (int)
 
virtual int GetManagesCursor ()
 
virtual void ManagesCursorOn ()
 
virtual void ManagesCursorOff ()
 
vtkAbstractWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkTextWidgetNew ()
 
- Static Public Member Functions inherited from vtkBorderWidget
static vtkBorderWidgetNew ()
 
static int IsTypeOf (const char *type)
 
static vtkBorderWidgetSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractWidget
static int IsTypeOf (const char *type)
 
static vtkAbstractWidgetSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

 vtkTextWidget ()
 
 ~vtkTextWidget ()
 
- Protected Member Functions inherited from vtkBorderWidget
 vtkBorderWidget ()
 
 ~vtkBorderWidget ()
 
virtual void SelectRegion (double eventPos[2])
 
virtual int SubclassSelectAction ()
 
virtual int SubclassTranslateAction ()
 
virtual int SubclassEndSelectAction ()
 
virtual int SubclassMoveAction ()
 
virtual void SetCursor (int State)
 
- Protected Member Functions inherited from vtkAbstractWidget
 vtkAbstractWidget ()
 
 ~vtkAbstractWidget ()
 
void SetWidgetRepresentation (vtkWidgetRepresentation *r)
 
virtual void SetCursor (int vtkNotUsed(state))
 
typedef vtkBorderWidget Superclass
 
static int IsTypeOf (const char *type)
 
static vtkTextWidgetSafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkTextWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkObjectBase * NewInstanceInternal () const
 

Additional Inherited Members

- Public Types inherited from vtkBorderWidget
typedef vtkAbstractWidget Superclass
 
- Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver Superclass
 
- Protected Types inherited from vtkBorderWidget
enum  _WidgetState { Start =0, Define, Manipulate, Selected }
 
- Static Protected Member Functions inherited from vtkBorderWidget
static void SelectAction (vtkAbstractWidget *)
 
static void TranslateAction (vtkAbstractWidget *)
 
static void EndSelectAction (vtkAbstractWidget *)
 
static void MoveAction (vtkAbstractWidget *)
 
- Static Protected Member Functions inherited from vtkAbstractWidget
static void ProcessEventsHandler (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 
- Protected Attributes inherited from vtkBorderWidget
int Selectable
 
int Resizable
 
int WidgetState
 
- Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentationWidgetRep
 
int ManagesCursor
 
vtkWidgetEventTranslatorEventTranslator
 
vtkWidgetCallbackMapperCallbackMapper
 
vtkAbstractWidgetParent
 
void * CallData
 
int ProcessEvents
 

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 42 of file vtkTextWidget.h.

Member Typedef Documentation

Standard VTK methods.

Definition at line 50 of file vtkTextWidget.h.

Constructor & Destructor Documentation

vtkTextWidget::vtkTextWidget ( )
protected
vtkTextWidget::~vtkTextWidget ( )
protected

Member Function Documentation

static vtkTextWidget* vtkTextWidget::New ( )
static

Instantiate class.

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

Standard VTK methods.

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

Standard VTK methods.

Reimplemented from vtkBorderWidget.

static vtkTextWidget* vtkTextWidget::SafeDownCast ( vtkObjectBase *  o)
static

Standard VTK methods.

virtual vtkObjectBase* vtkTextWidget::NewInstanceInternal ( ) const
protectedvirtual

Standard VTK methods.

Reimplemented from vtkBorderWidget.

vtkTextWidget* vtkTextWidget::NewInstance ( ) const

Standard VTK methods.

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

Standard VTK methods.

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 58 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: