vtkKWScalarBarAnnotation Class Reference

a scalar bar annotation widget More...

#include <vtkKWScalarBarAnnotation.h>

Inheritance diagram for vtkKWScalarBarAnnotation:

[legend]

Collaboration diagram for vtkKWScalarBarAnnotation:

[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)
void	Update ()
virtual void	UpdateEnableState ()


virtual void	SetPopupTextProperty (int)
virtual int	GetPopupTextProperty ()
virtual void	PopupTextPropertyOn ()
virtual void	PopupTextPropertyOff ()
virtual void	SetScalarBarWidget (vtkScalarBarWidget *)
virtual vtkScalarBarWidget *	GetScalarBarWidget ()
virtual void	SetVisibility (int i)
virtual int	GetVisibility ()
virtual void	VisibilityOn ()
virtual void	VisibilityOff ()
virtual void	SetAnnotationChangedEvent (int)
virtual int	GetAnnotationChangedEvent ()
virtual void	SetVolumeProperty (vtkVolumeProperty *prop)
virtual vtkVolumeProperty *	GetVolumeProperty ()
virtual void	SetNumberOfComponents (int)
virtual int	GetNumberOfComponents ()
virtual void	SetScalarComponentChangedEvent (int)
virtual int	GetScalarComponentChangedEvent ()
virtual void	SetLabelFormatVisibility (int i)
virtual int	GetLabelFormatVisibility ()
virtual void	LabelFormatVisibilityOn ()
virtual void	LabelFormatVisibilityOff ()
virtual vtkKWCheckButton *	GetScalarBarVisibilityButton ()
virtual void	CheckButtonCallback (int state)
virtual void	SelectedComponentCallback (int)
virtual void	ScalarBarTitleCallback (const char *value)
virtual void	ScalarBarLabelFormatCallback (const char *value)
virtual void	TitleTextPropertyCallback ()
virtual void	LabelTextPropertyCallback ()
virtual void	MaximumNumberOfColorsEndCallback (double value)
virtual void	NumberOfLabelsEndCallback (double value)
Static Public Member Functions
static vtkKWScalarBarAnnotation *	New ()
static int	IsTypeOf (const char *type)
static vtkKWScalarBarAnnotation *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWScalarBarAnnotation ()
	~vtkKWScalarBarAnnotation ()
virtual void	CreateWidget ()
virtual void	PackLabelFrameChildren ()
virtual void	Render ()
virtual void	SetScalarBarTitle (const char *txt)
virtual void	SetScalarBarLabelFormat (const char *txt)
virtual int	GetCheckButtonState ()
virtual void	SendChangedEvent ()
Protected Attributes
int	PopupTextProperty
int	AnnotationChangedEvent
int	ScalarComponentChangedEvent
int	NumberOfComponents
int	LabelFormatVisibility
vtkScalarBarWidget *	ScalarBarWidget
vtkVolumeProperty *	VolumeProperty
vtkKWScalarComponentSelectionWidget *	ComponentSelectionWidget
vtkKWFrame *	TitleFrame
vtkKWEntryWithLabel *	TitleEntry
vtkKWTextPropertyEditor *	TitleTextPropertyWidget
vtkKWPopupButtonWithLabel *	TitleTextPropertyPopupButton
vtkKWFrame *	LabelFrame
vtkKWEntryWithLabel *	LabelFormatEntry
vtkKWTextPropertyEditor *	LabelTextPropertyWidget
vtkKWPopupButtonWithLabel *	LabelTextPropertyPopupButton
vtkKWThumbWheel *	MaximumNumberOfColorsThumbWheel
vtkKWScaleWithEntry *	NumberOfLabelsScale

Detailed Description

a scalar bar annotation widget

A class that provides a UI for a scalar bar widget (vtkScalarBarWidget).

Definition at line 35 of file vtkKWScalarBarAnnotation.h.

Member Typedef Documentation

typedef vtkKWCheckButtonWithPopupFrame vtkKWScalarBarAnnotation::Superclass

Reimplemented from vtkKWCheckButtonWithPopupFrame.

Definition at line 40 of file vtkKWScalarBarAnnotation.h.

Constructor & Destructor Documentation

vtkKWScalarBarAnnotation::vtkKWScalarBarAnnotation ( ) [protected]

vtkKWScalarBarAnnotation::~vtkKWScalarBarAnnotation ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkKWCheckButtonWithPopupFrame.

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

Reimplemented from vtkKWCheckButtonWithPopupFrame.

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

Reimplemented from vtkKWCheckButtonWithPopupFrame.

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

Reimplemented from vtkKWCheckButtonWithPopupFrame.

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

Reimplemented from vtkKWCheckButtonWithPopupFrame.

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

Reimplemented from vtkKWCheckButtonWithPopupFrame.

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

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::GetPopupTextProperty ( ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::PopupTextPropertyOn ( ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::PopupTextPropertyOff ( ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::SetScalarBarWidget ( vtkScalarBarWidget * ) [virtual]

Set/Get the vtkScalarBarWidget that owns the scalar bar actor.

virtual vtkScalarBarWidget* vtkKWScalarBarAnnotation::GetScalarBarWidget ( ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::SetVisibility ( int i ) [virtual]

Set/Get the scalar bar visibility

virtual int vtkKWScalarBarAnnotation::GetVisibility ( ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::VisibilityOn ( ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::VisibilityOff ( ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::SetAnnotationChangedEvent ( int ) [virtual]

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

virtual int vtkKWScalarBarAnnotation::GetAnnotationChangedEvent ( ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::SetVolumeProperty ( vtkVolumeProperty * prop ) [virtual]

Set/Get the volume property that can be used to set the LUT of the scalar bar actor (i.e. allow the user to choose which component to visualize)

virtual vtkVolumeProperty* vtkKWScalarBarAnnotation::GetVolumeProperty ( ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::SetNumberOfComponents ( int ) [virtual]

Set/Get the number of components corresponding to the data represented by the volume property

virtual int vtkKWScalarBarAnnotation::GetNumberOfComponents ( ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::SetScalarComponentChangedEvent ( int ) [virtual]

Set/Get the event invoked when the component is changed. Defaults to vtkKWEvent::ScalarComponentChangedEvent

virtual int vtkKWScalarBarAnnotation::GetScalarComponentChangedEvent ( ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::SetLabelFormatVisibility ( int i ) [virtual]

Set/Get the LabelFormat UI visibility, which might be a bit confusing

virtual int vtkKWScalarBarAnnotation::GetLabelFormatVisibility ( ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::LabelFormatVisibilityOn ( ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::LabelFormatVisibilityOff ( ) [virtual]

Makes the text property sub-widgets 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* vtkKWScalarBarAnnotation::GetScalarBarVisibilityButton ( ) [inline, virtual]

Access to sub-widgets

Definition at line 103 of file vtkKWScalarBarAnnotation.h.

void vtkKWScalarBarAnnotation::Update ( ) [virtual]

Update the GUI according to the value of the ivars

Reimplemented from vtkKWCheckButtonWithPopupFrame.

virtual void vtkKWScalarBarAnnotation::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 void vtkKWScalarBarAnnotation::CheckButtonCallback ( int state ) [virtual]

Callbacks. Internal, do not use.

Reimplemented from vtkKWCheckButtonWithPopupFrame.

virtual void vtkKWScalarBarAnnotation::SelectedComponentCallback ( int ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::ScalarBarTitleCallback ( const char * value ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::ScalarBarLabelFormatCallback ( const char * value ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::TitleTextPropertyCallback ( ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::LabelTextPropertyCallback ( ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::MaximumNumberOfColorsEndCallback ( double value ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::NumberOfLabelsEndCallback ( double value ) [virtual]

Makes the text property sub-widgets 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 vtkKWScalarBarAnnotation::CreateWidget ( ) [protected, virtual]

Create the widget.

Reimplemented from vtkKWCheckButtonWithPopupFrame.

virtual void vtkKWScalarBarAnnotation::PackLabelFrameChildren ( ) [protected, virtual]

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

virtual void vtkKWScalarBarAnnotation::SetScalarBarTitle ( const char * txt ) [protected, virtual]