vtkTransferFunctionEditorWidget Class Reference

a 3D widget for manipulating a transfer function More...

#include <vtkTransferFunctionEditorWidget.h>

Inheritance diagram for vtkTransferFunctionEditorWidget:

Collaboration diagram for vtkTransferFunctionEditorWidget:

List of all members.

Public Types
enum	ModificationTypes { COLOR = 0, OPACITY, COLOR_AND_OPACITY }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	ShowWholeScalarRange ()
virtual void	Configure (int size[2])
virtual void	SetColorSpace (int)
virtual void	OnChar ()
virtual void	UpdateFromTransferFunctions ()
virtual void	CreateDefaultRepresentation ()
virtual void	SetBorderWidth (int width)
virtual void	SetVisibleScalarRange (double range[2])
virtual void	SetVisibleScalarRange (double min, double max)
virtual double *	GetVisibleScalarRange ()
virtual void	GetVisibleScalarRange (double &, double &)
virtual void	GetVisibleScalarRange (double[2])
void	SetWholeScalarRange (double min, double max)
void	SetWholeScalarRange (double range[2])
virtual double *	GetWholeScalarRange ()
virtual void	GetWholeScalarRange (double &, double &)
virtual void	GetWholeScalarRange (double[2])
virtual void	SetModificationType (int)
virtual vtkPiecewiseFunction *	GetOpacityFunction ()
void	SetOpacityFunction (vtkPiecewiseFunction *function)
virtual vtkColorTransferFunction *	GetColorFunction ()
void	SetColorFunction (vtkColorTransferFunction *function)
virtual void	SetAllowInteriorElements (int)
virtual int	GetAllowInteriorElements ()
virtual void	AllowInteriorElementsOn ()
virtual void	AllowInteriorElementsOff ()
virtual void	SetElementOpacity (unsigned int, double)
virtual double	GetElementOpacity (unsigned int)
virtual void	SetElementRGBColor (unsigned int, double, double, double)
virtual int	GetElementRGBColor (unsigned int, double[3])
virtual void	SetElementHSVColor (unsigned int, double, double, double)
virtual int	GetElementHSVColor (unsigned int, double[3])
virtual void	SetElementScalar (unsigned int, double)
virtual double	GetElementScalar (unsigned int)
virtual void	SetHistogram (vtkRectilinearGrid *histogram)
virtual vtkRectilinearGrid *	GetHistogram ()
virtual void	MoveToPreviousElement ()
virtual void	MoveToNextElement ()
virtual unsigned long	GetColorMTime ()
virtual unsigned long	GetOpacityMTime ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkTransferFunctionEditorWidget *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkTransferFunctionEditorWidget ()
	~vtkTransferFunctionEditorWidget ()
virtual void	UpdateTransferFunctionMTime ()
Protected Attributes
double	VisibleScalarRange [2]
double	WholeScalarRange [2]
int	NumberOfScalarBins
int	ModificationType
vtkPiecewiseFunction *	OpacityFunction
vtkColorTransferFunction *	ColorFunction
vtkRectilinearGrid *	Histogram
unsigned long	ColorMTime
unsigned long	OpacityMTime
int	AllowInteriorElements
int	BorderWidth

---

Detailed Description

a 3D widget for manipulating a transfer function

vtkTransferFunctionEditorWidget is a superclass for 3D widgets that manipulate a transfer function. It allows you to interactively change the transfer function used for determining the colors used in rendering an actor or volume.

See also:

vtkTransferFunctionEditorWidgetSimple1D vtkTransferFunctionEditorWidgetShapes1D vtkTransferFunctionEditorWidgetShapes2D

Definition at line 39 of file vtkTransferFunctionEditorWidget.h.

---

Member Enumeration Documentation

enum vtkTransferFunctionEditorWidget::ModificationTypes

Enumerator:

COLOR
OPACITY
COLOR_AND_OPACITY

Definition at line 77 of file vtkTransferFunctionEditorWidget.h.

---

Constructor & Destructor Documentation

vtkTransferFunctionEditorWidget::vtkTransferFunctionEditorWidget

(

)

[protected]

vtkTransferFunctionEditorWidget::~vtkTransferFunctionEditorWidget

(

)

[protected]

---

Member Function Documentation

virtual const char* vtkTransferFunctionEditorWidget::GetClassName

(

)

[virtual]

Reimplemented from vtkAbstractWidget.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D, vtkTransferFunctionEditorWidget1D, vtkTransferFunctionEditorWidgetShapes1D, and vtkTransferFunctionEditorWidgetShapes2D.

static int vtkTransferFunctionEditorWidget::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkAbstractWidget.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D, vtkTransferFunctionEditorWidget1D, vtkTransferFunctionEditorWidgetShapes1D, and vtkTransferFunctionEditorWidgetShapes2D.

virtual int vtkTransferFunctionEditorWidget::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkAbstractWidget.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D, vtkTransferFunctionEditorWidget1D, vtkTransferFunctionEditorWidgetShapes1D, and vtkTransferFunctionEditorWidgetShapes2D.

static vtkTransferFunctionEditorWidget* vtkTransferFunctionEditorWidget::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkAbstractWidget.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D, vtkTransferFunctionEditorWidget1D, vtkTransferFunctionEditorWidgetShapes1D, and vtkTransferFunctionEditorWidgetShapes2D.

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

Reimplemented from vtkAbstractWidget.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D, vtkTransferFunctionEditorWidget1D, vtkTransferFunctionEditorWidgetShapes1D, and vtkTransferFunctionEditorWidgetShapes2D.

virtual void vtkTransferFunctionEditorWidget::SetVisibleScalarRange

(

double

range[2]

)

[inline, virtual]

Set the scalar range to show in the transfer function editor.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D.

Definition at line 47 of file vtkTransferFunctionEditorWidget.h.

virtual void vtkTransferFunctionEditorWidget::SetVisibleScalarRange	(	double	min,
		double	max
	)		[virtual]

Set the scalar range to show in the transfer function editor.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D.

virtual double* vtkTransferFunctionEditorWidget::GetVisibleScalarRange

(

)

[virtual]

Set the scalar range to show in the transfer function editor.

virtual void vtkTransferFunctionEditorWidget::GetVisibleScalarRange	(	double &	,
		double &
	)		[virtual]

Set the scalar range to show in the transfer function editor.

virtual void vtkTransferFunctionEditorWidget::GetVisibleScalarRange

(

double

[2]

)

[virtual]

Set the scalar range to show in the transfer function editor.

void vtkTransferFunctionEditorWidget::SetWholeScalarRange	(	double	min,
		double	max
	)

Set the whole range of possible scalar values to show in the transfer function editor. This is used for showing the whole scalar range when the histogram is not set.

void vtkTransferFunctionEditorWidget::SetWholeScalarRange

(

double

range[2]

)

[inline]

Set the whole range of possible scalar values to show in the transfer function editor. This is used for showing the whole scalar range when the histogram is not set.

Definition at line 58 of file vtkTransferFunctionEditorWidget.h.

virtual double* vtkTransferFunctionEditorWidget::GetWholeScalarRange

(

)

[virtual]

Set the whole range of possible scalar values to show in the transfer function editor. This is used for showing the whole scalar range when the histogram is not set.

virtual void vtkTransferFunctionEditorWidget::GetWholeScalarRange	(	double &	,
		double &
	)		[virtual]

Set the whole range of possible scalar values to show in the transfer function editor. This is used for showing the whole scalar range when the histogram is not set.

virtual void vtkTransferFunctionEditorWidget::GetWholeScalarRange

(

double

[2]

)

[virtual]

Set the whole range of possible scalar values to show in the transfer function editor. This is used for showing the whole scalar range when the histogram is not set.

void vtkTransferFunctionEditorWidget::ShowWholeScalarRange

(

)

Reset the widget so that it shows the whole scalar range of the input data set.

virtual void vtkTransferFunctionEditorWidget::Configure

(

int

size[2]

)

[virtual]

Reconfigure the widget based on the size of the renderer containing it.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D.

virtual void vtkTransferFunctionEditorWidget::SetModificationType

(

int

)

[virtual]

Set the type of function to modify.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D.

virtual vtkPiecewiseFunction* vtkTransferFunctionEditorWidget::GetOpacityFunction

(

)

[virtual]

Set/get the opacity transfer function.

void vtkTransferFunctionEditorWidget::SetOpacityFunction

(

vtkPiecewiseFunction *

function

)

Set/get the opacity transfer function.

virtual vtkColorTransferFunction* vtkTransferFunctionEditorWidget::GetColorFunction

(

)

[virtual]

Set/get the color transfer function.

void vtkTransferFunctionEditorWidget::SetColorFunction

(

vtkColorTransferFunction *

function

)

Set/get the color transfer function.

virtual void vtkTransferFunctionEditorWidget::SetAllowInteriorElements

(

int

)

[virtual]

Toggle whether to allow interior nodes in the transfer function.

virtual int vtkTransferFunctionEditorWidget::GetAllowInteriorElements

(

)

[virtual]

Toggle whether to allow interior nodes in the transfer function.

virtual void vtkTransferFunctionEditorWidget::AllowInteriorElementsOn

(

)

[virtual]

Toggle whether to allow interior nodes in the transfer function.

virtual void vtkTransferFunctionEditorWidget::AllowInteriorElementsOff

(

)

[virtual]

Toggle whether to allow interior nodes in the transfer function.

virtual void vtkTransferFunctionEditorWidget::SetElementOpacity	(	unsigned int	,
		double
	)		[inline, virtual]

Set/get the opacity of a particular element in the transfer function editor.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D.

Definition at line 107 of file vtkTransferFunctionEditorWidget.h.

virtual double vtkTransferFunctionEditorWidget::GetElementOpacity

(

unsigned int

)

[inline, virtual]

Set/get the opacity of a particular element in the transfer function editor.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D.

Definition at line 108 of file vtkTransferFunctionEditorWidget.h.

virtual void vtkTransferFunctionEditorWidget::SetElementRGBColor	(	unsigned int	,
		double	,
		double	,
		double
	)		[inline, virtual]

Set/get the RGB color of a particular element in the transfer function editor.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D.

Definition at line 114 of file vtkTransferFunctionEditorWidget.h.

virtual int vtkTransferFunctionEditorWidget::GetElementRGBColor	(	unsigned int	,
		double	[3]
	)		[inline, virtual]

Set/get the RGB color of a particular element in the transfer function editor.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D.

Definition at line 116 of file vtkTransferFunctionEditorWidget.h.

virtual void vtkTransferFunctionEditorWidget::SetElementHSVColor	(	unsigned int	,
		double	,
		double	,
		double
	)		[inline, virtual]

Set the HSV color of a particular element in the transfer function editor.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D.

Definition at line 123 of file vtkTransferFunctionEditorWidget.h.

virtual int vtkTransferFunctionEditorWidget::GetElementHSVColor	(	unsigned int	,
		double	[3]
	)		[inline, virtual]

Set the HSV color of a particular element in the transfer function editor.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D.

Definition at line 125 of file vtkTransferFunctionEditorWidget.h.

virtual void vtkTransferFunctionEditorWidget::SetElementScalar	(	unsigned int	,
		double
	)		[inline, virtual]

Set the scalar value associated with a particular element in the transfer function editor.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D.

Definition at line 132 of file vtkTransferFunctionEditorWidget.h.

virtual double vtkTransferFunctionEditorWidget::GetElementScalar

(

unsigned int

)

[inline, virtual]

Set the scalar value associated with a particular element in the transfer function editor.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D.

Definition at line 133 of file vtkTransferFunctionEditorWidget.h.

virtual void vtkTransferFunctionEditorWidget::SetHistogram

(

vtkRectilinearGrid *

histogram

)

[virtual]

Set/get the rectilinear grid containing the histogram.

Reimplemented in vtkTransferFunctionEditorWidget1D.

virtual vtkRectilinearGrid* vtkTransferFunctionEditorWidget::GetHistogram

(

)

[virtual]

Set/get the rectilinear grid containing the histogram.

virtual void vtkTransferFunctionEditorWidget::SetColorSpace

(

int

)

[inline, virtual]

Set the color space. (RGB = 0, HSV = 1, HSV with wrapping = 2, CIELAB = 3, Diverging = 4)

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D.

Definition at line 144 of file vtkTransferFunctionEditorWidget.h.

virtual void vtkTransferFunctionEditorWidget::MoveToPreviousElement

(

)

[virtual]

Move to previous/next transfer function element.

virtual void vtkTransferFunctionEditorWidget::MoveToNextElement

(

)

[virtual]

Move to previous/next transfer function element.

virtual void vtkTransferFunctionEditorWidget::OnChar

(

)

[virtual]

Respond to keypress events.

Reimplemented from vtkAbstractWidget.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D.

virtual unsigned long vtkTransferFunctionEditorWidget::GetColorMTime

(

)

[virtual]

Get the modified time associated with the color / opacity transfer functions.

virtual unsigned long vtkTransferFunctionEditorWidget::GetOpacityMTime

(

)

[virtual]

Get the modified time associated with the color / opacity transfer functions.

virtual void vtkTransferFunctionEditorWidget::UpdateFromTransferFunctions

(

)

[inline, virtual]

Update this widget based on changes to the transfer functions.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D.

Definition at line 163 of file vtkTransferFunctionEditorWidget.h.

virtual void vtkTransferFunctionEditorWidget::CreateDefaultRepresentation

(

)

[virtual]

Create a default representation for this widget, vtkTransferFunctionEditorRepresentationSimple1D in this case.

Implements vtkAbstractWidget.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D, vtkTransferFunctionEditorWidgetShapes1D, and vtkTransferFunctionEditorWidgetShapes2D.

virtual void vtkTransferFunctionEditorWidget::SetBorderWidth

(

int

width

)

[virtual]

Set the width (in pixels) of the border around the transfer function editor.

Reimplemented in vtkTransferFunctionEditorWidgetSimple1D.

virtual void vtkTransferFunctionEditorWidget::UpdateTransferFunctionMTime

(

)

[protected, virtual]

---

Member Data Documentation

double vtkTransferFunctionEditorWidget::VisibleScalarRange[2] [protected]

Definition at line 177 of file vtkTransferFunctionEditorWidget.h.

double vtkTransferFunctionEditorWidget::WholeScalarRange[2] [protected]

Definition at line 178 of file vtkTransferFunctionEditorWidget.h.

int vtkTransferFunctionEditorWidget::NumberOfScalarBins [protected]

Definition at line 179 of file vtkTransferFunctionEditorWidget.h.

int vtkTransferFunctionEditorWidget::ModificationType [protected]

Definition at line 180 of file vtkTransferFunctionEditorWidget.h.

vtkPiecewiseFunction* vtkTransferFunctionEditorWidget::OpacityFunction [protected]

Definition at line 181 of file vtkTransferFunctionEditorWidget.h.

vtkColorTransferFunction* vtkTransferFunctionEditorWidget::ColorFunction [protected]

Definition at line 182 of file vtkTransferFunctionEditorWidget.h.

vtkRectilinearGrid* vtkTransferFunctionEditorWidget::Histogram [protected]

Definition at line 183 of file vtkTransferFunctionEditorWidget.h.

unsigned long vtkTransferFunctionEditorWidget::ColorMTime [protected]

Definition at line 184 of file vtkTransferFunctionEditorWidget.h.

unsigned long vtkTransferFunctionEditorWidget::OpacityMTime [protected]

Definition at line 185 of file vtkTransferFunctionEditorWidget.h.

int vtkTransferFunctionEditorWidget::AllowInteriorElements [protected]

Definition at line 186 of file vtkTransferFunctionEditorWidget.h.

int vtkTransferFunctionEditorWidget::BorderWidth [protected]

Definition at line 187 of file vtkTransferFunctionEditorWidget.h.

---

The documentation for this class was generated from the following file:

• dox/ParaViewCore/VTKExtensions/vtkTransferFunctionEditorWidget.h