VTK
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)
vtkTextActorGetTextActor ()
- 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 ()
- 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 ()
- Public Member Functions inherited from vtkInteractorObserver
virtual void OnChar ()
int GetEnabled ()
void EnabledOn ()
void EnabledOff ()
void On ()
void Off ()
virtual void SetInteractor (vtkRenderWindowInteractor *iren)
virtual vtkRenderWindowInteractorGetInteractor ()
virtual float GetPriority ()
virtual void SetKeyPressActivation (int)
virtual int GetKeyPressActivation ()
virtual void KeyPressActivationOn ()
virtual void KeyPressActivationOff ()
virtual void SetKeyPressActivationValue (char)
virtual char GetKeyPressActivationValue ()
virtual vtkRendererGetDefaultRenderer ()
virtual void SetDefaultRenderer (vtkRenderer *)
virtual vtkRendererGetCurrentRenderer ()
virtual void SetCurrentRenderer (vtkRenderer *)
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void ReleaseFocus ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkTextWidgetNew ()
- Static Public Member Functions inherited from vtkBorderWidget

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))
- Protected Member Functions inherited from vtkInteractorObserver
 vtkInteractorObserver ()
 ~vtkInteractorObserver ()
int RequestCursorShape (int requestedShape)
virtual void StartInteraction ()
virtual void EndInteraction ()
void ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
void ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)
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)

Additional Inherited Members

- Public Types inherited from vtkBorderWidget
typedef vtkAbstractWidget Superclass
- Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver Superclass
- Public Types inherited from vtkInteractorObserver
typedef vtkObject 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 *)
- Protected Attributes inherited from vtkBorderWidget
int Selectable
int Resizable
int WidgetState
- Friends inherited from vtkObject

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.

Member Typedef Documentation

Standard VTK methods.

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: