|
| 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.
|
| |
| | 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) |
| |
| int | InvokeEvent (unsigned long event) |
| |
| int | InvokeEvent (const char *event) |
| |
| 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.
|
| |
| int | InvokeEvent (unsigned long event, void *callData) |
| | This method invokes an event and return whether the event was aborted or not.
|
| |
| int | InvokeEvent (const char *event, void *callData) |
| | This method invokes an event and return whether the event was aborted or not.
|
| |
| const char * | GetClassName () const |
| | Return the class name as a string.
|
| |
| 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.
|
| |
| virtual 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.
|
| |
|
| 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 * | 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 vtkInformationIntegerKey * | INDEXED_VERTICES () |
| |
|
| 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 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 (int 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 int | GetGlobalWarningDisplay () |
| | This is a global flag that controls whether any debug, warning or error messages are displayed.
|
| |
| 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.
|
| |
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 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 to 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.- `vtkSelectionNodeFRUSTUM: 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-compnent 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.
Following for properties that are primarily intended to provide additional information when the selection is 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.
- Online Examples:
Definition at line 340 of file vtkSelectionNode.h.
Public Member Functions inherited from vtkObject
1.9.6
