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

#include <vtkCaptionWidget.h>

Inheritance diagram for vtkCaptionWidget:

Collaboration diagram for vtkCaptionWidget:

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)

vtkBorderRepresentation *	GetBorderRepresentation ()

vtkBorderWidget *	NewInstance () const

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

vtkWidgetEventTranslator *	GetEventTranslator ()

void	SetParent (vtkAbstractWidget *parent)

virtual vtkAbstractWidget *	GetParent ()

vtkWidgetRepresentation *	GetRepresentation ()

virtual void	SetManagesCursor (int)

virtual int	GetManagesCursor ()

virtual void	ManagesCursorOn ()

virtual void	ManagesCursorOff ()

vtkAbstractWidget *	NewInstance () const

Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserver *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	OnChar ()

int	GetEnabled ()

void	EnabledOn ()

void	EnabledOff ()

void	On ()

void	Off ()

virtual void	SetInteractor (vtkRenderWindowInteractor *iren)

virtual vtkRenderWindowInteractor *	GetInteractor ()

virtual float	GetPriority ()

virtual void	PickingManagedOn ()

virtual void	PickingManagedOff ()

virtual void	SetPickingManaged (bool)

virtual bool	GetPickingManaged ()

virtual void	SetKeyPressActivation (int)

virtual int	GetKeyPressActivation ()

virtual void	KeyPressActivationOn ()

virtual void	KeyPressActivationOff ()

virtual void	SetKeyPressActivationValue (char)

virtual char	GetKeyPressActivationValue ()

virtual vtkRenderer *	GetDefaultRenderer ()

virtual void	SetDefaultRenderer (vtkRenderer *)

virtual vtkRenderer *	GetCurrentRenderer ()

virtual void	SetCurrentRenderer (vtkRenderer *)

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	ReleaseFocus ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool 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)

vtkCommand *	GetCommand (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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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 &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkCaptionWidget *	New ()

Static Public Member Functions inherited from vtkBorderWidget
static vtkBorderWidget *	New ()

static int	IsTypeOf (const char *type)

static vtkBorderWidget *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractWidget
static int	IsTypeOf (const char *type)

static vtkAbstractWidget *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorObserver
static int	IsTypeOf (const char *type)

static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)

static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])

static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

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 Member Functions inherited from vtkInteractorObserver
	vtkInteractorObserver ()

	~vtkInteractorObserver ()

virtual void	RegisterPickers ()

void	UnRegisterPickers ()

virtual void	PickersModified ()

vtkPickingManager *	GetPickingManager ()

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

vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)

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

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkCaptionAnchorCallback *	AnchorCallback

vtkHandleWidget *	HandleWidget

Protected Attributes inherited from vtkBorderWidget
int	Selectable

int	Resizable

int	WidgetState

Protected Attributes inherited from vtkAbstractWidget
vtkWidgetRepresentation *	WidgetRep

int	ManagesCursor

vtkWidgetEventTranslator *	EventTranslator

vtkWidgetCallbackMapper *	CallbackMapper

vtkAbstractWidget *	Parent

void *	CallData

int	ProcessEvents

Protected Attributes inherited from vtkInteractorObserver
int	Enabled

vtkCallbackCommand *	EventCallbackCommand

vtkCallbackCommand *	KeyPressCallbackCommand

float	Priority

bool	PickingManaged

int	KeyPressActivation

char	KeyPressActivationValue

vtkRenderWindowInteractor *	Interactor

vtkRenderer *	CurrentRenderer

vtkRenderer *	DefaultRenderer

unsigned long	CharObserverTag

unsigned long	DeleteObserverTag

vtkObserverMediator *	ObserverMediator

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkCaptionAnchorCallback

typedef vtkBorderWidget	Superclass

static int	IsTypeOf (const char *type)

static vtkCaptionWidget *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkCaptionWidget *	NewInstance () 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

Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	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)

Static Protected Member Functions inherited from vtkInteractorObserver
static void	ProcessEvents (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::InteractionEvent vtkCommand::StartInteractionEvent vtkCommand::EndInteractionEvent

Tests:: vtkCaptionWidget (Tests)

Definition at line 56 of file vtkCaptionWidget.h.

Member Typedef Documentation

typedef vtkBorderWidget vtkCaptionWidget::Superclass

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
	)

virtual

Standard VTK class methods.

Reimplemented from vtkBorderWidget.

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:

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Interaction/Widgets/vtkCaptionWidget.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation