ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkApplyIcons Class Reference

vtkApplyIcons - apply icons to a data set. More...

Inheritance diagram for Kitware.VTK.vtkApplyIcons:
[legend]
Collaboration diagram for Kitware.VTK.vtkApplyIcons:
[legend]

List of all members.

Public Types

enum  ANNOTATION_ICON_WrapperEnum { ANNOTATION_ICON = 2, IGNORE_SELECTION = 3, SELECTED_ICON = 0, SELECTED_OFFSET = 1 }
 The output array name for the point icon index array. Default is "vtkApplyIcons icon". More...

Public Member Functions

 vtkApplyIcons (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkApplyIcons ()
 Undocumented Block.
void 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 int GetAttributeType ()
 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 GetDefaultIcon ()
 The default point icon for all unannotated, unselected elements of the data. This is used if UsePointLookupTable is off.
virtual string GetIconOutputArrayName ()
 The output array name for the point icon index array. Default is "vtkApplyIcons icon".
virtual int GetSelectedIcon ()
 The point icon for all selected elements of the data. This is used if the annotation input has a current selection.
virtual int GetSelectionMode ()
 Changes the behavior of the icon to use for selected items. <ul> <li>SELECTED_ICON uses SelectedIcon as the icon for all selected elements. <li>SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements. <li>ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation. <li>IGNORE_SELECTION does not change the icon based on the current selection. </ul> The default is IGNORE_SELECTION.
virtual bool GetUseLookupTable ()
 If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data.
override int IsA (string type)
 Undocumented Block.
new vtkApplyIcons NewInstance ()
 Undocumented Block.
virtual void SetAttributeType (int _arg)
 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 void SetDefaultIcon (int _arg)
 The default point icon for all unannotated, unselected elements of the data. This is used if UsePointLookupTable is off.
virtual void SetIconOutputArrayName (string _arg)
 The output array name for the point icon index array. Default is "vtkApplyIcons icon".
void SetIconType (double 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 SetIconType (string 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.
virtual void SetSelectedIcon (int _arg)
 The point icon for all selected elements of the data. This is used if the annotation input has a current selection.
virtual void SetSelectionMode (int _arg)
 Changes the behavior of the icon to use for selected items. <ul> <li>SELECTED_ICON uses SelectedIcon as the icon for all selected elements. <li>SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements. <li>ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation. <li>IGNORE_SELECTION does not change the icon based on the current selection. </ul> The default is IGNORE_SELECTION.
virtual void SetSelectionModeToAnnotationIcon ()
 Changes the behavior of the icon to use for selected items. <ul> <li>SELECTED_ICON uses SelectedIcon as the icon for all selected elements. <li>SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements. <li>ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation. <li>IGNORE_SELECTION does not change the icon based on the current selection. </ul> The default is IGNORE_SELECTION.
virtual void SetSelectionModeToIgnoreSelection ()
 Changes the behavior of the icon to use for selected items. <ul> <li>SELECTED_ICON uses SelectedIcon as the icon for all selected elements. <li>SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements. <li>ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation. <li>IGNORE_SELECTION does not change the icon based on the current selection. </ul> The default is IGNORE_SELECTION.
virtual void SetSelectionModeToSelectedIcon ()
 Changes the behavior of the icon to use for selected items. <ul> <li>SELECTED_ICON uses SelectedIcon as the icon for all selected elements. <li>SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements. <li>ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation. <li>IGNORE_SELECTION does not change the icon based on the current selection. </ul> The default is IGNORE_SELECTION.
virtual void SetSelectionModeToSelectedOffset ()
 Changes the behavior of the icon to use for selected items. <ul> <li>SELECTED_ICON uses SelectedIcon as the icon for all selected elements. <li>SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements. <li>ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation. <li>IGNORE_SELECTION does not change the icon based on the current selection. </ul> The default is IGNORE_SELECTION.
virtual void SetUseLookupTable (bool _arg)
 If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data.
virtual void UseLookupTableOff ()
 If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data.
virtual void UseLookupTableOn ()
 If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data.

Static Public Member Functions

static new vtkApplyIcons New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkApplyIcons SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkApplyIcons"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "13vtkApplyIcons"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkApplyIcons_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkApplyIcons_ClearAllIconTypes_01 (HandleRef pThis)
static internal int vtkApplyIcons_GetAttributeType_02 (HandleRef pThis)
static internal int vtkApplyIcons_GetDefaultIcon_03 (HandleRef pThis)
static internal IntPtr vtkApplyIcons_GetIconOutputArrayName_04 (HandleRef pThis)
static internal int vtkApplyIcons_GetSelectedIcon_05 (HandleRef pThis)
static internal int vtkApplyIcons_GetSelectionMode_06 (HandleRef pThis)
static internal byte vtkApplyIcons_GetUseLookupTable_07 (HandleRef pThis)
static internal int vtkApplyIcons_IsA_08 (HandleRef pThis, string type)
static internal int vtkApplyIcons_IsTypeOf_09 (string type)
static internal IntPtr vtkApplyIcons_NewInstance_11 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkApplyIcons_SafeDownCast_12 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkApplyIcons_SetAttributeType_13 (HandleRef pThis, int _arg)
static internal void vtkApplyIcons_SetDefaultIcon_14 (HandleRef pThis, int _arg)
static internal void vtkApplyIcons_SetIconOutputArrayName_15 (HandleRef pThis, string _arg)
static internal void vtkApplyIcons_SetIconType_16 (HandleRef pThis, double v, int icon)
static internal void vtkApplyIcons_SetIconType_17 (HandleRef pThis, string v, int icon)
static internal void vtkApplyIcons_SetSelectedIcon_18 (HandleRef pThis, int _arg)
static internal void vtkApplyIcons_SetSelectionMode_19 (HandleRef pThis, int _arg)
static internal void vtkApplyIcons_SetSelectionModeToAnnotationIcon_20 (HandleRef pThis)
static internal void vtkApplyIcons_SetSelectionModeToIgnoreSelection_21 (HandleRef pThis)
static internal void vtkApplyIcons_SetSelectionModeToSelectedIcon_22 (HandleRef pThis)
static internal void vtkApplyIcons_SetSelectionModeToSelectedOffset_23 (HandleRef pThis)
static internal void vtkApplyIcons_SetUseLookupTable_24 (HandleRef pThis, byte _arg)
static internal void vtkApplyIcons_UseLookupTableOff_25 (HandleRef pThis)
static internal void vtkApplyIcons_UseLookupTableOn_26 (HandleRef pThis)

Static Private Member Functions

static vtkApplyIcons ()
 Automatically generated type registration mechanics.

Detailed Description

vtkApplyIcons - apply icons to a data set.

Description 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: <ol> <li> If an item is part of the selection, it is glyphed with that icon. <li> 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. <li> Otherwise, if a lookup table is used, it is glyphed using the lookup table icon for the data value of the element. <li> Otherwise it will be glyphed with the default icon. </ol>


Member Enumeration Documentation

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

Enumerator:
ANNOTATION_ICON 

enum member

IGNORE_SELECTION 

enum member

SELECTED_ICON 

enum member

SELECTED_OFFSET 

enum member


Constructor & Destructor Documentation

static Kitware.VTK.vtkApplyIcons.vtkApplyIcons ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkApplyIcons.vtkApplyIcons ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

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

override void Kitware.VTK.vtkApplyIcons.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkPassInputTypeAlgorithm.

virtual int Kitware.VTK.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).

virtual int Kitware.VTK.vtkApplyIcons.GetDefaultIcon ( ) [virtual]

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

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

virtual int Kitware.VTK.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 int Kitware.VTK.vtkApplyIcons.GetSelectionMode ( ) [virtual]

Changes the behavior of the icon to use for selected items. <ul> <li>SELECTED_ICON uses SelectedIcon as the icon for all selected elements. <li>SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements. <li>ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation. <li>IGNORE_SELECTION does not change the icon based on the current selection. </ul> The default is IGNORE_SELECTION.

virtual bool Kitware.VTK.vtkApplyIcons.GetUseLookupTable ( ) [virtual]

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

override int Kitware.VTK.vtkApplyIcons.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPassInputTypeAlgorithm.

static new int Kitware.VTK.vtkApplyIcons.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPassInputTypeAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPassInputTypeAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPassInputTypeAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPassInputTypeAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkApplyIcons.SetAttributeType ( int  _arg) [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 void Kitware.VTK.vtkApplyIcons.SetDefaultIcon ( int  _arg) [virtual]

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

virtual void Kitware.VTK.vtkApplyIcons.SetIconOutputArrayName ( string  _arg) [virtual]

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

void Kitware.VTK.vtkApplyIcons.SetIconType ( double  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 Kitware.VTK.vtkApplyIcons.SetIconType ( string  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.

virtual void Kitware.VTK.vtkApplyIcons.SetSelectedIcon ( int  _arg) [virtual]

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

virtual void Kitware.VTK.vtkApplyIcons.SetSelectionMode ( int  _arg) [virtual]

Changes the behavior of the icon to use for selected items. <ul> <li>SELECTED_ICON uses SelectedIcon as the icon for all selected elements. <li>SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements. <li>ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation. <li>IGNORE_SELECTION does not change the icon based on the current selection. </ul> The default is IGNORE_SELECTION.

Changes the behavior of the icon to use for selected items. <ul> <li>SELECTED_ICON uses SelectedIcon as the icon for all selected elements. <li>SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements. <li>ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation. <li>IGNORE_SELECTION does not change the icon based on the current selection. </ul> The default is IGNORE_SELECTION.

Changes the behavior of the icon to use for selected items. <ul> <li>SELECTED_ICON uses SelectedIcon as the icon for all selected elements. <li>SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements. <li>ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation. <li>IGNORE_SELECTION does not change the icon based on the current selection. </ul> The default is IGNORE_SELECTION.

Changes the behavior of the icon to use for selected items. <ul> <li>SELECTED_ICON uses SelectedIcon as the icon for all selected elements. <li>SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements. <li>ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation. <li>IGNORE_SELECTION does not change the icon based on the current selection. </ul> The default is IGNORE_SELECTION.

Changes the behavior of the icon to use for selected items. <ul> <li>SELECTED_ICON uses SelectedIcon as the icon for all selected elements. <li>SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements. <li>ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation. <li>IGNORE_SELECTION does not change the icon based on the current selection. </ul> The default is IGNORE_SELECTION.

virtual void Kitware.VTK.vtkApplyIcons.SetUseLookupTable ( bool  _arg) [virtual]

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

virtual void Kitware.VTK.vtkApplyIcons.UseLookupTableOff ( ) [virtual]

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

virtual void Kitware.VTK.vtkApplyIcons.UseLookupTableOn ( ) [virtual]

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

static internal void Kitware.VTK.vtkApplyIcons.vtkApplyIcons_ClearAllIconTypes_01 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkApplyIcons.vtkApplyIcons_GetAttributeType_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkApplyIcons.vtkApplyIcons_GetDefaultIcon_03 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkApplyIcons.vtkApplyIcons_GetIconOutputArrayName_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkApplyIcons.vtkApplyIcons_GetSelectedIcon_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkApplyIcons.vtkApplyIcons_GetSelectionMode_06 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkApplyIcons.vtkApplyIcons_GetUseLookupTable_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkApplyIcons.vtkApplyIcons_IsA_08 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkApplyIcons.vtkApplyIcons_IsTypeOf_09 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkApplyIcons.vtkApplyIcons_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkApplyIcons.vtkApplyIcons_NewInstance_11 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkApplyIcons.vtkApplyIcons_SafeDownCast_12 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkApplyIcons.vtkApplyIcons_SetAttributeType_13 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkApplyIcons.vtkApplyIcons_SetDefaultIcon_14 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkApplyIcons.vtkApplyIcons_SetIconOutputArrayName_15 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkApplyIcons.vtkApplyIcons_SetIconType_16 ( HandleRef  pThis,
double  v,
int  icon 
) [private]
static internal void Kitware.VTK.vtkApplyIcons.vtkApplyIcons_SetIconType_17 ( HandleRef  pThis,
string  v,
int  icon 
) [private]
static internal void Kitware.VTK.vtkApplyIcons.vtkApplyIcons_SetSelectedIcon_18 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkApplyIcons.vtkApplyIcons_SetSelectionMode_19 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkApplyIcons.vtkApplyIcons_SetSelectionModeToAnnotationIcon_20 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkApplyIcons.vtkApplyIcons_SetSelectionModeToIgnoreSelection_21 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkApplyIcons.vtkApplyIcons_SetSelectionModeToSelectedIcon_22 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkApplyIcons.vtkApplyIcons_SetSelectionModeToSelectedOffset_23 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkApplyIcons.vtkApplyIcons_SetUseLookupTable_24 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkApplyIcons.vtkApplyIcons_UseLookupTableOff_25 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkApplyIcons.vtkApplyIcons_UseLookupTableOn_26 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkApplyIcons.MRClassNameKey = "13vtkApplyIcons" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPassInputTypeAlgorithm.

new const string Kitware.VTK.vtkApplyIcons.MRFullTypeName = "Kitware.VTK.vtkApplyIcons"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPassInputTypeAlgorithm.


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