vtkKWVolumePropertyPresetSelector Class Reference

a volume property preset selector. More...

#include <vtkKWVolumePropertyPresetSelector.h>

Inheritance diagram for vtkKWVolumePropertyPresetSelector:

[legend]

Collaboration diagram for vtkKWVolumePropertyPresetSelector:

[legend]

List of all members.

Public Types
typedef vtkKWPresetSelector	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	IsPresetRangeInsideRange (int id, double range[2])
virtual void	AddDefaultNormalizedPresets (const char *type)
virtual int	IsPresetFiltered (int id)
Static Public Member Functions
static vtkKWVolumePropertyPresetSelector *	New ()
static int	IsTypeOf (const char *type)
static vtkKWVolumePropertyPresetSelector *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkKWVolumePropertyPresetSelector ()
	~vtkKWVolumePropertyPresetSelector ()
virtual void	CreateColumns ()
virtual int	UpdatePresetRow (int id)
virtual int	GetTypeColumnIndex ()
virtual void	UpdateToolbarPresetButtons (vtkKWToolbar *)
virtual void	PopulatePresetContextMenu (vtkKWMenu *menu, int id)
Protected Attributes
vtkKWVolumePropertyPresetSelectorInternals *	Internals

static const char *	TypeColumnName
virtual int	SetPresetVolumeProperty (int id, vtkVolumeProperty *prop)
virtual vtkVolumeProperty *	GetPresetVolumeProperty (int id)
virtual int	SetPresetType (int id, const char *type)
virtual const char *	GetPresetType (int id)
virtual int	GetPresetIndependentComponents (int id)
virtual int	SetPresetIndependentComponents (int id, int flag)
virtual int	GetPresetBlendMode (int id)
virtual int	SetPresetBlendMode (int id, int flag)
virtual int	HasPresetBlendMode (int id)
virtual int	GetPresetHistogramFlag (int id)
virtual int	SetPresetHistogramFlag (int id, int flag)
virtual void	SetTypeColumnVisibility (int)
virtual int	GetTypeColumnVisibility ()
virtual void	TypeColumnVisibilityOn ()
virtual void	TypeColumnVisibilityOff ()
virtual void	SetPresetFilterRangeConstraint (double range[2])
virtual double *	GetPresetFilterRangeConstraint ()
virtual void	DeletePresetFilterRangeConstraint ()
virtual void	SetPresetTypeSlotName (const char *)
virtual const char *	GetPresetTypeSlotName ()
virtual void	SetPresetIndependentComponentsSlotName (const char *)
virtual const char *	GetPresetIndependentComponentsSlotName ()
virtual void	SetPresetHistogramFlagSlotName (const char *)
virtual const char *	GetPresetHistogramFlagSlotName ()
virtual void	SetPresetBlendModeSlotName (const char *)
virtual const char *	GetPresetBlendModeSlotName ()

Detailed Description

a volume property preset selector.

This class is a widget that can be used to store and apply volume property presets.

Thanks:: This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149. Information on the National Centers for Biomedical Computing can be obtained from http://nihroadmap.nih.gov/bioinformatics.

Definition at line 35 of file vtkKWVolumePropertyPresetSelector.h.

Member Typedef Documentation

typedef vtkKWPresetSelector vtkKWVolumePropertyPresetSelector::Superclass

Reimplemented from vtkKWPresetSelector.

Definition at line 40 of file vtkKWVolumePropertyPresetSelector.h.

Constructor & Destructor Documentation

vtkKWVolumePropertyPresetSelector::vtkKWVolumePropertyPresetSelector ( ) [protected]

vtkKWVolumePropertyPresetSelector::~vtkKWVolumePropertyPresetSelector ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkKWPresetSelector.

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

Reimplemented from vtkKWPresetSelector.

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

Reimplemented from vtkKWPresetSelector.

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

Reimplemented from vtkKWPresetSelector.

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

Reimplemented from vtkKWPresetSelector.

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

Reimplemented from vtkKWPresetSelector.

virtual int vtkKWVolumePropertyPresetSelector::SetPresetVolumeProperty	(	int	id,
		vtkVolumeProperty *	prop
	)			`[virtual]`

Set/Get the volume property associated to the preset in the pool. Note that the volume property object passed as parameter is neither stored nor Register()'ed, only a copy is stored (and updated each time this method is called later on). Return 1 on success, 0 on error

virtual vtkVolumeProperty* vtkKWVolumePropertyPresetSelector::GetPresetVolumeProperty ( int id ) [virtual]

Some constants BTX

virtual int vtkKWVolumePropertyPresetSelector::SetPresetType	(	int	id,
		const char *	type
	)			`[virtual]`

Set/Get the type for a given preset. The type column can be used, for example, to put the medical modality a specific presets applies to (say, CT, MR) The type field is not displayed as a column by default, but this can be changed using the SetTypeColumnVisibility() method. This column can not be edited. Return 1 on success, 0 otherwise

virtual const char* vtkKWVolumePropertyPresetSelector::GetPresetType ( int id ) [virtual]

Some constants BTX

virtual int vtkKWVolumePropertyPresetSelector::GetPresetIndependentComponents ( int id ) [virtual]

Set/Get if the volume property is designed with independent components in mind. IMPORTANT: this slot is a convenience slot that reflect the value of the vtkVolumeProperty's own IndependentComponents ivar. Each time the volume property preset is set (see SetPresetVolumeProperty), this slot is updated automatically, and vice-versa. It is provided for filtering purposes (i.e. so that you can use this slot in a preset filter constraint, and only show the presets that are relevant to your data, if it has independent components or not). Return 1 on success, 0 otherwise

virtual int vtkKWVolumePropertyPresetSelector::SetPresetIndependentComponents	(	int	id,
		int	flag
	)			`[virtual]`

Some constants BTX

virtual int vtkKWVolumePropertyPresetSelector::GetPresetBlendMode ( int id ) [virtual]

Set/Get if the volume property is designed with a specific blend mode in mind. Valid constants are the ones found in vtkVolumeMapper, i.e. vtkVolumeMapper::COMPOSITE_BLEND, vtkVolumeMapper::MAXIMUM_INTENSITY_BLEND, vtkVolumeMapper::MINIMUM_INTENSITY_BLEND. Return 1 on success, 0 otherwise

virtual int vtkKWVolumePropertyPresetSelector::SetPresetBlendMode	(	int	id,
		int	flag
	)			`[virtual]`

Some constants BTX

virtual int vtkKWVolumePropertyPresetSelector::HasPresetBlendMode ( int id ) [virtual]

Some constants BTX

virtual int vtkKWVolumePropertyPresetSelector::GetPresetHistogramFlag ( int id ) [virtual]

Set/Get if the normalized scalar values in the volume property are to be interpreted relative to an histogram of the scalars. Return 1 on success, 0 otherwise

virtual int vtkKWVolumePropertyPresetSelector::SetPresetHistogramFlag	(	int	id,
		int	flag
	)			`[virtual]`

Some constants BTX

virtual int vtkKWVolumePropertyPresetSelector::IsPresetRangeInsideRange	(	int	id,
		double	range[2]
	)			`[virtual]`

Query if the preset range falls inside a given range (the preset range is computed by checking the largest scalar range among the volume property transfer functions for component 0). Return 1 on success (or HistogramFlag is On), 0 on error

virtual void vtkKWVolumePropertyPresetSelector::SetTypeColumnVisibility ( int ) [virtual]

Set/Get the visibility of the type column. Hidden by default. No effect if called before Create().

virtual int vtkKWVolumePropertyPresetSelector::GetTypeColumnVisibility ( ) [virtual]

Some constants BTX

virtual void vtkKWVolumePropertyPresetSelector::TypeColumnVisibilityOn ( ) [virtual]

Some constants BTX

virtual void vtkKWVolumePropertyPresetSelector::TypeColumnVisibilityOff ( ) [virtual]

Some constants BTX

virtual void vtkKWVolumePropertyPresetSelector::AddDefaultNormalizedPresets ( const char * type ) [virtual]

Add default normalized presets. The type parameter will be used to call SetPresetType on each new preset.

virtual void vtkKWVolumePropertyPresetSelector::SetPresetFilterRangeConstraint ( double range[2] ) [virtual]

Add a preset filter constraint on the preset group field.

virtual double* vtkKWVolumePropertyPresetSelector::GetPresetFilterRangeConstraint ( ) [virtual]

Some constants BTX

virtual void vtkKWVolumePropertyPresetSelector::DeletePresetFilterRangeConstraint ( ) [virtual]

Some constants BTX

virtual int vtkKWVolumePropertyPresetSelector::IsPresetFiltered ( int id ) [virtual]

Query if a given preset matches the current preset filter constraints. Return 1 if match or if no filter was defined, 0 otherwise Override (augment) the superclass to handle range constraint (see SetPresetFilterRangeConstraint).

Reimplemented from vtkKWPresetSelector.

virtual void vtkKWVolumePropertyPresetSelector::SetPresetTypeSlotName ( const char * ) [virtual]

Most (if not all) of the information associated to a preset (say group, comment, filename, creation time, thumbnail and screenshot) is stored under the hood as user slots using the corresponding API (i.e. Set/GetPresetUserSlotAs...()). Since each slot requires a unique name, the following methods are provided to retrieve the slot name for the preset fields. This can be useful to avoid collision between the default slots and your own user slots. Note that the default slot names can be changed too, but doing so will not transfer the value stored at the old slot name to the new slot name (it is up to you to do so, if needed).

virtual const char* vtkKWVolumePropertyPresetSelector::GetPresetTypeSlotName ( ) [virtual]

Some constants BTX

virtual void vtkKWVolumePropertyPresetSelector::SetPresetIndependentComponentsSlotName ( const char * ) [virtual]

Some constants BTX

virtual const char* vtkKWVolumePropertyPresetSelector::GetPresetIndependentComponentsSlotName ( ) [virtual]

Some constants BTX

virtual void vtkKWVolumePropertyPresetSelector::SetPresetHistogramFlagSlotName ( const char * ) [virtual]

Some constants BTX

virtual const char* vtkKWVolumePropertyPresetSelector::GetPresetHistogramFlagSlotName ( ) [virtual]

Some constants BTX

virtual void vtkKWVolumePropertyPresetSelector::SetPresetBlendModeSlotName ( const char * ) [virtual]

Some constants BTX

virtual const char* vtkKWVolumePropertyPresetSelector::GetPresetBlendModeSlotName ( ) [virtual]

Some constants BTX

virtual void vtkKWVolumePropertyPresetSelector::CreateColumns ( ) [protected, virtual]

Create the columns. Subclasses should override this method to add their own columns and display their own preset fields (do not forget to call the superclass first).

Reimplemented from vtkKWPresetSelector.

virtual int vtkKWVolumePropertyPresetSelector::UpdatePresetRow ( int id ) [protected, virtual]

Update the preset row, i.e. add a row for that preset if it is not displayed already, hide it if it does not match GroupFilter, and update the table columns with the corresponding preset fields. Subclass should override this method to display their own fields. Return 1 on success, 0 if the row was not (or can not be) updated. Subclasses should call the parent's UpdatePresetRow, and abort if the result is not 1.

Reimplemented from vtkKWPresetSelector.

virtual int vtkKWVolumePropertyPresetSelector::GetTypeColumnIndex ( ) [protected, virtual]

Get the index of a given column.

virtual void vtkKWVolumePropertyPresetSelector::UpdateToolbarPresetButtons ( vtkKWToolbar * ) [protected, virtual]

Update the toolbar preset buttons state/visibility.

Reimplemented from vtkKWPresetSelector.

virtual void vtkKWVolumePropertyPresetSelector::PopulatePresetContextMenu	(	vtkKWMenu *	menu,
		int	id
	)			`[protected, virtual]`

Populate the pop-up context menu that is displayed when right-clicking on a give preset. It should replicate the commands available through the preset buttons.

Reimplemented from vtkKWPresetSelector.