vtkApplyColors Class Reference

#include <vtkApplyColors.h>

Inheritance diagram for vtkApplyColors:

[legend]

Collaboration diagram for vtkApplyColors:

[legend]

List of all members.

Detailed Description

apply colors to a data set.

vtkApplyColors performs a coloring of the dataset using default colors, lookup tables, annotations, and/or a selection. The output is a four-component vtkUnsignedCharArray containing RGBA tuples for each element in the dataset. The first input is the dataset to be colored, which may be a vtkTable, vtkGraph subclass, or vtkDataSet subclass. The API of this algorithm refers to "points" and "cells". For vtkGraph, the "points" refer to the graph vertices and "cells" refer to graph edges. For vtkTable, "points" refer to table rows. For vtkDataSet subclasses, the meaning is obvious.

The second (optional) input is a vtkAnnotationLayers object, which stores a list of annotation layers, with each layer holding a list of vtkAnnotation objects. The annotation specifies a subset of data along with other properties, including color. For annotations with color properties, this algorithm will use the color to color elements, using a "top one wins" strategy.

The third (optional) input is a vtkSelection object, meant for specifying the current selection. You can control the color of the selection.

The algorithm takes two input arrays, specified with SetInputArrayToProcess(0, 0, 0, vtkDataObject::FIELD_ASSOCIATION_POINTS, name) and SetInputArrayToProcess(1, 0, 0, vtkDataObject::FIELD_ASSOCIATION_CELLS, name). These set the point and cell data arrays to use to color the data with the associated lookup table. For vtkGraph, vtkTable inputs, you would use FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, or FIELD_ASSOCIATION_ROWS as appropriate.

To use the color array generated here, you should do the following:

mapper->SetScalarModeToUseCellFieldData(); mapper->SelectColorArray("vtkApplyColors color"); mapper->SetScalarVisibility(true);

Colors are assigned with the following priorities:

If an item is part of the selection, it is colored with that color.
Otherwise, if the item is part of an annotation, it is colored with the color of the final (top) annotation in the set of layers.
Otherwise, if the lookup table is used, it is colored using the lookup table color for the data value of the element.
Otherwise it will be colored with the default color.

Note: The opacity of an unselected item is defined by the multiplication of default opacity, lookup table opacity, and annotation opacity, where opacity is taken as a number from 0 to 1. So items will never be more opaque than any of these three opacities. Selected items are always given the selection opacity directly.

Definition at line 84 of file vtkApplyColors.h.


Public Types
typedef vtkPassInputTypeAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetPointLookupTable (vtkScalarsToColors *lut)
virtual vtkScalarsToColors *	GetPointLookupTable ()

virtual void	SetUsePointLookupTable (bool)
virtual bool	GetUsePointLookupTable ()
virtual void	UsePointLookupTableOn ()
virtual void	UsePointLookupTableOff ()

virtual void	SetScalePointLookupTable (bool)
virtual bool	GetScalePointLookupTable ()
virtual void	ScalePointLookupTableOn ()
virtual void	ScalePointLookupTableOff ()

virtual void	SetDefaultPointColor (double, double, double)
virtual void	SetDefaultPointColor (double[3])
virtual double *	GetDefaultPointColor ()
virtual void	GetDefaultPointColor (double &, double &, double &)
virtual void	GetDefaultPointColor (double[3])

virtual void	SetDefaultPointOpacity (double)
virtual double	GetDefaultPointOpacity ()

virtual void	SetSelectedPointColor (double, double, double)
virtual void	SetSelectedPointColor (double[3])
virtual double *	GetSelectedPointColor ()
virtual void	GetSelectedPointColor (double &, double &, double &)
virtual void	GetSelectedPointColor (double[3])

virtual void	SetSelectedPointOpacity (double)
virtual double	GetSelectedPointOpacity ()

virtual void	SetPointColorOutputArrayName (const char *)
virtual char *	GetPointColorOutputArrayName ()

virtual void	SetCellLookupTable (vtkScalarsToColors *lut)
virtual vtkScalarsToColors *	GetCellLookupTable ()

virtual void	SetUseCellLookupTable (bool)
virtual bool	GetUseCellLookupTable ()
virtual void	UseCellLookupTableOn ()
virtual void	UseCellLookupTableOff ()

virtual void	SetScaleCellLookupTable (bool)
virtual bool	GetScaleCellLookupTable ()
virtual void	ScaleCellLookupTableOn ()
virtual void	ScaleCellLookupTableOff ()

virtual void	SetDefaultCellColor (double, double, double)
virtual void	SetDefaultCellColor (double[3])
virtual double *	GetDefaultCellColor ()
virtual void	GetDefaultCellColor (double &, double &, double &)
virtual void	GetDefaultCellColor (double[3])

virtual void	SetDefaultCellOpacity (double)
virtual double	GetDefaultCellOpacity ()

virtual void	SetSelectedCellColor (double, double, double)
virtual void	SetSelectedCellColor (double[3])
virtual double *	GetSelectedCellColor ()
virtual void	GetSelectedCellColor (double &, double &, double &)
virtual void	GetSelectedCellColor (double[3])

virtual void	SetSelectedCellOpacity (double)
virtual double	GetSelectedCellOpacity ()

virtual void	SetCellColorOutputArrayName (const char *)
virtual char *	GetCellColorOutputArrayName ()

virtual void	SetUseCurrentAnnotationColor (bool)
virtual bool	GetUseCurrentAnnotationColor ()
virtual void	UseCurrentAnnotationColorOn ()
virtual void	UseCurrentAnnotationColorOff ()
Static Public Member Functions
static vtkApplyColors *	New ()
static int	IsTypeOf (const char *type)
static vtkApplyColors *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkApplyColors ()
	~vtkApplyColors ()
int	FillInputPortInformation (int port, vtkInformation *info)
void	ProcessColorArray (vtkUnsignedCharArray colorArr, vtkScalarsToColors lut, vtkAbstractArray *arr, unsigned char color[4], bool scale)

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
Protected Attributes
vtkScalarsToColors *	PointLookupTable
vtkScalarsToColors *	CellLookupTable
double	DefaultPointColor [3]
double	DefaultPointOpacity
double	DefaultCellColor [3]
double	DefaultCellOpacity
double	SelectedPointColor [3]
double	SelectedPointOpacity
double	SelectedCellColor [3]
double	SelectedCellOpacity
bool	ScalePointLookupTable
bool	ScaleCellLookupTable
bool	UsePointLookupTable
bool	UseCellLookupTable
char *	PointColorOutputArrayName
char *	CellColorOutputArrayName
bool	UseCurrentAnnotationColor

Member Typedef Documentation

typedef vtkPassInputTypeAlgorithm vtkApplyColors::Superclass

Reimplemented from vtkPassInputTypeAlgorithm.

Definition at line 88 of file vtkApplyColors.h.

Constructor & Destructor Documentation

vtkApplyColors::vtkApplyColors ( ) [protected]

vtkApplyColors::~vtkApplyColors ( ) [protected]

Member Function Documentation

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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkPassInputTypeAlgorithm.

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

Reimplemented from vtkPassInputTypeAlgorithm.

static int vtkApplyColors::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPassInputTypeAlgorithm.

virtual int vtkApplyColors::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPassInputTypeAlgorithm.

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

Reimplemented from vtkPassInputTypeAlgorithm.

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

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPassInputTypeAlgorithm.

virtual void vtkApplyColors::SetPointLookupTable ( vtkScalarsToColors * lut ) [virtual]

The lookup table to use for point colors. This is only used if input array 0 is set and UsePointLookupTable is on.

virtual vtkScalarsToColors* vtkApplyColors::GetPointLookupTable ( ) [virtual]

The lookup table to use for point colors. This is only used if input array 0 is set and UsePointLookupTable is on.

virtual void vtkApplyColors::SetUsePointLookupTable ( bool ) [virtual]

If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data.

virtual bool vtkApplyColors::GetUsePointLookupTable ( ) [virtual]

If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data.

virtual void vtkApplyColors::UsePointLookupTableOn ( ) [virtual]

If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data.

virtual void vtkApplyColors::UsePointLookupTableOff ( ) [virtual]

If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data.

virtual void vtkApplyColors::SetScalePointLookupTable ( bool ) [virtual]

If on, uses the range of the data to scale the lookup table range. Otherwise, uses the range defined in the lookup table.

virtual bool vtkApplyColors::GetScalePointLookupTable ( ) [virtual]

If on, uses the range of the data to scale the lookup table range. Otherwise, uses the range defined in the lookup table.

virtual void vtkApplyColors::ScalePointLookupTableOn ( ) [virtual]

If on, uses the range of the data to scale the lookup table range. Otherwise, uses the range defined in the lookup table.

virtual void vtkApplyColors::ScalePointLookupTableOff ( ) [virtual]

If on, uses the range of the data to scale the lookup table range. Otherwise, uses the range defined in the lookup table.

virtual void vtkApplyColors::SetDefaultPointColor	(	double	,
		double	,
		double
	)			`[virtual]`

The default point color for all unannotated, unselected elements of the data. This is used if UsePointLookupTable is off.

virtual void vtkApplyColors::SetDefaultPointColor ( double [3] ) [virtual]

The default point color for all unannotated, unselected elements of the data. This is used if UsePointLookupTable is off.

virtual double* vtkApplyColors::GetDefaultPointColor ( ) [virtual]

The default point color for all unannotated, unselected elements of the data. This is used if UsePointLookupTable is off.

virtual void vtkApplyColors::GetDefaultPointColor	(	double &	,
		double &	,
		double &
	)			`[virtual]`

The default point color for all unannotated, unselected elements of the data. This is used if UsePointLookupTable is off.

virtual void vtkApplyColors::GetDefaultPointColor ( double [3] ) [virtual]

The default point color for all unannotated, unselected elements of the data. This is used if UsePointLookupTable is off.

virtual void vtkApplyColors::SetDefaultPointOpacity ( double ) [virtual]

The default point opacity for all unannotated, unselected elements of the data. This is used if UsePointLookupTable is off.

virtual double vtkApplyColors::GetDefaultPointOpacity ( ) [virtual]

The default point opacity for all unannotated, unselected elements of the data. This is used if UsePointLookupTable is off.

virtual void vtkApplyColors::SetSelectedPointColor	(	double	,
		double	,
		double
	)			`[virtual]`

The point color for all selected elements of the data. This is used if the selection input is available.

virtual void vtkApplyColors::SetSelectedPointColor ( double [3] ) [virtual]

The point color for all selected elements of the data. This is used if the selection input is available.

virtual double* vtkApplyColors::GetSelectedPointColor ( ) [virtual]

The point color for all selected elements of the data. This is used if the selection input is available.

virtual void vtkApplyColors::GetSelectedPointColor	(	double &	,
		double &	,
		double &
	)			`[virtual]`

The point color for all selected elements of the data. This is used if the selection input is available.

virtual void vtkApplyColors::GetSelectedPointColor ( double [3] ) [virtual]

The point color for all selected elements of the data. This is used if the selection input is available.

virtual void vtkApplyColors::SetSelectedPointOpacity ( double ) [virtual]

The point opacity for all selected elements of the data. This is used if the selection input is available.

virtual double vtkApplyColors::GetSelectedPointOpacity ( ) [virtual]

The point opacity for all selected elements of the data. This is used if the selection input is available.

virtual void vtkApplyColors::SetPointColorOutputArrayName ( const char * ) [virtual]

The output array name for the point color RGBA array. Default is "vtkApplyColors color".

virtual char* vtkApplyColors::GetPointColorOutputArrayName ( ) [virtual]

The output array name for the point color RGBA array. Default is "vtkApplyColors color".

virtual void vtkApplyColors::SetCellLookupTable ( vtkScalarsToColors * lut ) [virtual]

The lookup table to use for cell colors. This is only used if input array 1 is set and UseCellLookupTable is on.

virtual vtkScalarsToColors* vtkApplyColors::GetCellLookupTable ( ) [virtual]

The lookup table to use for cell colors. This is only used if input array 1 is set and UseCellLookupTable is on.

virtual void vtkApplyColors::SetUseCellLookupTable ( bool ) [virtual]

If on, uses the cell lookup table to set the colors of unannotated, unselected elements of the data.

virtual bool vtkApplyColors::GetUseCellLookupTable ( ) [virtual]

If on, uses the cell lookup table to set the colors of unannotated, unselected elements of the data.

virtual void vtkApplyColors::UseCellLookupTableOn ( ) [virtual]

If on, uses the cell lookup table to set the colors of unannotated, unselected elements of the data.

virtual void vtkApplyColors::UseCellLookupTableOff ( ) [virtual]

If on, uses the cell lookup table to set the colors of unannotated, unselected elements of the data.

virtual void vtkApplyColors::SetScaleCellLookupTable ( bool ) [virtual]

If on, uses the range of the data to scale the lookup table range. Otherwise, uses the range defined in the lookup table.

virtual bool vtkApplyColors::GetScaleCellLookupTable ( ) [virtual]

If on, uses the range of the data to scale the lookup table range. Otherwise, uses the range defined in the lookup table.

virtual void vtkApplyColors::ScaleCellLookupTableOn ( ) [virtual]

If on, uses the range of the data to scale the lookup table range. Otherwise, uses the range defined in the lookup table.

virtual void vtkApplyColors::ScaleCellLookupTableOff ( ) [virtual]

If on, uses the range of the data to scale the lookup table range. Otherwise, uses the range defined in the lookup table.

virtual void vtkApplyColors::SetDefaultCellColor	(	double	,
		double	,
		double
	)			`[virtual]`

The default cell color for all unannotated, unselected elements of the data. This is used if UseCellLookupTable is off.

virtual void vtkApplyColors::SetDefaultCellColor ( double [3] ) [virtual]

The default cell color for all unannotated, unselected elements of the data. This is used if UseCellLookupTable is off.

virtual double* vtkApplyColors::GetDefaultCellColor ( ) [virtual]

The default cell color for all unannotated, unselected elements of the data. This is used if UseCellLookupTable is off.

virtual void vtkApplyColors::GetDefaultCellColor	(	double &	,
		double &	,
		double &
	)			`[virtual]`

The default cell color for all unannotated, unselected elements of the data. This is used if UseCellLookupTable is off.

virtual void vtkApplyColors::GetDefaultCellColor ( double [3] ) [virtual]

The default cell color for all unannotated, unselected elements of the data. This is used if UseCellLookupTable is off.

virtual void vtkApplyColors::SetDefaultCellOpacity ( double ) [virtual]

The default cell opacity for all unannotated, unselected elements of the data. This is used if UseCellLookupTable is off.

virtual double vtkApplyColors::GetDefaultCellOpacity ( ) [virtual]

The default cell opacity for all unannotated, unselected elements of the data. This is used if UseCellLookupTable is off.

virtual void vtkApplyColors::SetSelectedCellColor	(	double	,
		double	,
		double
	)			`[virtual]`

The cell color for all selected elements of the data. This is used if the selection input is available.

virtual void vtkApplyColors::SetSelectedCellColor ( double [3] ) [virtual]

The cell color for all selected elements of the data. This is used if the selection input is available.

virtual double* vtkApplyColors::GetSelectedCellColor ( ) [virtual]

The cell color for all selected elements of the data. This is used if the selection input is available.

virtual void vtkApplyColors::GetSelectedCellColor	(	double &	,
		double &	,
		double &
	)			`[virtual]`

The cell color for all selected elements of the data. This is used if the selection input is available.

virtual void vtkApplyColors::GetSelectedCellColor ( double [3] ) [virtual]

The cell color for all selected elements of the data. This is used if the selection input is available.

virtual void vtkApplyColors::SetSelectedCellOpacity ( double ) [virtual]

The cell opacity for all selected elements of the data. This is used if the selection input is available.

virtual double vtkApplyColors::GetSelectedCellOpacity ( ) [virtual]

The cell opacity for all selected elements of the data. This is used if the selection input is available.

virtual void vtkApplyColors::SetCellColorOutputArrayName ( const char * ) [virtual]

The output array name for the cell color RGBA array. Default is "vtkApplyColors color".

virtual char* vtkApplyColors::GetCellColorOutputArrayName ( ) [virtual]

The output array name for the cell color RGBA array. Default is "vtkApplyColors color".

virtual void vtkApplyColors::SetUseCurrentAnnotationColor ( bool ) [virtual]

Use the annotation to color the current annotation (i.e. the current selection). Otherwise use the selection color attributes of this filter.

virtual bool vtkApplyColors::GetUseCurrentAnnotationColor ( ) [virtual]

Use the annotation to color the current annotation (i.e. the current selection). Otherwise use the selection color attributes of this filter.

virtual void vtkApplyColors::UseCurrentAnnotationColorOn ( ) [virtual]

Use the annotation to color the current annotation (i.e. the current selection). Otherwise use the selection color attributes of this filter.

virtual void vtkApplyColors::UseCurrentAnnotationColorOff ( ) [virtual]

Use the annotation to color the current annotation (i.e. the current selection). Otherwise use the selection color attributes of this filter.

int vtkApplyColors::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			`[protected, virtual]`

Convert the vtkGraph into vtkPolyData.

Reimplemented from vtkPassInputTypeAlgorithm.

int vtkApplyColors::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)			`[protected, virtual]`

Set the input type of the algorithm to vtkGraph.

Reimplemented from vtkPassInputTypeAlgorithm.

void vtkApplyColors::ProcessColorArray	(	vtkUnsignedCharArray *	colorArr,
		vtkScalarsToColors *	lut,
		vtkAbstractArray *	arr,
		unsigned char	color[4],
		bool	scale
	)			`[protected]`