apply icons to a data set. More...
#include <vtkApplyIcons.h>
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:
- If an item is part of the selection, it is glyphed with that icon.
- 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.
- Otherwise, if a lookup table is used, it is glyphed using the lookup table icon for the data value of the element.
- Otherwise it will be glyphed with the default icon.
Definition at line 69 of file vtkApplyIcons.h.
Member Typedef Documentation
Reimplemented from vtkPassInputTypeAlgorithm.
Definition at line 73 of file vtkApplyIcons.h.
Member Enumeration Documentation
| anonymous enum |
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] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkPassInputTypeAlgorithm.
| static int vtkApplyIcons::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 vtkApplyIcons::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 vtkApplyIcons* vtkApplyIcons::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkPassInputTypeAlgorithm.
| virtual vtkObjectBase* vtkApplyIcons::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkPassInputTypeAlgorithm.
| vtkApplyIcons* vtkApplyIcons::NewInstance | ( | ) | const |
Reimplemented from vtkPassInputTypeAlgorithm.
| void vtkApplyIcons::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.
| 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 | ( | ) | [inline, 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.
Definition at line 136 of file vtkApplyIcons.h.
| virtual void vtkApplyIcons::SetSelectionModeToSelectedOffset | ( | ) | [inline, 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.
Definition at line 138 of file vtkApplyIcons.h.
| virtual void vtkApplyIcons::SetSelectionModeToAnnotationIcon | ( | ) | [inline, 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.
Definition at line 140 of file vtkApplyIcons.h.
| virtual void vtkApplyIcons::SetSelectionModeToIgnoreSelection | ( | ) | [inline, 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.
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, virtual] |
Convert the vtkGraph into vtkPolyData.
Reimplemented from vtkPassInputTypeAlgorithm.
| int vtkApplyIcons::FillInputPortInformation | ( | int | port, |
| vtkInformation * | info | ||
| ) | [protected, virtual] |
Set the input type of the algorithm to vtkGraph.
Reimplemented from vtkPassInputTypeAlgorithm.
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:
- dox/Views/Infovis/vtkApplyIcons.h
