a node in a vtkSelection the defines the selection criteria. More...

#include <vtkSelectionNode.h>

Inheritance diagram for vtkSelectionNode:

Collaboration diagram for vtkSelectionNode:

Public Types
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...

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkSelectionNode *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	Initialize ()
	Restore data object to initial state,.

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.

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.


virtual void	SetSelectionList (vtkAbstractArray *)
	Get/Set the selection list.

virtual vtkAbstractArray *	GetSelectionList ()
	Get/Set the selection list.


virtual void	SetSelectionData (vtkDataSetAttributes *data)
	Sets the selection table.

virtual vtkDataSetAttributes *	GetSelectionData ()
	Sets the selection table.


virtual vtkInformation *	GetProperties ()
	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.


virtual void	SetQueryString (const char *)
	Set/Get the query expression string.

virtual char *	GetQueryString ()
	Set/Get the query expression string.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkSelectionNode *	SafeDownCast (vtkObjectBase *o)

static vtkSelectionNode *	New ()

static vtkInformationIntegerKey *	CONTENT_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 vtkInformationIntegerKey *	FIELD_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 vtkInformationDoubleKey *	EPSILON ()
	For location selection of points, if distance is greater than this reject.

static vtkInformationDoubleKey *	ZBUFFER_VALUE ()
	If present, closest zbuffer value of this selection.

static vtkInformationIntegerKey *	CONTAINING_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 vtkInformationIntegerKey *	CONNECTED_LAYERS ()
	When specified, this indicates how many layers of connected elements in addition to those chosen explicitly are being selected.

static vtkInformationIntegerKey *	CONNECTED_LAYERS_REMOVE_SEED ()
	When specified and also using CONNECTED_LAYERS(), this indicates if the initial selection should be kept or not.

static vtkInformationIntegerKey *	CONNECTED_LAYERS_REMOVE_INTERMEDIATE_LAYERS ()
	When specified and also using CONNECTED_LAYERS(), this indicates if the intermediate layers should be kept or not.

static vtkInformationIntegerKey *	COMPONENT_NUMBER ()
	When ContentType==THRESHOLDS or ContentType==VALUES i.e.

static vtkInformationIntegerKey *	INVERSE ()
	This flag tells the extraction filter to exclude the selection.

static vtkInformationIntegerKey *	PIXEL_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 vtkInformationObjectBaseKey *	SOURCE ()
	Pointer to the data or algorithm the selection belongs to.

static vtkInformationIntegerKey *	SOURCE_ID ()
	ID of the data or algorithm the selection belongs to.

static vtkInformationObjectBaseKey *	PROP ()
	Pointer to the prop the selection belongs to.

static vtkInformationIntegerKey *	PROP_ID ()
	ID of the prop the selection belongs to.

static vtkInformationIntegerKey *	PROCESS_ID ()
	Process id the selection is on.

static vtkInformationIntegerKey *	COMPOSITE_INDEX ()
	Used to identify a node in composite datasets.


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.


static vtkInformationStringKey *	ASSEMBLY_NAME ()
	Keys for selector-based identification of blocks to choose from a composite dataset.

static vtkInformationStringVectorKey *	SELECTORS ()
	Keys for selector-based identification of blocks to choose from a composite dataset.


static vtkInformationIntegerKey *	HIERARCHICAL_LEVEL ()
	Used to identify a dataset in a hiererchical box dataset.

static vtkInformationIntegerKey *	HIERARCHICAL_INDEX ()
	Used to identify a dataset in a hiererchical box dataset.


static vtkInformationIntegerKey *	CELLGRID_CELL_TYPE_INDEX ()
	Used to identify a cell type and whether picked entity is a side in a vtkCellGrid.

static vtkInformationIntegerKey *	CELLGRID_SOURCE_SPECIFICATION_INDEX ()
	Used to identify a cell type and whether picked entity is a side in a vtkCellGrid.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkSelectionNode ()

	~vtkSelectionNode () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkInformation *	Properties

vtkDataSetAttributes *	SelectionData

char *	QueryString

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Static Protected Attributes
static const char	ContentTypeNames [SelectionContent::NUM_CONTENT_TYPES][16]

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

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

a node in a vtkSelection the defines the selection criteria.

vtkSelectionNode helps define the selection criteria in a vtkSelection. vtkSelection can comprise of multiple such vtkSelectionNode instances that help define the selection.

vtkSelectionNode has two components: a list of properties (stored in a vtkInformation) and a selection list (a vtkAbstractArray subclass). The properties help indicate how to interpret the values specified in a selection-list.

The properties can be broadly classified into three categories: core, qualifiers, and information. The core properties must be specified other wise the vtkSelectionNode is not considered valid. These are FIELD_TYPE and CONTENT_TYPE. FIELD_TYPE defines what kinds of entities are being selected. Since selections are used to select items in a data-object, these correspond to things like cells, points, nodes, edges, rows, etc. Supported FIELD_TYPE values are defined in vtkSelectionNode::SelectionField. CONTENT_TYPE defines the how the selection is described. Supported values are vtkSelectionNode::SelectionContent. For example, if CONTENT_TYPE is INDICES, then selection is described as ids for entities being selected. The ids themselves will be specified using the selection list. Thus, the CONTENT_TYPE dictates what the selection list comprises.

Qualifiers are used to further qualify the selection criteria. All qualifiers are optional. When present they restrict the selection. For example, when selecting elements from a composite-dataset, the COMPOSITE_INDEX qualifier can be specified of limit the selection to a specific dataset (or subtree).

Information properties are simply for informative purposes and generally used to provide information about the selection when the selection is created. For example, PIXEL_COUNT is used to indicate how many screen pixels resulted in creation of this selection node.

Selection Types

CONTENT_TYPE property is one of the required properties that helps describe how the selection is defined. To set the content type, one can access the properties store using vtkSelectionNode::GetProperties() and then set the CONTENT_TYPE using the vtkSelectionNode::CONTENT_TYPE() key or simply use vtkSelectionNode::SetContentType.

vtkSelectionNode::GLOBALIDS: indicates that the selection is defined using global ids. In VTK data-object, global ids are specified an vtkIdTypeArray added to a appropriate vtkDataSetAttributes and marked as global-ids using vtkDataSetAttributes API. Since global ids are expected to be unique for that element type over the entire dataset, it's a convenient way of defining selections. For this content-type, the selection list must be a single-component, vtkIdTypeArray that lists all the globals ids for the selected elements.
vtkSelectionNode::PEDIGREEIDS: similar to GLOBALIDS except uses pedigree ids instead of global ids.
vtkSelectionNode::VALUES: this type is used to define a selection based on array values. The selection list specifies the values to be selected. All elements with array values in the selection list are treated as selected. The qualifier COMPONENT_NUMBER is used to indicate which component to use for the checks. Use -1 for magnitude. Current implementation does not support checking multiple-components or non-exact matches although support for both is conceivable in future. The selection list array name is used to specify the name of the array from the dataset to use for the checks. Thus, for defining a selection for a dataset where all TEMP values match those specified in the selection list, ensure that the selection list array's name is set to TEMP as well.
vtkSelectionNode::INDICES: this is similar to global ids except in this case the selection list is simply the VTK element id which is 0-based index of that element in the particular dataset. Often with this type of selection, additional qualifiers such as COMPOSITE_INDEX, BLOCK_SELECTORS, PROCESS_ID etc. are needed to correctly identify the chosen element(s) in case of composite or distributed datasets.
vtkSelectionNode::FRUSTUM: this type is used to define a frustum in world coordinates that identifies the selected elements. In this case, the selection list is a vtkDoubleArray with 32 values specifying the 8 frustum corners in homogeneous world coordinates.
vtkSelectionNode::LOCATIONS: this is used to select points (or cells) near (or containing) specified locations. The selection list is a 3-component vtkDoubleArray with coordinates for locations of interest.
vtkSelectionNode::THRESHOLDS: this type is used to define a selection based on array value ranges. This is akin to thresholding. All elements with values in the specified ranges are to be treated as selected. For this content-type, the selection-list is a 2-component vtkDataArray-subclass that specifies where each tuple defines the min and max values for a range. The selection list can have multiple tuples to define multiple ranges. Elements with values in any of the specified ranges are treated as selected. The selection list array name is used to specify the name of the array from the dataset to use for the checks. Thus, for defining a selection for a dataset where all TEMP values are within a range, ensure that the selection list array's name is set to TEMP as well.
vtkSelectionNode::BLOCKS: this type is used to select blocks in a composite dataset. The term blocks is used loosely here and can correspond to a block in a multiblock dataset or a partition in a partitioned-dataset. The selection list is an integral type vtkDataArray subclass that can be 1- or 2- component. If 1-component, it's interpreted as the composite-index (also called flat index) and can be applied to any composite-dataset to choose specific datasets. If 2-component, it's typically associated with vtkUniformGridAMR or vtkPartitionedDataSetCollection which support 2-tuple indexing to locate a dataset.
vtkSelectionNode::BLOCK_SELECTORS: this is similar to BLOCKS, however instead of using indices to select datasets, here, the selection list is a vtkStringArray which lists selector expressions to select blocks in the composite dataset. By default, the selector expressions are applied to a vtkDataAssembly generated from the composite dataset that represents its hierarchy (see vtkDataAssembly::GenerateHierarchy). However, in case of vtkPartitionedDataSetCollection, one can select any other data assembly associated with the vtkPartitionedDataSetCollection by naming the array with the name of the assembly.

Note
, currently vtkPartitionedDataSetCollection only supports a single vtkDataAssembly but this may change in the future.
vtkSelectionNode::QUERY: this type is primarily added for ParaView where selection expression is specified as a query string. This is likely to change in the future and hence applications are discouraged from using this type.

Properties

Following a properties that can be used to qualify the selection.

vtkSelectionNode::EPSILON(): this is a qualifier that can be used to indicate a fuzz-factor when comparing values for equality. Currently, this is only used with content-type LOCATIONS, however, it can be expanded to other selection types in the future.
vtkSelectionNode::CONTAINING_CELLS(): this qualifier is intended to be used with field-type POINT. When present, it indicates that while the selection criteria selects a collection of points the selection should be formed using cell containing the chosen points.
vtkSelectionNode::CONNECTED_LAYERS(): a qualifier used to expand the definition of selected elements to connected elements for the specified number of layers. Layers can only be positive to grow the selection.
vtkSelectionNode::CONNECTED_LAYERS_REMOVE_SEED(): this qualifier indicates that when using a number of CONNECTED_LAYERS >= 1, the initial selection will not be kept.
vtkSelectionNode::CONNECTED_LAYERS_REMOVE_INTERMEDIATE_LAYERS(): this qualifier indicates that when using a number of CONNECTED_LAYERS >= 2, the intermediate layers will not be kept.
vtkSelectionNode::INVERSE(): a qualifier that causes the selection to be inverted i.e. all elements not chosen by the criteria are to be treated as selected.
vtkSelectionNode::COMPONENT_NUMBER(): for VALUES and THRESHOLDS selection types, this qualifier identifies the array component of interest. -1 indicates magnitude.
vtkSelectionNode::PROCESS_ID(): limits the selection to a particular rank in a distributed environment.
vtkSelectionNode::COMPOSITE_INDEX(): a qualifier used to limit the selection to a specific composite index for a composite-dataset.
vtkSelectionNode::ASSEMBLY_NAME(), vtkSelectionNode::SELECTORS(): similar to composite index, except uses data-assembly and selectors to limit the selection to a subset of nodes in a composite-dataset.
vtkSelectionNode::HIERARCHICAL_LEVEL(), vtkSelectionNode::HIERARCHICAL_INDEX(): similar to composite index, except uses level and index for an AMR dataset so limit the selection to a specific AMR level or dataset.

Following for properties that are primarily intended to provide additional information when the selection is created.

vtkSelectionNode::ZBUFFER_VALUE(): an information qualifier representing the z-depth for a particular selection when it was created.
vtkSelectionNode::PIXEL_COUNT(): a qualifier used to provide a count for the number of pixels that resulted in this selection.
vtkSelectionNode::SOURCE(), vtkSelectionNode::SOURCE_ID(): provides information about data producer or selection originator. The interpretation is very specific to the creator creating the selection and varies greatly with VTK.
vtkSelectionNode::PROP(),vtkSelectionNode::PROP_ID()`: similar to SOURCE/SOURCE_ID except is used to represent a rendering prop from which the selection was created.

Warning: No SelectionList is created by default. It should be assigned.

vtkSelectionNode::SelectionField and

vtkDataSetAttribute::AttributeTypes

Strictly speaking, vtkSelectionNode::SelectionField maps directly to vtkDataSetAttribute::AttributeTypes. However, the two enum values are not identical for historical reasons. Use vtkSelectionNode::ConvertSelectionFieldToAttributeType and vtkSelectionNode::ConvertAttributeTypeToSelectionField to convert between the two.

Examples:: vtkSelectionNode (Examples)

Online Examples:

SelectionSource

SelectedVerticesAndEdges

ExtractSelectionOriginalId

ExtractSelectionUsingCells

ExtractSelectionUsingPoints

MergeSelections

Tests:: vtkSelectionNode (Tests)

Definition at line 341 of file vtkSelectionNode.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkSelectionNode::Superclass

Definition at line 344 of file vtkSelectionNode.h.

Member Enumeration Documentation

◆ SelectionContent

enum vtkSelectionNode::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 411 of file vtkSelectionNode.h.

◆ SelectionField

enum vtkSelectionNode::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 451 of file vtkSelectionNode.h.

Constructor & Destructor Documentation

◆ vtkSelectionNode()

vtkSelectionNode::vtkSelectionNode ( )

protected

◆ ~vtkSelectionNode()

vtkSelectionNode::~vtkSelectionNode ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkSelectionNode::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkSelectionNode::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 vtkObjectBase.

◆ SafeDownCast()

static vtkSelectionNode * vtkSelectionNode::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkSelectionNode::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkSelectionNode * vtkSelectionNode::NewInstance ( ) const

◆ PrintSelf()

void vtkSelectionNode::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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 vtkObject.

◆ New()

static vtkSelectionNode * vtkSelectionNode::New ( )

static

◆ Initialize()

virtual void vtkSelectionNode::Initialize ( )

virtual

Restore data object to initial state,.

◆ SetSelectionList()

virtual void vtkSelectionNode::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 * vtkSelectionNode::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 vtkSelectionNode::SetSelectionData ( vtkDataSetAttributes * data )

virtual

Sets the selection table.

◆ GetSelectionData()

virtual vtkDataSetAttributes * vtkSelectionNode::GetSelectionData ( )

virtual

Sets the selection table.

◆ GetProperties()

virtual vtkInformation * vtkSelectionNode::GetProperties ( )

virtual

Returns the property map.

◆ DeepCopy()

virtual void vtkSelectionNode::DeepCopy ( vtkSelectionNode * src )

virtual

Copy properties, selection list and children of the input.

◆ ShallowCopy()

virtual void vtkSelectionNode::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 vtkSelectionNode::GetMTime ( )

overridevirtual

Return the MTime taking into account changes to the properties.

Reimplemented from vtkObject.

◆ SetContentType()

virtual void vtkSelectionNode::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.

◆ GetContentType()

virtual int vtkSelectionNode::GetContentType ( )

virtual

Get or set the content type of the selection.

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

◆ GetContentTypeAsString()

static const char * vtkSelectionNode::GetContentTypeAsString ( int type )

static

Get the content type as a string.

◆ SetFieldType()

virtual void vtkSelectionNode::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 vtkSelectionNode::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()

static const char * vtkSelectionNode::GetFieldTypeAsString ( int type )

static

Get the field type as a string.

◆ GetFieldTypeFromString()

static int vtkSelectionNode::GetFieldTypeFromString ( const char * type )

static

Get field type from string.

Returns NUM_FIELD_TYPES if not found.

◆ ConvertSelectionFieldToAttributeType()

static int vtkSelectionNode::ConvertSelectionFieldToAttributeType ( int val )

static

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

◆ ConvertAttributeTypeToSelectionField()

static int vtkSelectionNode::ConvertAttributeTypeToSelectionField ( int val )

static

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

◆ SetQueryString()

virtual void vtkSelectionNode::SetQueryString ( const char * )

virtual

Set/Get the query expression string.

◆ GetQueryString()

virtual char * vtkSelectionNode::GetQueryString ( )

virtual

Set/Get the query expression string.

◆ CELLGRID_CELL_TYPE_INDEX()

static vtkInformationIntegerKey * vtkSelectionNode::CELLGRID_CELL_TYPE_INDEX ( )

static

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

CELLGRID_CELL_TYPE_INDEX is an offset into vtkCellGrid::GetCellTypesArray()
For cell spec, CELLGRID_SOURCE_SPECIFICATION_INDEX will be 0,
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()

static vtkInformationIntegerKey * vtkSelectionNode::CELLGRID_SOURCE_SPECIFICATION_INDEX ( )

static

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

CELLGRID_CELL_TYPE_INDEX is an offset into vtkCellGrid::GetCellTypesArray()
For cell spec, CELLGRID_SOURCE_SPECIFICATION_INDEX will be 0,
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 vtkSelectionNode::UnionSelectionList ( vtkSelectionNode * other )

Merges the selection list between self and the other.

Assumes that both has identical properties.

◆ SubtractSelectionList()

void vtkSelectionNode::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 vtkSelectionNode::EqualProperties	(	vtkSelectionNode *	other,
		bool	fullcompare = `true`
	)

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

Member Data Documentation

◆ Properties

vtkInformation* vtkSelectionNode::Properties

protected

Definition at line 659 of file vtkSelectionNode.h.

◆ SelectionData

vtkDataSetAttributes* vtkSelectionNode::SelectionData

protected

Definition at line 660 of file vtkSelectionNode.h.

◆ QueryString

char* vtkSelectionNode::QueryString

protected

Definition at line 661 of file vtkSelectionNode.h.

◆ ContentTypeNames

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

staticprotected

Definition at line 664 of file vtkSelectionNode.h.

◆ FieldTypeNames

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

staticprotected

Definition at line 667 of file vtkSelectionNode.h.

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

Common/DataModel/vtkSelectionNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Selection Types

Properties

vtkSelectionNode::SelectionField and

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ SelectionContent

◆ SelectionField

Constructor & Destructor Documentation

◆ vtkSelectionNode()

◆ ~vtkSelectionNode()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ Initialize()

◆ SetSelectionList()

◆ GetSelectionList()

◆ SetSelectionData()

◆ GetSelectionData()

◆ GetProperties()

◆ DeepCopy()

◆ ShallowCopy()

◆ GetMTime()

◆ SetContentType()

◆ GetContentType()

◆ GetContentTypeAsString()

◆ SetFieldType()

◆ GetFieldType()

◆ GetFieldTypeAsString()

◆ GetFieldTypeFromString()

◆ ConvertSelectionFieldToAttributeType()

◆ ConvertAttributeTypeToSelectionField()

◆ SetQueryString()

◆ GetQueryString()

◆ CELLGRID_CELL_TYPE_INDEX()

◆ CELLGRID_SOURCE_SPECIFICATION_INDEX()

◆ UnionSelectionList()

◆ SubtractSelectionList()

◆ EqualProperties()

Member Data Documentation

◆ Properties

◆ SelectionData

◆ QueryString

◆ ContentTypeNames

◆ FieldTypeNames