vtkSlicerColorDisplayWidget Class Reference

#include <vtkSlicerColorDisplayWidget.h>

Inheritance diagram for vtkSlicerColorDisplayWidget:

Public Types
enum	{ ColorIDModifiedEvent = 30000, SelectedColorModifiedEvent = 30001 }
Public Member Functions
virtual void	AddMRMLObservers ()
int	GetSelectedColorIndex ()
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	ProcessMRMLEvents (vtkObject caller, unsigned long event, void callData)
virtual void	ProcessWidgetEvents (vtkObject caller, unsigned long event, void callData)
virtual void	RemoveMRMLObservers ()
virtual void	RemoveWidgetObservers ()
void	SetColorNode (vtkMRMLColorNode *node)
void	SetColorNodeID (char *id)
void	SetSelectedColorIndex (int index)
virtual void	SetViewerWidget (vtkSlicerViewerWidget *viewerWidget)
void	UpdateElement (int row, int col, char *str)
virtual void	UpdateEnableState (void)
	vtkBooleanMacro (MultiSelectMode, int)
	vtkGetObjectMacro (ScalarBarWidget, vtkScalarBarWidget)
	vtkGetObjectMacro (ViewerWidget, vtkSlicerViewerWidget)
	vtkGetObjectMacro (ColorNode, vtkMRMLColorNode)
	vtkGetObjectMacro (ScalarBarAnnotation, vtkKWScalarBarAnnotation)
	vtkGetObjectMacro (ColorSelectorWidget, vtkSlicerNodeSelectorWidget)
	vtkGetObjectMacro (NodeHelpWidget, vtkSlicerPopUpHelpWidget)
	vtkGetObjectMacro (MultiColumnList, vtkKWMultiColumnListWithScrollbars)
	vtkGetObjectMacro (NumberOfColorsLabel, vtkKWLabel)
	vtkGetObjectMacro (ColorNodeTypeLabel, vtkKWLabel)
	vtkGetStringMacro (ColorNodeID)
	vtkSetMacro (MultiSelectMode, int)
	vtkTypeRevisionMacro (vtkSlicerColorDisplayWidget, vtkSlicerWidget)
Static Public Member Functions
static vtkSlicerColorDisplayWidget *	New ()
Protected Types
enum	{ EntryColumn = 0, NameColumn = 1, ColourColumn = 2 }
	vtkKWChangeColorButton *ChangeColorButton; More...
Protected Member Functions
virtual void	CreateWidget ()
void	UpdateMRML ()
void	UpdateSelectedColor ()
void	UpdateWidget ()
	vtkSlicerColorDisplayWidget ()
virtual	~vtkSlicerColorDisplayWidget ()
Protected Attributes
vtkMRMLColorNode *	ColorNode
char *	ColorNodeID
vtkKWLabel *	ColorNodeTypeLabel
vtkSlicerNodeSelectorWidget *	ColorSelectorWidget
vtkKWEntryWithLabel *	MaxRangeEntry
vtkKWEntryWithLabel *	MinRangeEntry
vtkKWMultiColumnListWithScrollbars *	MultiColumnList
int	MultiSelectMode
vtkSlicerPopUpHelpWidget *	NodeHelpWidget
vtkKWLabel *	NumberOfColorsLabel
int	NumberOfColumns
vtkKWScalarBarAnnotation *	ScalarBarAnnotation
vtkScalarBarWidget *	ScalarBarWidget
vtkKWLabel *	SelectedColorLabel
vtkKWCheckButton *	ShowOnlyNamedColorsCheckButton
vtkSlicerViewerWidget *	ViewerWidget
Private Member Functions
void	operator= (const vtkSlicerColorDisplayWidget &)
	Not implemented.
	vtkSlicerColorDisplayWidget (const vtkSlicerColorDisplayWidget &)

Member Enumeration Documentation

anonymous enum

ColorIDModifiedEvent is generated when the ColorNodeID is changed

Enumerator:

ColorIDModifiedEvent
SelectedColorModifiedEvent

anonymous enum [protected]

vtkKWChangeColorButton *ChangeColorButton;

The column orders in the list box

Enumerator:

EntryColumn
NameColumn
ColourColumn

Constructor & Destructor Documentation

vtkSlicerColorDisplayWidget::vtkSlicerColorDisplayWidget ( ) [protected]

References ColorNode, ColorNodeID, ColorNodeTypeLabel, ColorSelectorWidget, MaxRangeEntry, MinRangeEntry, MultiColumnList, NodeHelpWidget, NumberOfColorsLabel, NumberOfColumns, ScalarBarAnnotation, ScalarBarWidget, SelectedColorLabel, ShowOnlyNamedColorsCheckButton, and ViewerWidget.

vtkSlicerColorDisplayWidget::~vtkSlicerColorDisplayWidget ( ) [protected, virtual]

References ColorNode, ColorNodeTypeLabel, ColorSelectorWidget, MaxRangeEntry, MinRangeEntry, MultiColumnList, NodeHelpWidget, NumberOfColorsLabel, RemoveMRMLObservers(), RemoveWidgetObservers(), ScalarBarAnnotation, ScalarBarWidget, SelectedColorLabel, SetColorNodeID(), vtkSlicerWidget::SetMRMLScene(), SetViewerWidget(), ShowOnlyNamedColorsCheckButton, and vtkSetMRMLNodeMacro.

vtkSlicerColorDisplayWidget::vtkSlicerColorDisplayWidget ( const vtkSlicerColorDisplayWidget & ) [private]

Member Function Documentation

void vtkSlicerColorDisplayWidget::AddMRMLObservers ( ) [virtual]

add observers on color node

Referenced by SetColorNode().

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

int vtkSlicerColorDisplayWidget::GetSelectedColorIndex ( )

Return the index of the currently selected colour in the multi column list box, for use by other classes when they wish to call GetColor on the vtkMRMLColorNode. Returns -1 if no list box or no selection, or if more than one row is selected.

References EntryColumn, MultiColumnList, and MultiSelectMode.

Referenced by UpdateSelectedColor().

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

Reimplemented from vtkSlicerWidget.

Referenced by CreateWidget(), and SetColorNodeID().

void vtkSlicerColorDisplayWidget::operator= ( const vtkSlicerColorDisplayWidget & ) [private]

Not implemented.

Reimplemented from vtkSlicerWidget.

void vtkSlicerColorDisplayWidget::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

Reimplemented from vtkSlicerWidget.

virtual void vtkSlicerColorDisplayWidget::ProcessMRMLEvents	(	vtkObject *	caller,
		unsigned long	event,
		void *	callData
	)			`[virtual]`

alternative method to propagate events generated in GUI to logic / mrml

virtual void vtkSlicerColorDisplayWidget::ProcessWidgetEvents	(	vtkObject *	caller,
		unsigned long	event,
		void *	callData
	)			`[virtual]`

alternative method to propagate events generated in GUI to logic / mrml

void vtkSlicerColorDisplayWidget::RemoveMRMLObservers ( ) [virtual]

remove observers on color node

Referenced by SetColorNode(), and ~vtkSlicerColorDisplayWidget().

void vtkSlicerColorDisplayWidget::RemoveWidgetObservers ( ) [virtual]

removes observers on widgets in the class

References ColorIDModifiedEvent, ColorSelectorWidget, vtkSlicerWidget::GUICallbackCommand, MaxRangeEntry, MinRangeEntry, MultiColumnList, vtkSlicerNodeSelectorWidget::NodeSelectedEvent, and ShowOnlyNamedColorsCheckButton.

Referenced by ~vtkSlicerColorDisplayWidget().

void vtkSlicerColorDisplayWidget::SetColorNode ( vtkMRMLColorNode * node )

Set the selected node, the color id, and update the widgets

References AddMRMLObservers(), ColorSelectorWidget, vtkSlicerNodeSelectorWidget::GetSelected(), RemoveMRMLObservers(), SetColorNodeID(), and vtkSlicerNodeSelectorWidget::SetSelected().

void vtkSlicerColorDisplayWidget::SetColorNodeID ( char * id )

References ColorIDModifiedEvent, ColorNode, ColorNodeID, vtkMRMLScene::GetNodeByID(), vtkSlicerWidget::MRMLScene, New(), vtkMRMLColorNode::TypeModifiedEvent, UpdateWidget(), and vtkSetAndObserveMRMLNodeEventsMacro.

Referenced by vtkSlicerColorGUI::BuildGUI(), vtkSlicerColorGUI::Enter(), SetColorNode(), and ~vtkSlicerColorDisplayWidget().

void vtkSlicerColorDisplayWidget::SetSelectedColorIndex ( int index )

References MultiColumnList, and UpdateSelectedColor().

void vtkSlicerColorDisplayWidget::SetViewerWidget ( vtkSlicerViewerWidget * viewerWidget ) [virtual]

References ViewerWidget.

Referenced by vtkSlicerColorGUI::SetActiveViewer(), and ~vtkSlicerColorDisplayWidget().

void vtkSlicerColorDisplayWidget::UpdateElement	(	int	row,
		int	col,
		char *	str
	)

update a table entry

References ColourColumn, EntryColumn, vtkMRMLColorNode::GetColorName(), vtkMRMLScene::GetNodeByID(), vtkSlicerWidget::MRMLScene, MultiColumnList, slicerget::name, NameColumn, NumberOfColumns, and vtkMRMLColorNode::SetColorName().

void vtkSlicerColorDisplayWidget::UpdateEnableState ( void ) [virtual]

Update the "enable" state of the object and its internal parts

References ColorNodeTypeLabel, ColorSelectorWidget, MaxRangeEntry, MinRangeEntry, MultiColumnList, NumberOfColorsLabel, ScalarBarAnnotation, SelectedColorLabel, and ShowOnlyNamedColorsCheckButton.

void vtkSlicerColorDisplayWidget::UpdateMRML ( ) [protected]

References vtkMRMLColorNode::GetLookupTable(), vtkMRMLScene::GetNodeByID(), max, MaxRangeEntry, min, MinRangeEntry, vtkSlicerWidget::MRMLScene, vtkSlicerViewerWidget::RequestRender(), and ViewerWidget.

void vtkSlicerColorDisplayWidget::UpdateSelectedColor ( ) [protected]

Called when the selected row changes, just update the label, called from UpdateWidget

References GetSelectedColorIndex(), and SelectedColorLabel.

Referenced by SetSelectedColorIndex(), and UpdateWidget().

void vtkSlicerColorDisplayWidget::UpdateWidget ( ) [protected]

Update the widget, used when the color node id changes

References ColorNodeID, ColorNodeTypeLabel, ColourColumn, EntryColumn, vtkMRMLColorNode::GetColorName(), vtkMRMLColorNode::GetLookupTable(), vtkMRMLScene::GetNodeByID(), vtkMRMLColorNode::GetTypeAsString(), MaxRangeEntry, MinRangeEntry, vtkSlicerWidget::MRMLScene, MultiColumnList, slicerget::name, NameColumn, NumberOfColorsLabel, ScalarBarWidget, ShowOnlyNamedColorsCheckButton, and UpdateSelectedColor().

Referenced by SetColorNodeID().

vtkSlicerColorDisplayWidget::vtkBooleanMacro	(	MultiSelectMode	,
		int
	)

vtkSlicerColorDisplayWidget::vtkGetObjectMacro	(	ScalarBarWidget	,
		vtkScalarBarWidget
	)

Get the scalar bar widget

vtkSlicerColorDisplayWidget::vtkGetObjectMacro	(	ViewerWidget	,
		vtkSlicerViewerWidget
	)

API for setting ColorNode, and observing it Once know that the GUI has to be cleared and updated to show elements from a new list, use this call virtual void SetGUIFromNode(vtkMRMLColorNode * activeColorNode); Get/set the viewer widget so can add a the scalar bar widget to it