vtkKWCornerAnnotationEditor Class Reference

a corner annotation widget More...

#include <vtkKWCornerAnnotationEditor.h>

Inheritance diagram for vtkKWCornerAnnotationEditor:

[legend]

Collaboration diagram for vtkKWCornerAnnotationEditor:

[legend]

List of all members.

Public Types
typedef vtkKWCheckButtonWithPopupFrame	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetMaximumLineHeight (float)
virtual void	Update ()
virtual void	Close ()
virtual void	UpdateEnableState ()


virtual void	SetPopupTextProperty (int)
virtual int	GetPopupTextProperty ()
virtual void	PopupTextPropertyOn ()
virtual void	PopupTextPropertyOff ()
virtual void	SetRenderWidget (vtkKWRenderWidget *)
virtual vtkKWRenderWidget *	GetRenderWidget ()
virtual vtkCornerAnnotation *	GetCornerAnnotation ()
virtual void	SetVisibility (int i)
virtual int	GetVisibility ()
virtual void	VisibilityOn ()
virtual void	VisibilityOff ()
virtual void	SetCornerText (const char *txt, int corner)
virtual const char *	GetCornerText (int i)
virtual void	SetTextColor (double r, double g, double b)
virtual void	SetTextColor (double *rgb)
virtual double *	GetTextColor ()
virtual void	SetAnnotationChangedEvent (int)
virtual int	GetAnnotationChangedEvent ()
virtual vtkKWCheckButton *	GetCornerVisibilityButton ()
virtual vtkKWTextPropertyEditor *	GetTextPropertyWidget ()
virtual void	CheckButtonCallback (int state)
virtual void	CornerTextCallback (int i)
virtual void	MaximumLineHeightCallback (double value)
virtual void	MaximumLineHeightEndCallback (double value)
virtual void	TextPropertyCallback ()
Static Public Member Functions
static vtkKWCornerAnnotationEditor *	New ()
static int	IsTypeOf (const char *type)
static vtkKWCornerAnnotationEditor *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWCornerAnnotationEditor ()
	~vtkKWCornerAnnotationEditor ()
virtual void	CreateWidget ()
virtual void	Render ()
virtual int	GetCheckButtonState ()
virtual void	SendChangedEvent ()
Protected Attributes
int	AnnotationChangedEvent
vtkCornerAnnotation *	CornerAnnotation
vtkKWRenderWidget *	RenderWidget
int	PopupTextProperty
vtkKWFrame *	CornerFrame
vtkKWTextWithLabel *	CornerText [4]
vtkKWFrame *	PropertiesFrame
vtkKWScaleWithEntry *	MaximumLineHeightScale
vtkKWTextPropertyEditor *	TextPropertyWidget
vtkKWPopupButtonWithLabel *	TextPropertyPopupButton

Detailed Description

a corner annotation widget

A class that provides a UI for vtkCornerAnnotation. User can set the text for each corner, set the color of the text, and turn the annotation on and off.

Definition at line 37 of file vtkKWCornerAnnotationEditor.h.

Member Typedef Documentation

typedef vtkKWCheckButtonWithPopupFrame vtkKWCornerAnnotationEditor::Superclass

Reimplemented from vtkKWCheckButtonWithPopupFrame.

Definition at line 42 of file vtkKWCornerAnnotationEditor.h.

Constructor & Destructor Documentation

vtkKWCornerAnnotationEditor::vtkKWCornerAnnotationEditor ( ) [protected]

vtkKWCornerAnnotationEditor::~vtkKWCornerAnnotationEditor ( ) [protected]

Member Function Documentation

static vtkKWCornerAnnotationEditor* vtkKWCornerAnnotationEditor::New ( ) [static]

Reimplemented from vtkKWCheckButtonWithPopupFrame.

virtual const char* vtkKWCornerAnnotationEditor::GetClassName ( ) [virtual]

Reimplemented from vtkKWCheckButtonWithPopupFrame.

static int vtkKWCornerAnnotationEditor::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkKWCheckButtonWithPopupFrame.

virtual int vtkKWCornerAnnotationEditor::IsA ( const char * type ) [virtual]

Reimplemented from vtkKWCheckButtonWithPopupFrame.

static vtkKWCornerAnnotationEditor* vtkKWCornerAnnotationEditor::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkKWCheckButtonWithPopupFrame.

void vtkKWCornerAnnotationEditor::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Reimplemented from vtkKWCheckButtonWithPopupFrame.

virtual void vtkKWCornerAnnotationEditor::SetPopupTextProperty ( int ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual int vtkKWCornerAnnotationEditor::GetPopupTextProperty ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWCornerAnnotationEditor::PopupTextPropertyOn ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWCornerAnnotationEditor::PopupTextPropertyOff ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWCornerAnnotationEditor::SetRenderWidget ( vtkKWRenderWidget * ) [virtual]

Set/Get the vtkKWView or the vtkKWRenderWidget that owns this annotation. vtkKWView and vtkKWRenderWidget are two different frameworks, choose one or the other (ParaView uses vtkKWView, VolView uses vtkKWRenderWidget). Note that in vtkKWView mode, each view has a vtkKWCornerAnnotationEditor. In vtkKWRenderWidget, each widget has a vtkCornerAnnotation, which is controlled by a unique (decoupled) vtkKWCornerAnnotationEditor in the GUI. It is not ref-counted.

virtual vtkKWRenderWidget* vtkKWCornerAnnotationEditor::GetRenderWidget ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual vtkCornerAnnotation* vtkKWCornerAnnotationEditor::GetCornerAnnotation ( ) [virtual]

Get the underlying vtkCornerAnnotation. In vtkKWView mode, the CornerAnnotation is created automatically and handled by this class (i.e. each vtkKWCornerAnnotationEditor has a vtkCornerAnnotation). In vtkKWRenderWidget, the corner prop is part of vtkKWRenderWidget, and this method is just a gateway to vtkKWRenderWidget::GetCornerAnnotation().

virtual void vtkKWCornerAnnotationEditor::SetVisibility ( int i ) [virtual]

Set/Get the annotation visibility

virtual int vtkKWCornerAnnotationEditor::GetVisibility ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWCornerAnnotationEditor::VisibilityOn ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWCornerAnnotationEditor::VisibilityOff ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWCornerAnnotationEditor::SetCornerText	(	const char *	txt,
		int	corner
	)			`[virtual]`

Set/Get corner text

virtual const char* vtkKWCornerAnnotationEditor::GetCornerText ( int i ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWCornerAnnotationEditor::SetTextColor	(	double	r,
		double	g,
		double	b
	)			`[virtual]`

Change the color of the annotation

virtual void vtkKWCornerAnnotationEditor::SetTextColor ( double * rgb ) [inline, virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

Definition at line 92 of file vtkKWCornerAnnotationEditor.h.

virtual double* vtkKWCornerAnnotationEditor::GetTextColor ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWCornerAnnotationEditor::SetMaximumLineHeight ( float ) [virtual]

Set/Get the maximum line height.

virtual void vtkKWCornerAnnotationEditor::SetAnnotationChangedEvent ( int ) [virtual]

Set the event invoked when the anything in the annotation is changed. Defaults to vtkKWEvent::ViewAnnotationChangedEvent

virtual int vtkKWCornerAnnotationEditor::GetAnnotationChangedEvent ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual vtkKWCheckButton* vtkKWCornerAnnotationEditor::GetCornerVisibilityButton ( ) [inline, virtual]

Access to sub-widgets

Definition at line 109 of file vtkKWCornerAnnotationEditor.h.

virtual void vtkKWCornerAnnotationEditor::Update ( ) [virtual]

Update the GUI according to the value of the ivars

Reimplemented from vtkKWCheckButtonWithPopupFrame.

virtual void vtkKWCornerAnnotationEditor::Close ( ) [virtual]

When used with a vtkKWView, close out and remove any composites/props prior to deletion. Has no impact when used with a vtkKWRenderWidget.

virtual void vtkKWCornerAnnotationEditor::UpdateEnableState ( ) [virtual]

Update the "enable" state of the object and its internal parts. Depending on different Ivars (this->Enabled, the application's Limited Edition Mode, etc.), the "enable" state of the object is updated and propagated to its internal parts/subwidgets. This will, for example, enable/disable parts of the widget UI, enable/disable the visibility of 3D widgets, etc.

Reimplemented from vtkKWCheckButtonWithPopupFrame.

virtual vtkKWTextPropertyEditor* vtkKWCornerAnnotationEditor::GetTextPropertyWidget ( ) [virtual]

Access to the TextPropertyWidget from a script.

virtual void vtkKWCornerAnnotationEditor::CheckButtonCallback ( int state ) [virtual]

Callbacks. Internal, do not use.

Reimplemented from vtkKWCheckButtonWithPopupFrame.

virtual void vtkKWCornerAnnotationEditor::CornerTextCallback ( int i ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWCornerAnnotationEditor::MaximumLineHeightCallback ( double value ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWCornerAnnotationEditor::MaximumLineHeightEndCallback ( double value ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWCornerAnnotationEditor::TextPropertyCallback ( ) [virtual]

Makes the text property sub-widget popup (instead of displaying the whole text property UI, which can be long). This has to be called before Create(). Ignored if PopupMode is true.

virtual void vtkKWCornerAnnotationEditor::CreateWidget ( ) [protected, virtual]

Create the widget.

Reimplemented from vtkKWCheckButtonWithPopupFrame.

virtual void vtkKWCornerAnnotationEditor::Render ( ) [protected, virtual]

virtual int vtkKWCornerAnnotationEditor::GetCheckButtonState ( ) [inline, protected, virtual]

Reimplemented from vtkKWCheckButtonWithPopupFrame.

Definition at line 174 of file vtkKWCornerAnnotationEditor.h.

virtual void vtkKWCornerAnnotationEditor::SendChangedEvent ( ) [protected, virtual]