VTK  9.6.1
vtkSelectionNode.h File Reference
#include "vtkCommonDataModelModule.h"
#include "vtkObject.h"
Include dependency graph for vtkSelectionNode.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations

enum  SelectionContent {
  GLOBALIDS , PEDIGREEIDS , VALUES , INDICES ,
  FRUSTUM , LOCATIONS , THRESHOLDS , BLOCKS ,
  BLOCK_SELECTORS , QUERY , USER , NUM_CONTENT_TYPES
}
 Indicate the means by which data is selected. More...
enum  SelectionField {
  CELL , POINT , FIELD , VERTEX ,
  EDGE , ROW , NUM_FIELD_TYPES
}
 Indicate the types of entities to which the selection-data applies. More...

Functions

virtual void Initialize ()
virtual void DeepCopy (vtkSelectionNode *src)
 Copy properties, selection list and children of the input.
virtual void ShallowCopy (vtkSelectionNode *src)
 Copy properties, selection list and children of the input.
vtkMTimeType GetMTime () override
 Return the MTime taking into account changes to the properties.
static vtkInformationIntegerKeyCONTENT_TYPE ()
 Get the (primary) property that describes the content of a selection node's data.
static const char * GetContentTypeAsString (int type)
 Get the content type as a string.
static vtkInformationIntegerKeyFIELD_TYPE ()
 Controls whether cell, point, or field data determine what is inside and out.
static const char * GetFieldTypeAsString (int type)
 Get the field type as a string.
static int GetFieldTypeFromString (const char *type)
 Get field type from string.
static vtkInformationDoubleKeyEPSILON ()
 For location selection of points, if distance is greater than this reject.
static vtkInformationDoubleKeyZBUFFER_VALUE ()
 If present, closest zbuffer value of this selection.
static vtkInformationIntegerKeyCONTAINING_CELLS ()
 This flag tells the extraction filter, when FIELD_TYPE==POINT, that it should also extract the cells that contain any of the extracted points.
static vtkInformationIntegerKeyCONNECTED_LAYERS ()
 When specified, this indicates how many layers of connected elements in addition to those chosen explicitly are being selected.
static vtkInformationIntegerKeyCONNECTED_LAYERS_REMOVE_SEED ()
 When specified and also using CONNECTED_LAYERS(), this indicates if the initial selection should be kept or not.
static vtkInformationIntegerKeyCONNECTED_LAYERS_REMOVE_INTERMEDIATE_LAYERS ()
 When specified and also using CONNECTED_LAYERS(), this indicates if the intermediate layers should be kept or not.
static vtkInformationIntegerKeyCOMPONENT_NUMBER ()
 When ContentType==THRESHOLDS or ContentType==VALUES i.e.
static vtkInformationIntegerKeyINVERSE ()
 This flag tells the extraction filter to exclude the selection.
static vtkInformationIntegerKeyPIXEL_COUNT ()
 A helper for visible cell selector, this is the number of pixels covered by the actor whose cells are listed in the selection.
static vtkInformationObjectBaseKeySOURCE ()
 Pointer to the data or algorithm the selection belongs to.
static vtkInformationIntegerKeySOURCE_ID ()
 ID of the data or algorithm the selection belongs to.
static vtkInformationObjectBaseKeyPROP ()
 Pointer to the prop the selection belongs to.
static vtkInformationIntegerKeyPROP_ID ()
 ID of the prop the selection belongs to.
static vtkInformationIntegerKeyPROCESS_ID ()
 Process id the selection is on.
static vtkInformationIntegerKeyCOMPOSITE_INDEX ()
 Used to identify a node in composite datasets.
void UnionSelectionList (vtkSelectionNode *other)
 Merges the selection list between self and the other.
void SubtractSelectionList (vtkSelectionNode *other)
 Subtracts the items in the selection list, other, from this selection list.
bool EqualProperties (vtkSelectionNode *other, bool fullcompare=true)
 Compares Properties of self and other to ensure that they are exactly same.
 vtkSelectionNode ()
 ~vtkSelectionNode () override
virtual void SetSelectionList (vtkAbstractArray *)
 Get/Set the selection list.
virtual vtkAbstractArrayGetSelectionList ()
 Get/Set the selection list.
virtual void SetSelectionData (vtkDataSetAttributes *data)
 Sets the selection table.
virtual vtkDataSetAttributesGetSelectionData ()
 Sets the selection table.
virtual vtkInformationGetProperties ()
 Returns the property map.
virtual void SetContentType (int type)
 Get or set the content type of the selection.
virtual int GetContentType ()
 Get or set the content type of the selection.
virtual void SetFieldType (int type)
 Get or set the field type of the selection.
virtual int GetFieldType ()
 Get or set the field type of the selection.
static int ConvertSelectionFieldToAttributeType (int val)
 Methods to convert vtkSelectionNode::SelectionField to vtkDataSetAttribute::AttributeTypes and vice-versa.
static int ConvertAttributeTypeToSelectionField (int val)
 Methods to convert vtkSelectionNode::SelectionField to vtkDataSetAttribute::AttributeTypes and vice-versa.
virtual void SetQueryString (const char *)
 Set/Get the query expression string.
virtual char * GetQueryString ()
 Set/Get the query expression string.
static vtkInformationStringKeyASSEMBLY_NAME ()
 Keys for selector-based identification of blocks to choose from a composite dataset.
static vtkInformationStringVectorKeySELECTORS ()
 Keys for selector-based identification of blocks to choose from a composite dataset.
static vtkInformationIntegerKeyHIERARCHICAL_LEVEL ()
 Used to identify a dataset in a hiererchical box dataset.
static vtkInformationIntegerKeyHIERARCHICAL_INDEX ()
 Used to identify a dataset in a hiererchical box dataset.
static vtkInformationIntegerKeyCELLGRID_CELL_TYPE_INDEX ()
 Used to identify a cell type and whether picked entity is a side in a vtkCellGrid.
static vtkInformationIntegerKeyCELLGRID_SOURCE_SPECIFICATION_INDEX ()
 Used to identify a cell type and whether picked entity is a side in a vtkCellGrid.

Variables

vtkInformationProperties
vtkDataSetAttributesSelectionData
char * QueryString
static const char ContentTypeNames [SelectionContent::NUM_CONTENT_TYPES][16]
static const char FieldTypeNames [SelectionField::NUM_FIELD_TYPES][8]

Enumeration Type Documentation

◆ SelectionContent

Indicate the means by which data is selected.

In some cases this implies the type of data selected.

Enumerator
GLOBALIDS 

Select entities called out by their globally-unique IDs.

PEDIGREEIDS 

Select entities that have some identifiable pedigree.

VALUES 

Select entities that take on specific array values.

INDICES 

Select entities by their offsets into the dataset.

FRUSTUM 

Select entities contained within a viewing frustum.

LOCATIONS 

Select entities near the supplied world coordinates.

THRESHOLDS 

Select entities whose array values fall within a given threshold.

BLOCKS 

Select blocks within a composite dataset by their flat index.

BLOCK_SELECTORS 

Select datasets within a composite dataset using selector expressions.

QUERY 

Select entities with a text query.

USER 

Select entities with user-supplied, application-specific logic.

NUM_CONTENT_TYPES 

Definition at line 302 of file vtkSelectionNode.h.

◆ SelectionField

Indicate the types of entities to which the selection-data applies.

Enumerator
CELL 

The selection data provided is cell-data.

POINT 

The selection data provided is point-data.

FIELD 

The selection data provided is field-data.

VERTEX 

The selection data provided is graph vertex-data.

EDGE 

The selection data provided is graph edge-data.

ROW 

The selection data provided is table row-data.

NUM_FIELD_TYPES 

Definition at line 342 of file vtkSelectionNode.h.

Function Documentation

◆ Initialize()

virtual void Initialize ( )
virtual

◆ SetSelectionList()

virtual void SetSelectionList ( vtkAbstractArray * )
virtual

Get/Set the selection list.

The selection list is the container that stores values that indicate the selected items. What these values correspond to depends on the ContentType. ContentType may also dictate the type and form of the selection list array.

◆ GetSelectionList()

virtual vtkAbstractArray * GetSelectionList ( )
virtual

Get/Set the selection list.

The selection list is the container that stores values that indicate the selected items. What these values correspond to depends on the ContentType. ContentType may also dictate the type and form of the selection list array.

◆ SetSelectionData()

virtual void SetSelectionData ( vtkDataSetAttributes * data)
virtual

Sets the selection table.

◆ GetSelectionData()

virtual vtkDataSetAttributes * GetSelectionData ( )
virtual

Sets the selection table.

◆ GetProperties()

virtual vtkInformation * GetProperties ( )
virtual

Returns the property map.

◆ DeepCopy()

virtual void DeepCopy ( vtkSelectionNode * src)
virtual

Copy properties, selection list and children of the input.

◆ ShallowCopy()

virtual void ShallowCopy ( vtkSelectionNode * src)
virtual

Copy properties, selection list and children of the input.

This is a shallow copy: selection lists and pointers in the properties are passed by reference.

◆ GetMTime()

vtkMTimeType GetMTime ( )
override

Return the MTime taking into account changes to the properties.

◆ SetContentType()

virtual void SetContentType ( int type)
virtual

Get or set the content type of the selection.

This is the same as setting the CONTENT_TYPE() key on the property.

Definition at line 271 of file vtkSelectionSource.h.

◆ GetContentType()

virtual int GetContentType ( )
virtual

Get or set the content type of the selection.

This is the same as setting the CONTENT_TYPE() key on the property.

Definition at line 275 of file vtkSelectionSource.h.

◆ GetContentTypeAsString()

const char * GetContentTypeAsString ( int type)
static

Get the content type as a string.

◆ SetFieldType()

virtual void SetFieldType ( int type)
virtual

Get or set the field type of the selection.

This is the same as setting the FIELD_TYPE() key on the property.

◆ GetFieldType()

virtual int GetFieldType ( )
virtual

Get or set the field type of the selection.

This is the same as setting the FIELD_TYPE() key on the property.

◆ GetFieldTypeAsString()

const char * GetFieldTypeAsString ( int type)
static

Get the field type as a string.

◆ GetFieldTypeFromString()

int GetFieldTypeFromString ( const char * type)
static

Get field type from string.

Returns NUM_FIELD_TYPES if not found.

◆ ConvertSelectionFieldToAttributeType()

int ConvertSelectionFieldToAttributeType ( int val)
static

Methods to convert vtkSelectionNode::SelectionField to vtkDataSetAttribute::AttributeTypes and vice-versa.

◆ ConvertAttributeTypeToSelectionField()

int ConvertAttributeTypeToSelectionField ( int val)
static

Methods to convert vtkSelectionNode::SelectionField to vtkDataSetAttribute::AttributeTypes and vice-versa.

◆ SetQueryString()

virtual void SetQueryString ( const char * query)
virtual

Set/Get the query expression string.

Definition at line 422 of file vtkSelectionSource.h.

◆ GetQueryString()

virtual char * GetQueryString ( )
virtual

Set/Get the query expression string.

Definition at line 424 of file vtkSelectionSource.h.

◆ CELLGRID_CELL_TYPE_INDEX()

vtkInformationIntegerKey * CELLGRID_CELL_TYPE_INDEX ( )
static

Used to identify a cell type and whether picked entity is a side in a vtkCellGrid.

  1. CELLGRID_CELL_TYPE_INDEX is an offset into vtkCellGrid::CellTypeArray()
  2. For cell spec, CELLGRID_SOURCE_SPECIFICATION_INDEX will be 0,
  3. For all other side specs, CELLGRID_SOURCE_SPECIFICATION_INDEX will take on values starting from 1. NOTE: The cell/side spec correspond to vtkDGCell::Source objects found in vtkDGCell::GetCellSpec() and vtkDGCell::GetSideSpecs()

◆ CELLGRID_SOURCE_SPECIFICATION_INDEX()

vtkInformationIntegerKey * CELLGRID_SOURCE_SPECIFICATION_INDEX ( )
static

Used to identify a cell type and whether picked entity is a side in a vtkCellGrid.

  1. CELLGRID_CELL_TYPE_INDEX is an offset into vtkCellGrid::CellTypeArray()
  2. For cell spec, CELLGRID_SOURCE_SPECIFICATION_INDEX will be 0,
  3. For all other side specs, CELLGRID_SOURCE_SPECIFICATION_INDEX will take on values starting from 1. NOTE: The cell/side spec correspond to vtkDGCell::Source objects found in vtkDGCell::GetCellSpec() and vtkDGCell::GetSideSpecs()

◆ UnionSelectionList()

void UnionSelectionList ( vtkSelectionNode * other)

Merges the selection list between self and the other.

Assumes that both has identical properties.

◆ SubtractSelectionList()

void SubtractSelectionList ( vtkSelectionNode * other)

Subtracts the items in the selection list, other, from this selection list.

Assumes that both selections have identical properties (i.e., test with EqualProperties before using).

◆ EqualProperties()

bool EqualProperties ( vtkSelectionNode * other,
bool fullcompare = true )

Compares Properties of self and other to ensure that they are exactly same.

◆ vtkSelectionNode()

vtkSelectionNode ( )
protected

◆ ~vtkSelectionNode()

~vtkSelectionNode ( )
overrideprotected

Variable Documentation

◆ Properties

vtkInformation* Properties
protected

Definition at line 550 of file vtkSelectionNode.h.

◆ SelectionData

vtkDataSetAttributes* SelectionData
protected

Definition at line 551 of file vtkSelectionNode.h.

◆ QueryString

char* QueryString
protected

Definition at line 552 of file vtkSelectionNode.h.

◆ ContentTypeNames

const char ContentTypeNames[SelectionContent::NUM_CONTENT_TYPES][16]
staticprotected

Definition at line 555 of file vtkSelectionNode.h.

◆ FieldTypeNames

const char FieldTypeNames[SelectionField::NUM_FIELD_TYPES][8]
staticprotected

Definition at line 558 of file vtkSelectionNode.h.