vtkCaptionWidget Class Reference

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)
	Override superclasses' SetEnabled() method because the caption leader has its own dedicated widget. More...
void	SetRepresentation (vtkCaptionRepresentation *r)
	Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
void	CreateDefaultRepresentation ()
	Create the default widget representation if one is not set. More...
void	SetCaptionActor2D (vtkCaptionActor2D *capActor)
	Specify a vtkCaptionActor2D to manage. More...
vtkCaptionActor2D *	GetCaptionActor2D ()
	Specify a vtkCaptionActor2D to manage. More...
Public Member Functions inherited from vtkBorderWidget
void	SetRepresentation (vtkBorderRepresentation *r)
	Specify an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
vtkBorderRepresentation *	GetBorderRepresentation ()
	Return the representation as a vtkBorderRepresentation. More...
virtual void	SetSelectable (int)
	Indicate whether the interior region of the widget can be selected or not. More...
virtual int	GetSelectable ()
	Indicate whether the interior region of the widget can be selected or not. More...
virtual void	SelectableOn ()
	Indicate whether the interior region of the widget can be selected or not. More...
virtual void	SelectableOff ()
	Indicate whether the interior region of the widget can be selected or not. More...
virtual void	SetResizable (int)
	Indicate whether the boundary of the widget can be resized. More...
virtual int	GetResizable ()
	Indicate whether the boundary of the widget can be resized. More...
virtual void	ResizableOn ()
	Indicate whether the boundary of the widget can be resized. More...
virtual void	ResizableOff ()
	Indicate whether the boundary of the widget can be resized. More...
vtkBorderWidget *	NewInstance () const
	Standard methods for class. More...
Public Member Functions inherited from vtkAbstractWidget
vtkWidgetEventTranslator *	GetEventTranslator ()
	Get the event translator. More...
void	Render ()
	This method is called by subclasses when a render method is to be invoked on the vtkRenderWindowInteractor. More...
void	SetParent (vtkAbstractWidget *parent)
	Specifying a parent to this widget is used when creating composite widgets. More...
virtual vtkAbstractWidget *	GetParent ()
virtual void	SetPriority (float)
	Override the superclass method. More...
virtual void	SetProcessEvents (int)
	Methods to change whether the widget responds to interaction. More...
virtual int	GetProcessEvents ()
	Methods to change whether the widget responds to interaction. More...
virtual void	ProcessEventsOn ()
	Methods to change whether the widget responds to interaction. More...
virtual void	ProcessEventsOff ()
	Methods to change whether the widget responds to interaction. More...
vtkWidgetRepresentation *	GetRepresentation ()
	Return an instance of vtkWidgetRepresentation used to represent this widget in the scene. More...
virtual void	SetManagesCursor (int)
	Turn on or off the management of the cursor. More...
virtual int	GetManagesCursor ()
	Turn on or off the management of the cursor. More...
virtual void	ManagesCursorOn ()
	Turn on or off the management of the cursor. More...
virtual void	ManagesCursorOff ()
	Turn on or off the management of the cursor. More...
vtkAbstractWidget *	NewInstance () const
	Standard macros implementing standard VTK methods. More...
Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserver *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
int	GetEnabled ()
void	EnabledOn ()
void	EnabledOff ()
void	On ()
void	Off ()
virtual void	OnChar ()
	Sets up the keypress-i event. More...
virtual void	SetInteractor (vtkRenderWindowInteractor *iren)
	This method is used to associate the widget with the render window interactor. More...
virtual vtkRenderWindowInteractor *	GetInteractor ()
	This method is used to associate the widget with the render window interactor. More...
virtual float	GetPriority ()
	Set/Get the priority at which events are processed. More...
virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking. More...
virtual void	PickingManagedOff ()
	Enable/Disable the use of a manager to process the picking. More...
virtual void	SetPickingManaged (bool)
	Enable/Disable the use of a manager to process the picking. More...
virtual bool	GetPickingManaged ()
	Enable/Disable the use of a manager to process the picking. More...
virtual void	SetKeyPressActivation (int)
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
virtual int	GetKeyPressActivation ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
virtual void	KeyPressActivationOn ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
virtual void	KeyPressActivationOff ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
virtual void	SetKeyPressActivationValue (char)
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
virtual char	GetKeyPressActivationValue ()
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
virtual vtkRenderer *	GetDefaultRenderer ()
	Set/Get the default renderer to use when activating the interactor observer. More...
virtual void	SetDefaultRenderer (vtkRenderer *)
	Set/Get the default renderer to use when activating the interactor observer. More...
virtual vtkRenderer *	GetCurrentRenderer ()
	Set/Get the current renderer. More...
virtual void	SetCurrentRenderer (vtkRenderer *)
	Set/Get the current renderer. More...
void	GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
void	ReleaseFocus ()
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on. More...
virtual void	DebugOff ()
	Turn debugging output off. More...
bool	GetDebug ()
	Get the value of the debug flag. More...
void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...
virtual void	Modified ()
	Update the modification time for this object. More...
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
int	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...
virtual void	Delete ()
	Delete a VTK object. More...
virtual void	FastDelete ()
	Delete a reference to this object. More...
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream. More...
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...
int	GetReferenceCount ()
	Return the current reference count of this object. More...
void	SetReferenceCount (int)
	Sets the reference count. More...
void	PrintRevisions (ostream &)
	Legacy. More...
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkCaptionWidget *	New ()
	Instantiate this class. More...
Static Public Member Functions inherited from vtkBorderWidget
static vtkBorderWidget *	New ()
	Method to instantiate class. More...
static int	IsTypeOf (const char *type)
	Standard methods for class. More...
static vtkBorderWidget *	SafeDownCast (vtkObjectBase *o)
	Standard methods for class. More...
Static Public Member Functions inherited from vtkAbstractWidget
static int	IsTypeOf (const char *type)
	Standard macros implementing standard VTK methods. More...
static vtkAbstractWidget *	SafeDownCast (vtkObjectBase *o)
	Standard macros implementing standard VTK methods. More...
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])
	Convenience methods for outside classes. More...
static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
	Convenience methods for outside classes. More...
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

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])
	Subclasses generally implement this method. More...
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 ()
	Register internal Pickers in the Picking Manager. More...
void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager. More...
virtual void	PickersModified ()
	Update the pickers registered in the Picking Manager when pickers are modified. More...
vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the observer currently belong. More...
vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
	Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path. More...
int	RequestCursorShape (int requestedShape)
virtual void	StartInteraction ()
	Utility routines used to start and end interaction. More...
virtual void	EndInteraction ()
	Utility routines used to start and end interaction. More...
void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
	Helper method for subclasses. More...
void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
	Helper method for subclasses. More...
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...
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
	Standard VTK class methods. More...
static int	IsTypeOf (const char *type)
	Standard VTK class methods. More...
static vtkCaptionWidget *	SafeDownCast (vtkObjectBase *o)
	Standard VTK class methods. More...
virtual int	IsA (const char *type)
	Standard VTK class methods. More...
vtkCaptionWidget *	NewInstance () const
	Standard VTK class methods. More...
void	PrintSelf (ostream &os, vtkIndent indent)
	Standard VTK class methods. More...
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard VTK class methods. More...

Additional Inherited Members
Public Types inherited from vtkBorderWidget
typedef vtkAbstractWidget	Superclass
	Standard methods for class. More...
Public Types inherited from vtkAbstractWidget
typedef vtkInteractorObserver	Superclass
	Standard macros implementing standard VTK methods. More...
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 *)
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)
	Handles the char widget activation event. More...

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

Tests:

vtkCaptionWidget (Tests)

Definition at line 54 of file vtkCaptionWidget.h.

Member Typedef Documentation

typedef vtkBorderWidget vtkCaptionWidget::Superclass

Standard VTK class methods.

Definition at line 66 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 81 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 114 of file vtkCaptionWidget.h.

Member Data Documentation

vtkCaptionAnchorCallback* vtkCaptionWidget::AnchorCallback

protected

Definition at line 104 of file vtkCaptionWidget.h.

vtkHandleWidget* vtkCaptionWidget::HandleWidget

protected

Definition at line 107 of file vtkCaptionWidget.h.

---

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

• /home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Interaction/Widgets/vtkCaptionWidget.h