vtkKWCornerAnnotationEditor Class Reference

a corner annotation widget More...

#include <vtkKWCornerAnnotationEditor.h>

Inheritance diagram for vtkKWCornerAnnotationEditor:

[legend]Collaboration diagram for vtkKWCornerAnnotationEditor:


Public Member Functions
	vtkTypeRevisionMacro (vtkKWCornerAnnotationEditor, vtkKWCheckButtonWithPopupFrame)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
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 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 void	CheckButtonCallback ()
virtual void	CornerTextCallback (int i)
virtual void	MaximumLineHeightCallback ()
virtual void	MaximumLineHeightEndCallback ()
virtual void	TextPropertyCallback ()

virtual vtkKWCheckButton *	GetCornerVisibilityButton ()

virtual vtkKWTextPropertyEditor *	GetTextPropertyWidget ()
Static Public Member Functions
vtkKWCornerAnnotationEditor *	New ()
Protected Member Functions
	vtkKWCornerAnnotationEditor ()
	~vtkKWCornerAnnotationEditor ()
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.

Constructor & Destructor Documentation

vtkKWCornerAnnotationEditor::vtkKWCornerAnnotationEditor ( ) [protected]

vtkKWCornerAnnotationEditor::~vtkKWCornerAnnotationEditor ( ) [protected]

Member Function Documentation

vtkKWCornerAnnotationEditor* vtkKWCornerAnnotationEditor::New ( ) [static]

Reimplemented from vtkKWCheckButtonWithPopupFrame.
Reimplemented in vtkPVCornerAnnotationEditor.

vtkKWCornerAnnotationEditor::vtkTypeRevisionMacro ( vtkKWCornerAnnotationEditor ,

vtkKWCheckButtonWithPopupFrame

)

void vtkKWCornerAnnotationEditor::PrintSelf ( ostream & os,

vtkIndent indent

)

Reimplemented from vtkKWCheckButtonWithPopupFrame.
Reimplemented in vtkPVCornerAnnotationEditor.

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::Create ( vtkKWApplication * app ) [virtual]

Create the widget.
Reimplemented from vtkKWCheckButtonWithPopupFrame.

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.

virtual vtkKWRenderWidget* vtkKWCornerAnnotationEditor::GetRenderWidget ( ) [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.

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
Reimplemented in vtkPVCornerAnnotationEditor.

virtual int vtkKWCornerAnnotationEditor::GetVisibility ( ) [virtual]

Set/Get the annotation visibility
Reimplemented in vtkPVCornerAnnotationEditor.

virtual void vtkKWCornerAnnotationEditor::VisibilityOn ( ) [virtual]

Set/Get the annotation visibility
Reimplemented in vtkPVCornerAnnotationEditor.

virtual void vtkKWCornerAnnotationEditor::VisibilityOff ( ) [virtual]

Set/Get the annotation visibility
Reimplemented in vtkPVCornerAnnotationEditor.

virtual void vtkKWCornerAnnotationEditor::SetCornerText ( const char * txt,

int corner

) [virtual]

Set/Get corner text
Reimplemented in vtkPVCornerAnnotationEditor.

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

Set/Get corner text

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]

Change the color of the annotation
Definition at line 94 of file vtkKWCornerAnnotationEditor.h.

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

Change the color of the annotation

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

Set/Get the maximum line height.
Reimplemented in vtkPVCornerAnnotationEditor.

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]

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

virtual void vtkKWCornerAnnotationEditor::CheckButtonCallback ( ) [virtual]

Callbacks
Reimplemented from vtkKWCheckButtonWithPopupFrame.

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

Callbacks
Reimplemented in vtkPVCornerAnnotationEditor.

virtual void vtkKWCornerAnnotationEditor::MaximumLineHeightCallback ( ) [virtual]

Callbacks

virtual void vtkKWCornerAnnotationEditor::MaximumLineHeightEndCallback ( ) [virtual]

Callbacks

virtual void vtkKWCornerAnnotationEditor::TextPropertyCallback ( ) [virtual]

Callbacks

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

Access to sub-widgets
Definition at line 120 of file vtkKWCornerAnnotationEditor.h.
References vtkKWCheckButtonWithPopupFrame::GetCheckButton().

virtual void vtkKWCornerAnnotationEditor::Update ( ) [virtual]

Update the GUI according to the value of the ivars
Reimplemented from vtkKWCheckButtonWithPopupFrame.
Reimplemented in vtkPVCornerAnnotationEditor.

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::Render ( ) [protected, virtual]

Reimplemented in vtkPVCornerAnnotationEditor.

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

Reimplemented from vtkKWCheckButtonWithPopupFrame.
Definition at line 171 of file vtkKWCornerAnnotationEditor.h.