VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkApplyIcons Class Reference

apply icons to a data set. More...

#include <vtkApplyIcons.h>

Inherits vtkPassInputTypeAlgorithm.

Public Types

enum  { SELECTED_ICON, SELECTED_OFFSET, ANNOTATION_ICON, IGNORE_SELECTION }
 
typedef vtkPassInputTypeAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkApplyIconsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetIconType (vtkVariant v, int icon)
 
void SetIconType (double v, int icon)
 
void SetIconType (const char *v, int icon)
 
void ClearAllIconTypes ()
 
virtual void SetUseLookupTable (bool)
 
virtual bool GetUseLookupTable ()
 
virtual void UseLookupTableOn ()
 
virtual void UseLookupTableOff ()
 
virtual void SetDefaultIcon (int)
 
virtual int GetDefaultIcon ()
 
virtual void SetSelectedIcon (int)
 
virtual int GetSelectedIcon ()
 
virtual void SetIconOutputArrayName (const char *)
 
virtual char * GetIconOutputArrayName ()
 
virtual void SetSelectionMode (int)
 
virtual int GetSelectionMode ()
 
virtual void SetSelectionModeToSelectedIcon ()
 
virtual void SetSelectionModeToSelectedOffset ()
 
virtual void SetSelectionModeToAnnotationIcon ()
 
virtual void SetSelectionModeToIgnoreSelection ()
 
virtual void SetAttributeType (int)
 
virtual int GetAttributeType ()
 

Static Public Member Functions

static vtkApplyIconsNew ()
 
static int IsTypeOf (const char *type)
 
static vtkApplyIconsSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkApplyIcons ()
 
 ~vtkApplyIcons ()
 
int FillInputPortInformation (int port, vtkInformation *info)
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

int DefaultIcon
 
int SelectedIcon
 
bool UseLookupTable
 
char * IconOutputArrayName
 
int SelectionMode
 
int AttributeType
 
Internals * Implementation
 

Detailed Description

apply icons to a data set.

vtkApplyIcons performs a iconing of the dataset using default icons, lookup tables, annotations, and/or a selection. The output is a vtkIntArray containing the icon index for each element in the dataset. The first input is the dataset to be iconed, which may be a vtkTable, vtkGraph subclass, or vtkDataSet subclass.

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 icon. For annotations with icon properties, this algorithm will use the icon index of annotated 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 icon of the selection, or whether there is a set of selected icons at a particular offset in the icon sheet.

The algorithm takes an input array, specified with SetInputArrayToProcess(0, 0, 0, vtkDataObject::FIELD_ASSOCIATION_POINTS, name) This sets data arrays to use to icon the data with the associated lookup table. For vtkGraph and vtkTable inputs, you would use FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, or FIELD_ASSOCIATION_ROWS as appropriate. The icon array will be added to the same set of attributes that the input array came from. If there is no input array, the icon array will be applied to the attributes associated with the AttributeType parameter.

Icons are assigned with the following priorities:

  1. If an item is part of the selection, it is glyphed with that icon.
  2. Otherwise, if the item is part of an annotation, it is glyphed with the icon of the final (top) annotation in the set of layers.
  3. Otherwise, if a lookup table is used, it is glyphed using the lookup table icon for the data value of the element.
  4. Otherwise it will be glyphed with the default icon.

Definition at line 69 of file vtkApplyIcons.h.

Member Typedef Documentation

typedef vtkPassInputTypeAlgorithm vtkApplyIcons::Superclass

Definition at line 73 of file vtkApplyIcons.h.

Member Enumeration Documentation

anonymous enum
Enumerator
SELECTED_ICON 
SELECTED_OFFSET 
ANNOTATION_ICON 
IGNORE_SELECTION 

Definition at line 117 of file vtkApplyIcons.h.

Constructor & Destructor Documentation

vtkApplyIcons::vtkApplyIcons ( )
protected
vtkApplyIcons::~vtkApplyIcons ( )
protected

Member Function Documentation

static vtkApplyIcons* vtkApplyIcons::New ( )
static
static int vtkApplyIcons::IsTypeOf ( const char *  type)
static
virtual int vtkApplyIcons::IsA ( const char *  type)
virtual
static vtkApplyIcons* vtkApplyIcons::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkApplyIcons::NewInstanceInternal ( ) const
protectedvirtual
vtkApplyIcons* vtkApplyIcons::NewInstance ( ) const
void vtkApplyIcons::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
void vtkApplyIcons::SetIconType ( vtkVariant  v,
int  icon 
)

Edits the lookup table to use for point icons. This is only used if input array 0 is set and UsePointLookupTable is on.

void vtkApplyIcons::SetIconType ( double  v,
int  icon 
)
inline

Edits the lookup table to use for point icons. This is only used if input array 0 is set and UsePointLookupTable is on.

Definition at line 80 of file vtkApplyIcons.h.

void vtkApplyIcons::SetIconType ( const char *  v,
int  icon 
)
inline

Edits the lookup table to use for point icons. This is only used if input array 0 is set and UsePointLookupTable is on.

Definition at line 82 of file vtkApplyIcons.h.

void vtkApplyIcons::ClearAllIconTypes ( )

Edits the lookup table to use for point icons. This is only used if input array 0 is set and UsePointLookupTable is on.

virtual void vtkApplyIcons::SetUseLookupTable ( bool  )
virtual

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

virtual bool vtkApplyIcons::GetUseLookupTable ( )
virtual

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

virtual void vtkApplyIcons::UseLookupTableOn ( )
virtual

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

virtual void vtkApplyIcons::UseLookupTableOff ( )
virtual

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

virtual void vtkApplyIcons::SetDefaultIcon ( int  )
virtual

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

virtual int vtkApplyIcons::GetDefaultIcon ( )
virtual

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

virtual void vtkApplyIcons::SetSelectedIcon ( int  )
virtual

The point icon for all selected elements of the data. This is used if the annotation input has a current selection.

virtual int vtkApplyIcons::GetSelectedIcon ( )
virtual

The point icon for all selected elements of the data. This is used if the annotation input has a current selection.

virtual void vtkApplyIcons::SetIconOutputArrayName ( const char *  )
virtual

The output array name for the point icon index array. Default is "vtkApplyIcons icon".

virtual char* vtkApplyIcons::GetIconOutputArrayName ( )
virtual

The output array name for the point icon index array. Default is "vtkApplyIcons icon".

virtual void vtkApplyIcons::SetSelectionMode ( int  )
virtual

Changes the behavior of the icon to use for selected items.

  • SELECTED_ICON uses SelectedIcon as the icon for all selected elements.
  • SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements.
  • ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation.
  • IGNORE_SELECTION does not change the icon based on the current selection.

The default is IGNORE_SELECTION.

virtual int vtkApplyIcons::GetSelectionMode ( )
virtual

Changes the behavior of the icon to use for selected items.

  • SELECTED_ICON uses SelectedIcon as the icon for all selected elements.
  • SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements.
  • ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation.
  • IGNORE_SELECTION does not change the icon based on the current selection.

The default is IGNORE_SELECTION.

virtual void vtkApplyIcons::SetSelectionModeToSelectedIcon ( )
inlinevirtual

Changes the behavior of the icon to use for selected items.

  • SELECTED_ICON uses SelectedIcon as the icon for all selected elements.
  • SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements.
  • ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation.
  • IGNORE_SELECTION does not change the icon based on the current selection.

The default is IGNORE_SELECTION.

Definition at line 136 of file vtkApplyIcons.h.

virtual void vtkApplyIcons::SetSelectionModeToSelectedOffset ( )
inlinevirtual

Changes the behavior of the icon to use for selected items.

  • SELECTED_ICON uses SelectedIcon as the icon for all selected elements.
  • SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements.
  • ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation.
  • IGNORE_SELECTION does not change the icon based on the current selection.

The default is IGNORE_SELECTION.

Definition at line 138 of file vtkApplyIcons.h.

virtual void vtkApplyIcons::SetSelectionModeToAnnotationIcon ( )
inlinevirtual

Changes the behavior of the icon to use for selected items.

  • SELECTED_ICON uses SelectedIcon as the icon for all selected elements.
  • SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements.
  • ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation.
  • IGNORE_SELECTION does not change the icon based on the current selection.

The default is IGNORE_SELECTION.

Definition at line 140 of file vtkApplyIcons.h.

virtual void vtkApplyIcons::SetSelectionModeToIgnoreSelection ( )
inlinevirtual

Changes the behavior of the icon to use for selected items.

  • SELECTED_ICON uses SelectedIcon as the icon for all selected elements.
  • SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements.
  • ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation.
  • IGNORE_SELECTION does not change the icon based on the current selection.

The default is IGNORE_SELECTION.

Definition at line 142 of file vtkApplyIcons.h.

virtual void vtkApplyIcons::SetAttributeType ( int  )
virtual

The attribute type to append the icon array to, used only if the input array is not specified or does not exist. This is set to one of the AttributeTypes enum in vtkDataObject (e.g. POINT, CELL, VERTEX EDGE, FIELD).

virtual int vtkApplyIcons::GetAttributeType ( )
virtual

The attribute type to append the icon array to, used only if the input array is not specified or does not exist. This is set to one of the AttributeTypes enum in vtkDataObject (e.g. POINT, CELL, VERTEX EDGE, FIELD).

int vtkApplyIcons::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected

Convert the vtkGraph into vtkPolyData.

int vtkApplyIcons::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protected

Set the input type of the algorithm to vtkGraph.

Member Data Documentation

int vtkApplyIcons::DefaultIcon
protected

Definition at line 168 of file vtkApplyIcons.h.

int vtkApplyIcons::SelectedIcon
protected

Definition at line 169 of file vtkApplyIcons.h.

bool vtkApplyIcons::UseLookupTable
protected

Definition at line 170 of file vtkApplyIcons.h.

char* vtkApplyIcons::IconOutputArrayName
protected

Definition at line 171 of file vtkApplyIcons.h.

int vtkApplyIcons::SelectionMode
protected

Definition at line 172 of file vtkApplyIcons.h.

int vtkApplyIcons::AttributeType
protected

Definition at line 173 of file vtkApplyIcons.h.

Internals* vtkApplyIcons::Implementation
protected

Definition at line 176 of file vtkApplyIcons.h.


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