vtkViewTheme Class Reference

#include <vtkViewTheme.h>

Inheritance diagram for vtkViewTheme:

[legend]

Collaboration diagram for vtkViewTheme:

[legend]

List of all members.

---

Detailed Description

Sets theme colors for a graphical view.

This may be set on any subclass of vtkView. The view class will attempt to use the values set in the theme to customize the view. Views will not generally use every aspect of the theme. NOTICE: This class will be deprecated in favor of a more robust solution based on style sheets. Do not become overly-dependent on the functionality of themes.

Tests:

vtkViewTheme (Tests)

Definition at line 40 of file vtkViewTheme.h.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetPointSize (double)
virtual double	GetPointSize ()
virtual void	SetLineWidth (double)
virtual double	GetLineWidth ()
virtual void	SetPointColor (double, double, double)
virtual void	SetPointColor (double[3])
virtual double *	GetPointColor ()
virtual void	GetPointColor (double &, double &, double &)
virtual void	GetPointColor (double[3])
virtual void	SetPointOpacity (double)
virtual double	GetPointOpacity ()
virtual void	SetPointHueRange (double, double)
void	SetPointHueRange (double[2])
virtual double *	GetPointHueRange ()
virtual void	GetPointHueRange (double &, double &)
virtual void	GetPointHueRange (double[2])
virtual void	SetPointSaturationRange (double, double)
void	SetPointSaturationRange (double[2])
virtual double *	GetPointSaturationRange ()
virtual void	GetPointSaturationRange (double &, double &)
virtual void	GetPointSaturationRange (double[2])
virtual void	SetPointValueRange (double, double)
void	SetPointValueRange (double[2])
virtual double *	GetPointValueRange ()
virtual void	GetPointValueRange (double &, double &)
virtual void	GetPointValueRange (double[2])
virtual void	SetPointAlphaRange (double, double)
void	SetPointAlphaRange (double[2])
virtual double *	GetPointAlphaRange ()
virtual void	GetPointAlphaRange (double &, double &)
virtual void	GetPointAlphaRange (double[2])
virtual void	SetCellColor (double, double, double)
virtual void	SetCellColor (double[3])
virtual double *	GetCellColor ()
virtual void	GetCellColor (double &, double &, double &)
virtual void	GetCellColor (double[3])
virtual void	SetCellOpacity (double)
virtual double	GetCellOpacity ()
virtual void	SetCellHueRange (double, double)
void	SetCellHueRange (double[2])
virtual double *	GetCellHueRange ()
virtual void	GetCellHueRange (double &, double &)
virtual void	GetCellHueRange (double[2])
virtual void	SetCellSaturationRange (double, double)
void	SetCellSaturationRange (double[2])
virtual double *	GetCellSaturationRange ()
virtual void	GetCellSaturationRange (double &, double &)
virtual void	GetCellSaturationRange (double[2])
virtual void	SetCellValueRange (double, double)
void	SetCellValueRange (double[2])
virtual double *	GetCellValueRange ()
virtual void	GetCellValueRange (double &, double &)
virtual void	GetCellValueRange (double[2])
virtual void	SetCellAlphaRange (double, double)
void	SetCellAlphaRange (double[2])
virtual double *	GetCellAlphaRange ()
virtual void	GetCellAlphaRange (double &, double &)
virtual void	GetCellAlphaRange (double[2])
virtual void	SetOutlineColor (double, double, double)
virtual void	SetOutlineColor (double[3])
virtual double *	GetOutlineColor ()
virtual void	GetOutlineColor (double &, double &, double &)
virtual void	GetOutlineColor (double[3])
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	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	SetBackgroundColor (double, double, double)
virtual void	SetBackgroundColor (double[3])
virtual double *	GetBackgroundColor ()
virtual void	GetBackgroundColor (double &, double &, double &)
virtual void	GetBackgroundColor (double[3])
virtual void	SetBackgroundColor2 (double, double, double)
virtual void	SetBackgroundColor2 (double[3])
virtual double *	GetBackgroundColor2 ()
virtual void	GetBackgroundColor2 (double &, double &, double &)
virtual void	GetBackgroundColor2 (double[3])
virtual void	SetVertexLabelColor (double, double, double)
virtual void	SetVertexLabelColor (double[3])
virtual double *	GetVertexLabelColor ()
virtual void	GetVertexLabelColor (double &, double &, double &)
virtual void	GetVertexLabelColor (double[3])
virtual void	SetEdgeLabelColor (double, double, double)
virtual void	SetEdgeLabelColor (double[3])
virtual double *	GetEdgeLabelColor ()
virtual void	GetEdgeLabelColor (double &, double &, double &)
virtual void	GetEdgeLabelColor (double[3])
Static Public Member Functions
static vtkViewTheme *	New ()
static int	IsTypeOf (const char *type)
static vtkViewTheme *	SafeDownCast (vtkObject *o)
static vtkViewTheme *	CreateOceanTheme ()
static vtkViewTheme *	CreateMellowTheme ()
static vtkViewTheme *	CreateNeonTheme ()
Protected Member Functions
	vtkViewTheme ()
	~vtkViewTheme ()
Protected Attributes
double	PointSize
double	LineWidth
double	PointColor [3]
double	PointOpacity
double	PointHueRange [2]
double	PointSaturationRange [2]
double	PointValueRange [2]
double	PointAlphaRange [2]
double	CellColor [3]
double	CellOpacity
double	CellHueRange [2]
double	CellSaturationRange [2]
double	CellValueRange [2]
double	CellAlphaRange [2]
double	OutlineColor [3]
double	SelectedPointColor [3]
double	SelectedPointOpacity
double	SelectedCellColor [3]
double	SelectedCellOpacity
double	BackgroundColor [3]
double	BackgroundColor2 [3]
double	VertexLabelColor [3]
double	EdgeLabelColor [3]

---

Member Typedef Documentation

typedef vtkObject vtkViewTheme::Superclass

Reimplemented from vtkObject.

Definition at line 44 of file vtkViewTheme.h.

---

Constructor & Destructor Documentation

vtkViewTheme::vtkViewTheme

(

)

[protected]

vtkViewTheme::~vtkViewTheme

(

)

[protected]

---

Member Function Documentation

static vtkViewTheme* vtkViewTheme::New

(

)

[static]

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

Reimplemented from vtkObject.

virtual const char* vtkViewTheme::GetClassName

(

)

[virtual]

Reimplemented from vtkObject.

static int vtkViewTheme::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int vtkViewTheme::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkViewTheme* vtkViewTheme::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkObject.

void vtkViewTheme::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 vtkObject.

virtual void vtkViewTheme::SetPointSize

(

double

)

[virtual]

The size of points or vertices

virtual double vtkViewTheme::GetPointSize

(

)

[virtual]

The size of points or vertices

virtual void vtkViewTheme::SetLineWidth

(

double

)

[virtual]

The width of lines or edges

virtual double vtkViewTheme::GetLineWidth

(

)

[virtual]

The width of lines or edges

virtual void vtkViewTheme::SetPointColor	(	double	,
		double	,
		double
	)			[virtual]

The color and opacity of points or vertices when not mapped through a lookup table.

virtual void vtkViewTheme::SetPointColor

(

double

[3]

)

[virtual]

The color and opacity of points or vertices when not mapped through a lookup table.

virtual double* vtkViewTheme::GetPointColor

(

)

[virtual]

The color and opacity of points or vertices when not mapped through a lookup table.

virtual void vtkViewTheme::GetPointColor	(	double &	,
		double &	,
		double &
	)			[virtual]

The color and opacity of points or vertices when not mapped through a lookup table.

virtual void vtkViewTheme::GetPointColor

(

double

[3]

)

[virtual]

The color and opacity of points or vertices when not mapped through a lookup table.

virtual void vtkViewTheme::SetPointOpacity

(

double

)

[virtual]

The color and opacity of points or vertices when not mapped through a lookup table.

virtual double vtkViewTheme::GetPointOpacity

(

)

[virtual]

The color and opacity of points or vertices when not mapped through a lookup table.

virtual void vtkViewTheme::SetPointHueRange	(	double	,
		double
	)			[virtual]

The ranges to use in a lookup table.

void vtkViewTheme::SetPointHueRange

(

double

[2]

)

The ranges to use in a lookup table.

virtual double* vtkViewTheme::GetPointHueRange

(

)

[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::GetPointHueRange	(	double &	,
		double &
	)			[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::GetPointHueRange

(

double

[2]

)

[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::SetPointSaturationRange	(	double	,
		double
	)			[virtual]

The ranges to use in a lookup table.

void vtkViewTheme::SetPointSaturationRange

(

double

[2]

)

The ranges to use in a lookup table.

virtual double* vtkViewTheme::GetPointSaturationRange

(

)

[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::GetPointSaturationRange	(	double &	,
		double &
	)			[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::GetPointSaturationRange

(

double

[2]

)

[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::SetPointValueRange	(	double	,
		double
	)			[virtual]

The ranges to use in a lookup table.

void vtkViewTheme::SetPointValueRange

(

double

[2]

)

The ranges to use in a lookup table.

virtual double* vtkViewTheme::GetPointValueRange

(

)

[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::GetPointValueRange	(	double &	,
		double &
	)			[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::GetPointValueRange

(

double

[2]

)

[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::SetPointAlphaRange	(	double	,
		double
	)			[virtual]

The ranges to use in a lookup table.

void vtkViewTheme::SetPointAlphaRange

(

double

[2]

)

The ranges to use in a lookup table.

virtual double* vtkViewTheme::GetPointAlphaRange

(

)

[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::GetPointAlphaRange	(	double &	,
		double &
	)			[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::GetPointAlphaRange

(

double

[2]

)

[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::SetCellColor	(	double	,
		double	,
		double
	)			[virtual]

The color and opacity of cells or edges when not mapped through a lookup table.

virtual void vtkViewTheme::SetCellColor

(

double

[3]

)

[virtual]

The color and opacity of cells or edges when not mapped through a lookup table.

virtual double* vtkViewTheme::GetCellColor

(

)

[virtual]

The color and opacity of cells or edges when not mapped through a lookup table.

virtual void vtkViewTheme::GetCellColor	(	double &	,
		double &	,
		double &
	)			[virtual]

The color and opacity of cells or edges when not mapped through a lookup table.

virtual void vtkViewTheme::GetCellColor

(

double

[3]

)

[virtual]

The color and opacity of cells or edges when not mapped through a lookup table.

virtual void vtkViewTheme::SetCellOpacity

(

double

)

[virtual]

The color and opacity of cells or edges when not mapped through a lookup table.

virtual double vtkViewTheme::GetCellOpacity

(

)

[virtual]

The color and opacity of cells or edges when not mapped through a lookup table.

virtual void vtkViewTheme::SetCellHueRange	(	double	,
		double
	)			[virtual]

The ranges to use in a lookup table.

void vtkViewTheme::SetCellHueRange

(

double

[2]

)

The ranges to use in a lookup table.

virtual double* vtkViewTheme::GetCellHueRange

(

)

[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::GetCellHueRange	(	double &	,
		double &
	)			[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::GetCellHueRange

(

double

[2]

)

[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::SetCellSaturationRange	(	double	,
		double
	)			[virtual]

The ranges to use in a lookup table.

void vtkViewTheme::SetCellSaturationRange

(

double

[2]

)

The ranges to use in a lookup table.

virtual double* vtkViewTheme::GetCellSaturationRange

(

)

[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::GetCellSaturationRange	(	double &	,
		double &
	)			[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::GetCellSaturationRange

(

double

[2]

)

[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::SetCellValueRange	(	double	,
		double
	)			[virtual]

The ranges to use in a lookup table.

void vtkViewTheme::SetCellValueRange

(

double

[2]

)

The ranges to use in a lookup table.

virtual double* vtkViewTheme::GetCellValueRange

(

)

[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::GetCellValueRange	(	double &	,
		double &
	)			[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::GetCellValueRange

(

double

[2]

)

[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::SetCellAlphaRange	(	double	,
		double
	)			[virtual]

The ranges to use in a lookup table.

void vtkViewTheme::SetCellAlphaRange

(

double

[2]

)

The ranges to use in a lookup table.

virtual double* vtkViewTheme::GetCellAlphaRange

(

)

[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::GetCellAlphaRange	(	double &	,
		double &
	)			[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::GetCellAlphaRange

(

double

[2]

)

[virtual]

The ranges to use in a lookup table.

virtual void vtkViewTheme::SetOutlineColor	(	double	,
		double	,
		double
	)			[virtual]

The color of any outlines in the view.

virtual void vtkViewTheme::SetOutlineColor

(

double

[3]

)

[virtual]

The color of any outlines in the view.

virtual double* vtkViewTheme::GetOutlineColor

(

)

[virtual]

The color of any outlines in the view.

virtual void vtkViewTheme::GetOutlineColor	(	double &	,
		double &	,
		double &
	)			[virtual]

The color of any outlines in the view.

virtual void vtkViewTheme::GetOutlineColor

(

double

[3]

)

[virtual]

The color of any outlines in the view.

virtual void vtkViewTheme::SetSelectedPointColor	(	double	,
		double	,
		double
	)			[virtual]

The color of selected points or vertices.

virtual void vtkViewTheme::SetSelectedPointColor

(

double

[3]

)

[virtual]

The color of selected points or vertices.

virtual double* vtkViewTheme::GetSelectedPointColor

(

)

[virtual]

The color of selected points or vertices.

virtual void vtkViewTheme::GetSelectedPointColor	(	double &	,
		double &	,
		double &
	)			[virtual]

The color of selected points or vertices.

virtual void vtkViewTheme::GetSelectedPointColor

(

double

[3]

)

[virtual]

The color of selected points or vertices.

virtual void vtkViewTheme::SetSelectedPointOpacity

(

double

)

[virtual]

The color of selected points or vertices.

virtual double vtkViewTheme::GetSelectedPointOpacity

(

)

[virtual]

The color of selected points or vertices.

virtual void vtkViewTheme::SetSelectedCellColor	(	double	,
		double	,
		double
	)			[virtual]

The color of selected cells or edges.

virtual void vtkViewTheme::SetSelectedCellColor

(

double

[3]

)

[virtual]

The color of selected cells or edges.

virtual double* vtkViewTheme::GetSelectedCellColor

(

)

[virtual]

The color of selected cells or edges.

virtual void vtkViewTheme::GetSelectedCellColor	(	double &	,
		double &	,
		double &
	)			[virtual]

The color of selected cells or edges.

virtual void vtkViewTheme::GetSelectedCellColor

(

double

[3]

)

[virtual]

The color of selected cells or edges.

virtual void vtkViewTheme::SetSelectedCellOpacity

(

double

)

[virtual]

The color of selected cells or edges.

virtual double vtkViewTheme::GetSelectedCellOpacity

(

)

[virtual]

The color of selected cells or edges.

virtual void vtkViewTheme::SetBackgroundColor	(	double	,
		double	,
		double
	)			[virtual]

The view background color.

virtual void vtkViewTheme::SetBackgroundColor

(

double

[3]

)

[virtual]

The view background color.

virtual double* vtkViewTheme::GetBackgroundColor

(

)

[virtual]

The view background color.

virtual void vtkViewTheme::GetBackgroundColor	(	double &	,
		double &	,
		double &
	)			[virtual]

The view background color.

virtual void vtkViewTheme::GetBackgroundColor

(

double

[3]

)

[virtual]

The view background color.

virtual void vtkViewTheme::SetBackgroundColor2	(	double	,
		double	,
		double
	)			[virtual]

The second background color (for gradients).

virtual void vtkViewTheme::SetBackgroundColor2

(

double

[3]

)

[virtual]

The second background color (for gradients).

virtual double* vtkViewTheme::GetBackgroundColor2

(

)

[virtual]

The second background color (for gradients).

virtual void vtkViewTheme::GetBackgroundColor2	(	double &	,
		double &	,
		double &
	)			[virtual]

The second background color (for gradients).

virtual void vtkViewTheme::GetBackgroundColor2

(

double

[3]

)

[virtual]

The second background color (for gradients).

virtual void vtkViewTheme::SetVertexLabelColor	(	double	,
		double	,
		double
	)			[virtual]

The color to use for labelling graph vertices.

virtual void vtkViewTheme::SetVertexLabelColor

(

double

[3]

)

[virtual]

The color to use for labelling graph vertices.

virtual double* vtkViewTheme::GetVertexLabelColor

(

)

[virtual]

The color to use for labelling graph vertices.

virtual void vtkViewTheme::GetVertexLabelColor	(	double &	,
		double &	,
		double &
	)			[virtual]

The color to use for labelling graph vertices.

virtual void vtkViewTheme::GetVertexLabelColor

(

double

[3]

)

[virtual]

The color to use for labelling graph vertices.

virtual void vtkViewTheme::SetEdgeLabelColor	(	double	,
		double	,
		double
	)			[virtual]

The color to use for labelling graph edges.

virtual void vtkViewTheme::SetEdgeLabelColor

(

double

[3]

)

[virtual]

The color to use for labelling graph edges.

virtual double* vtkViewTheme::GetEdgeLabelColor

(

)

[virtual]

The color to use for labelling graph edges.

virtual void vtkViewTheme::GetEdgeLabelColor	(	double &	,
		double &	,
		double &
	)			[virtual]

The color to use for labelling graph edges.

virtual void vtkViewTheme::GetEdgeLabelColor

(

double

[3]

)

[virtual]

The color to use for labelling graph edges.

static vtkViewTheme* vtkViewTheme::CreateOceanTheme

(

)

[static]

Convenience methods for creating some default view themes. The return reference is reference-counted, so you will have to call Delete() on the reference when you are finished with it.

static vtkViewTheme* vtkViewTheme::CreateMellowTheme

(

)

[static]

Convenience methods for creating some default view themes. The return reference is reference-counted, so you will have to call Delete() on the reference when you are finished with it.

static vtkViewTheme* vtkViewTheme::CreateNeonTheme

(

)

[static]

Convenience methods for creating some default view themes. The return reference is reference-counted, so you will have to call Delete() on the reference when you are finished with it.

---

Member Data Documentation

double vtkViewTheme::PointSize [protected]

Definition at line 160 of file vtkViewTheme.h.

double vtkViewTheme::LineWidth [protected]

Definition at line 161 of file vtkViewTheme.h.

double vtkViewTheme::PointColor[3] [protected]

Definition at line 163 of file vtkViewTheme.h.

double vtkViewTheme::PointOpacity [protected]

Definition at line 164 of file vtkViewTheme.h.

double vtkViewTheme::PointHueRange[2] [protected]

Definition at line 165 of file vtkViewTheme.h.

double vtkViewTheme::PointSaturationRange[2] [protected]

Definition at line 166 of file vtkViewTheme.h.

double vtkViewTheme::PointValueRange[2] [protected]

Definition at line 167 of file vtkViewTheme.h.

double vtkViewTheme::PointAlphaRange[2] [protected]

Definition at line 168 of file vtkViewTheme.h.

double vtkViewTheme::CellColor[3] [protected]

Definition at line 170 of file vtkViewTheme.h.

double vtkViewTheme::CellOpacity [protected]

Definition at line 171 of file vtkViewTheme.h.

double vtkViewTheme::CellHueRange[2] [protected]

Definition at line 172 of file vtkViewTheme.h.

double vtkViewTheme::CellSaturationRange[2] [protected]

Definition at line 173 of file vtkViewTheme.h.

double vtkViewTheme::CellValueRange[2] [protected]

Definition at line 174 of file vtkViewTheme.h.

double vtkViewTheme::CellAlphaRange[2] [protected]

Definition at line 175 of file vtkViewTheme.h.

double vtkViewTheme::OutlineColor[3] [protected]

Definition at line 177 of file vtkViewTheme.h.

double vtkViewTheme::SelectedPointColor[3] [protected]

Definition at line 179 of file vtkViewTheme.h.

double vtkViewTheme::SelectedPointOpacity [protected]

Definition at line 180 of file vtkViewTheme.h.

double vtkViewTheme::SelectedCellColor[3] [protected]

Definition at line 181 of file vtkViewTheme.h.

double vtkViewTheme::SelectedCellOpacity [protected]

Definition at line 182 of file vtkViewTheme.h.

double vtkViewTheme::BackgroundColor[3] [protected]

Definition at line 184 of file vtkViewTheme.h.

double vtkViewTheme::BackgroundColor2[3] [protected]

Definition at line 185 of file vtkViewTheme.h.

double vtkViewTheme::VertexLabelColor[3] [protected]

Definition at line 186 of file vtkViewTheme.h.

double vtkViewTheme::EdgeLabelColor[3] [protected]

Definition at line 187 of file vtkViewTheme.h.

---

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

• dox/Infovis/vtkViewTheme.h