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

widget for placing a caption (text plus leader) More...

#include <vtkCaptionWidget.h>

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

Public Member Functions

virtual void SetEnabled (int enabling)
 
void CreateDefaultRepresentation ()
 
void SetRepresentation (vtkCaptionRepresentation *r)
 
void SetCaptionActor2D (vtkCaptionActor2D *capActor)
 
vtkCaptionActor2D * GetCaptionActor2D ()
 
- 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
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 vtkCaptionWidgetNew ()
 
- 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

 vtkCaptionWidget ()
 
 ~vtkCaptionWidget ()
 
void StartAnchorInteraction ()
 
void AnchorInteraction ()
 
void EndAnchorInteraction ()
 
- 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 Attributes

vtkCaptionAnchorCallbackAnchorCallback
 
vtkHandleWidgetHandleWidget
 
- 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
 

Friends

class vtkCaptionAnchorCallback
 
typedef vtkBorderWidget Superclass
 
static int IsTypeOf (const char *type)
 
static vtkCaptionWidgetSafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkCaptionWidgetNewInstance () 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)
 

Detailed Description

widget for placing a caption (text plus leader)

This class provides support for interactively placing a caption on the 2D overlay plane. A caption is defined by some text with a leader (e.g., arrow) that points from the text to a point in the scene. The caption is represented by a vtkCaptionRepresentation. It uses the event bindings of its superclass (vtkBorderWidget) to control the placement of the text, and adds the ability to move the attachment point around. In addition, when the caption text is selected, the widget emits a ActivateEvent that observers can watch for. This is useful for opening GUI dialogoues to adjust font characteristics, etc. (Please see the superclass for a description of event bindings.)

Note that this widget extends the behavior of its superclass vtkBorderWidget. The end point of the leader can be selected and moved around with an internal vtkHandleWidget.

See Also
vtkBorderWidget vtkTextWidget
Events:
vtkCommand::StartInteractionEvent vtkCommand::InteractionEvent vtkCommand::EndInteractionEvent
Tests:
vtkCaptionWidget (Tests)

Definition at line 56 of file vtkCaptionWidget.h.

Member Typedef Documentation

Standard VTK class methods.

Definition at line 64 of file vtkCaptionWidget.h.

Constructor & Destructor Documentation

vtkCaptionWidget::vtkCaptionWidget ( )
protected
vtkCaptionWidget::~vtkCaptionWidget ( )
protected

Member Function Documentation

static vtkCaptionWidget* vtkCaptionWidget::New ( )
static

Instantiate this class.

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

Standard VTK class methods.

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

Standard VTK class methods.

Reimplemented from vtkBorderWidget.

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

Standard VTK class methods.

virtual vtkObjectBase* vtkCaptionWidget::NewInstanceInternal ( ) const
protectedvirtual

Standard VTK class methods.

Reimplemented from vtkBorderWidget.

vtkCaptionWidget* vtkCaptionWidget::NewInstance ( ) const

Standard VTK class methods.

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

Standard VTK class methods.

virtual void vtkCaptionWidget::SetEnabled ( int  enabling)
virtual

Override superclasses' SetEnabled() method because the caption leader has its own dedicated widget.

Reimplemented from vtkAbstractWidget.

void vtkCaptionWidget::SetRepresentation ( vtkCaptionRepresentation 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 76 of file vtkCaptionWidget.h.

void vtkCaptionWidget::SetCaptionActor2D ( vtkCaptionActor2D *  capActor)

Specify a vtkCaptionActor2D to manage. This is convenient, alternative method to SetRepresentation(). It internally create a vtkCaptionRepresentation and then invokes vtkCaptionRepresentation::SetCaptionActor2D().

vtkCaptionActor2D* vtkCaptionWidget::GetCaptionActor2D ( )

Specify a vtkCaptionActor2D to manage. This is convenient, alternative method to SetRepresentation(). It internally create a vtkCaptionRepresentation and then invokes vtkCaptionRepresentation::SetCaptionActor2D().

void vtkCaptionWidget::CreateDefaultRepresentation ( )
virtual

Create the default widget representation if one is not set.

Reimplemented from vtkBorderWidget.

void vtkCaptionWidget::StartAnchorInteraction ( )
protected
void vtkCaptionWidget::AnchorInteraction ( )
protected
void vtkCaptionWidget::EndAnchorInteraction ( )
protected

Friends And Related Function Documentation

friend class vtkCaptionAnchorCallback
friend

Definition at line 108 of file vtkCaptionWidget.h.

Member Data Documentation

vtkCaptionAnchorCallback* vtkCaptionWidget::AnchorCallback
protected

Definition at line 97 of file vtkCaptionWidget.h.

vtkHandleWidget* vtkCaptionWidget::HandleWidget
protected

Definition at line 100 of file vtkCaptionWidget.h.


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