vtkIconGlyphFilter Class Reference

#include <vtkIconGlyphFilter.h>

Inheritance diagram for vtkIconGlyphFilter:

Inheritance graph
[legend]
Collaboration diagram for vtkIconGlyphFilter:

Collaboration graph
[legend]

List of all members.


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 60 of file vtkIconGlyphFilter.h.

typedef vtkPolyDataAlgorithm Superclass
static vtkIconGlyphFilterNew ()
static int IsTypeOf (const char *type)
static vtkIconGlyphFilterSafeDownCast (vtkObject *o)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

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]

Member Typedef Documentation

Standard VTK methods.

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 66 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.

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

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 ( vtkObject o  )  [static]

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 108 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 109 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]

Specify if the input points define the center of the icon quad or one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner, bottom center or bottom left corner.

virtual int vtkIconGlyphFilter::GetGravity (  )  [virtual]

Specify if the input points define the center of the icon quad or one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner, bottom center or bottom left corner.

void vtkIconGlyphFilter::SetGravityToTopRight (  )  [inline]

Specify if the input points define the center of the icon quad or one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner, bottom center or bottom left corner.

Definition at line 130 of file vtkIconGlyphFilter.h.

void vtkIconGlyphFilter::SetGravityToTopCenter (  )  [inline]

Specify if the input points define the center of the icon quad or one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner, bottom center or bottom left corner.

Definition at line 131 of file vtkIconGlyphFilter.h.

void vtkIconGlyphFilter::SetGravityToTopLeft (  )  [inline]

Specify if the input points define the center of the icon quad or one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner, bottom center or bottom left corner.

Definition at line 132 of file vtkIconGlyphFilter.h.

void vtkIconGlyphFilter::SetGravityToCenterRight (  )  [inline]

Specify if the input points define the center of the icon quad or one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner, bottom center or bottom left corner.

Definition at line 133 of file vtkIconGlyphFilter.h.

void vtkIconGlyphFilter::SetGravityToCenterCenter (  )  [inline]

Specify if the input points define the center of the icon quad or one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner, bottom center or bottom left corner.

Definition at line 134 of file vtkIconGlyphFilter.h.

void vtkIconGlyphFilter::SetGravityToCenterLeft (  )  [inline]

Specify if the input points define the center of the icon quad or one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner, bottom center or bottom left corner.

Definition at line 135 of file vtkIconGlyphFilter.h.

void vtkIconGlyphFilter::SetGravityToBottomRight (  )  [inline]

Specify if the input points define the center of the icon quad or one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner, bottom center or bottom left corner.

Definition at line 136 of file vtkIconGlyphFilter.h.

void vtkIconGlyphFilter::SetGravityToBottomCenter (  )  [inline]

Specify if the input points define the center of the icon quad or one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner, bottom center or bottom left corner.

Definition at line 137 of file vtkIconGlyphFilter.h.

void vtkIconGlyphFilter::SetGravityToBottomLeft (  )  [inline]

Specify if the input points define the center of the icon quad or one of top right corner, top center, top left corner, center right, center, center center left, bottom right corner, bottom center or bottom left corner.

Definition at line 138 of file vtkIconGlyphFilter.h.

virtual void vtkIconGlyphFilter::SetOffset ( int  ,
int   
) [virtual]

Specify an offset (in pixels or display coordinates) that offsets the icons from their generating points.

void vtkIconGlyphFilter::SetOffset ( int  [2]  ) 

Specify an offset (in pixels or display coordinates) that offsets the icons from their generating points.

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

Specify an offset (in pixels or display coordinates) that offsets the icons from their generating points.

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

Specify an offset (in pixels or display coordinates) that offsets the icons from their generating points.

virtual int vtkIconGlyphFilter::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.


Member Data Documentation

int vtkIconGlyphFilter::IconSize[2] [protected]

Definition at line 156 of file vtkIconGlyphFilter.h.

Definition at line 157 of file vtkIconGlyphFilter.h.

int vtkIconGlyphFilter::DisplaySize[2] [protected]

Definition at line 158 of file vtkIconGlyphFilter.h.

int vtkIconGlyphFilter::Gravity [protected]

Definition at line 160 of file vtkIconGlyphFilter.h.

Definition at line 161 of file vtkIconGlyphFilter.h.

Definition at line 162 of file vtkIconGlyphFilter.h.

Definition at line 163 of file vtkIconGlyphFilter.h.

int vtkIconGlyphFilter::Offset[2] [protected]

Definition at line 164 of file vtkIconGlyphFilter.h.


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

Generated on Wed Aug 24 11:40:01 2011 for VTK by  doxygen 1.5.6