Filter that generates a polydata consisting of quads with texture coordinates referring to a set of icons within a sheet of icons. More...

#include <vtkIconGlyphFilter.h>

Inheritance diagram for vtkIconGlyphFilter:

[legend]

Collaboration diagram for vtkIconGlyphFilter:

[legend]

List of all members.

Public Member Functions

virtual void	SetIconSize (int, int)
void	SetIconSize (int[2])
virtual int *	GetIconSize ()
virtual void	GetIconSize (int data[2])

virtual void	SetIconSheetSize (int, int)
void	SetIconSheetSize (int[2])
virtual int *	GetIconSheetSize ()
virtual void	GetIconSheetSize (int data[2])

virtual void	SetDisplaySize (int, int)
void	SetDisplaySize (int[2])
virtual int *	GetDisplaySize ()
virtual void	GetDisplaySize (int data[2])

virtual void	SetUseIconSize (bool)
virtual bool	GetUseIconSize ()
virtual void	UseIconSizeOn ()
virtual void	UseIconSizeOff ()

virtual void	SetIconScaling (int)
virtual int	GetIconScaling ()
void	SetIconScalingToScalingOff ()
void	SetIconScalingToScalingArray ()

virtual void	SetPassScalars (bool)
virtual bool	GetPassScalars ()
virtual void	PassScalarsOn ()
virtual void	PassScalarsOff ()

virtual void	SetGravity (int)
virtual int	GetGravity ()
void	SetGravityToTopRight ()
void	SetGravityToTopCenter ()
void	SetGravityToTopLeft ()
void	SetGravityToCenterRight ()
void	SetGravityToCenterCenter ()
void	SetGravityToCenterLeft ()
void	SetGravityToBottomRight ()
void	SetGravityToBottomCenter ()
void	SetGravityToBottomLeft ()

virtual void	SetOffset (int, int)
void	SetOffset (int[2])
virtual int *	GetOffset ()
virtual void	GetOffset (int data[2])
Protected Member Functions
	vtkIconGlyphFilter ()
	~vtkIconGlyphFilter ()
virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
Protected Attributes
int	IconSize [2]
int	IconSheetSize [2]
int	DisplaySize [2]
int	Gravity
bool	UseIconSize
int	IconScaling
bool	PassScalars
int	Offset [2]
typedef vtkPolyDataAlgorithm	Superclass
static vtkIconGlyphFilter *	New ()
static int	IsTypeOf (const char *type)
static vtkIconGlyphFilter *	SafeDownCast (vtkObjectBase *o)
virtual int	IsA (const char *type)
vtkIconGlyphFilter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBase *	NewInstanceInternal () const

Detailed Description

Filter that generates a polydata consisting of quads with texture coordinates referring to a set of icons within a sheet of icons.

vtkIconGlyphFilter takes in a vtkPointSet where each point corresponds to the center of an icon. Scalar integer data must also be set to give each point an icon index. This index is a zero based row major index into an image that contains a grid of icons (each icon is the same size). You must also specify 1) the size of the icon in the icon sheet (in pixels), 2) the size of the icon sheet (in pixels), and 3) the display size of each icon (again in display coordinates, or pixels).

Various other parameters are used to control how this data is combined. If UseIconSize is true then the DisplaySize is ignored. If PassScalars is true, then the scalar index information is passed to the output. Also, there is an optional IconScale array which, if UseIconScaling is on, will scale each icon independently.

See also:: vtkPolyDataAlgorithm vtkGlyph3D vtkGlyph2D

Tests:: vtkIconGlyphFilter (Tests)

Definition at line 61 of file vtkIconGlyphFilter.h.

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkIconGlyphFilter::Superclass

Standard VTK methods.

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 67 of file vtkIconGlyphFilter.h.

Constructor & Destructor Documentation

vtkIconGlyphFilter::vtkIconGlyphFilter ( ) [protected]

vtkIconGlyphFilter::~vtkIconGlyphFilter ( ) [protected]

Member Function Documentation

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

Standard VTK methods.

Reimplemented from vtkPolyDataAlgorithm.

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

Standard VTK methods.

Reimplemented from vtkPolyDataAlgorithm.

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

Standard VTK methods.

Reimplemented from vtkPolyDataAlgorithm.

static vtkIconGlyphFilter* vtkIconGlyphFilter::SafeDownCast ( vtkObjectBase * o ) [static]

Standard VTK methods.

Reimplemented from vtkPolyDataAlgorithm.

virtual vtkObjectBase* vtkIconGlyphFilter::NewInstanceInternal ( ) const [protected, virtual]

Standard VTK methods.

Reimplemented from vtkPolyDataAlgorithm.

vtkIconGlyphFilter* vtkIconGlyphFilter::NewInstance ( ) const

Standard VTK methods.

Reimplemented from vtkPolyDataAlgorithm.

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

Standard VTK methods.

Reimplemented from vtkPolyDataAlgorithm.

virtual void vtkIconGlyphFilter::SetIconSize	(	int	,
		int
	)		`[virtual]`

Specify the Width and Height, in pixels, of an icon in the icon sheet.

void vtkIconGlyphFilter::SetIconSize ( int [2] )

Specify the Width and Height, in pixels, of an icon in the icon sheet.

virtual int* vtkIconGlyphFilter::GetIconSize ( ) [virtual]

Specify the Width and Height, in pixels, of an icon in the icon sheet.

virtual void vtkIconGlyphFilter::GetIconSize ( int data[2] ) [virtual]

Specify the Width and Height, in pixels, of an icon in the icon sheet.

virtual void vtkIconGlyphFilter::SetIconSheetSize	(	int	,
		int
	)		`[virtual]`

Specify the Width and Height, in pixels, of an icon in the icon sheet.

void vtkIconGlyphFilter::SetIconSheetSize ( int [2] )

Specify the Width and Height, in pixels, of an icon in the icon sheet.

virtual int* vtkIconGlyphFilter::GetIconSheetSize ( ) [virtual]

Specify the Width and Height, in pixels, of an icon in the icon sheet.

virtual void vtkIconGlyphFilter::GetIconSheetSize ( int data[2] ) [virtual]

Specify the Width and Height, in pixels, of an icon in the icon sheet.

virtual void vtkIconGlyphFilter::SetDisplaySize	(	int	,
		int
	)		`[virtual]`

Specify the Width and Height, in pixels, of the size of the icon when it is rendered. By default, the IconSize is used to set the display size (i.e., UseIconSize is true by default). Note that assumes that IconScaling is disabled, or if enabled, the scale of a particular icon is 1.

void vtkIconGlyphFilter::SetDisplaySize ( int [2] )

Specify the Width and Height, in pixels, of the size of the icon when it is rendered. By default, the IconSize is used to set the display size (i.e., UseIconSize is true by default). Note that assumes that IconScaling is disabled, or if enabled, the scale of a particular icon is 1.

virtual int* vtkIconGlyphFilter::GetDisplaySize ( ) [virtual]

Specify the Width and Height, in pixels, of the size of the icon when it is rendered. By default, the IconSize is used to set the display size (i.e., UseIconSize is true by default). Note that assumes that IconScaling is disabled, or if enabled, the scale of a particular icon is 1.

virtual void vtkIconGlyphFilter::GetDisplaySize ( int data[2] ) [virtual]

Specify the Width and Height, in pixels, of the size of the icon when it is rendered. By default, the IconSize is used to set the display size (i.e., UseIconSize is true by default). Note that assumes that IconScaling is disabled, or if enabled, the scale of a particular icon is 1.

virtual void vtkIconGlyphFilter::SetUseIconSize ( bool ) [virtual]

Specify whether the Quad generated to place the icon on will be either the dimensions specified by IconSize or the DisplaySize.

virtual bool vtkIconGlyphFilter::GetUseIconSize ( ) [virtual]

Specify whether the Quad generated to place the icon on will be either the dimensions specified by IconSize or the DisplaySize.

virtual void vtkIconGlyphFilter::UseIconSizeOn ( ) [virtual]

Specify whether the Quad generated to place the icon on will be either the dimensions specified by IconSize or the DisplaySize.

virtual void vtkIconGlyphFilter::UseIconSizeOff ( ) [virtual]

Specify whether the Quad generated to place the icon on will be either the dimensions specified by IconSize or the DisplaySize.

virtual void vtkIconGlyphFilter::SetIconScaling ( int ) [virtual]

Specify how to specify individual icons. By default, icon scaling is off, but if it is on, then the filter looks for an array named "IconScale" to control individual icon size.

virtual int vtkIconGlyphFilter::GetIconScaling ( ) [virtual]

Specify how to specify individual icons. By default, icon scaling is off, but if it is on, then the filter looks for an array named "IconScale" to control individual icon size.

void vtkIconGlyphFilter::SetIconScalingToScalingOff ( ) [inline]

Specify how to specify individual icons. By default, icon scaling is off, but if it is on, then the filter looks for an array named "IconScale" to control individual icon size.

Definition at line 109 of file vtkIconGlyphFilter.h.

void vtkIconGlyphFilter::SetIconScalingToScalingArray ( ) [inline]

Specify how to specify individual icons. By default, icon scaling is off, but if it is on, then the filter looks for an array named "IconScale" to control individual icon size.

Definition at line 110 of file vtkIconGlyphFilter.h.

virtual void vtkIconGlyphFilter::SetPassScalars ( bool ) [virtual]

Specify whether to pass the scalar icon index to the output. By default this is not passed since it can affect color during the rendering process. Note that all other point data is passed to the output regardless of the value of this flag.

virtual bool vtkIconGlyphFilter::GetPassScalars ( ) [virtual]

Specify whether to pass the scalar icon index to the output. By default this is not passed since it can affect color during the rendering process. Note that all other point data is passed to the output regardless of the value of this flag.

virtual void vtkIconGlyphFilter::PassScalarsOn ( ) [virtual]

Specify whether to pass the scalar icon index to the output. By default this is not passed since it can affect color during the rendering process. Note that all other point data is passed to the output regardless of the value of this flag.

virtual void vtkIconGlyphFilter::PassScalarsOff ( ) [virtual]

Specify whether to pass the scalar icon index to the output. By default this is not passed since it can affect color during the rendering process. Note that all other point data is passed to the output regardless of the value of this flag.

virtual void vtkIconGlyphFilter::SetGravity ( int ) [virtual]