VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkSelectionNode Class Reference

A node in a selection tree. Used to store selection results. More...

#include <vtkSelectionNode.h>

Inheritance diagram for vtkSelectionNode:
[legend]
Collaboration diagram for vtkSelectionNode:
[legend]

List of all members.

Public Types

typedef vtkObject Superclass
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Initialize ()
virtual void DeepCopy (vtkSelectionNode *src)
virtual void ShallowCopy (vtkSelectionNode *src)
unsigned long GetMTime ()
void UnionSelectionList (vtkSelectionNode *other)
bool EqualProperties (vtkSelectionNode *other, bool fullcompare=true)
virtual void SetSelectionList (vtkAbstractArray *)
virtual vtkAbstractArrayGetSelectionList ()
virtual void SetSelectionData (vtkDataSetAttributes *data)
virtual vtkDataSetAttributesGetSelectionData ()
virtual vtkInformationGetProperties ()
virtual void SetContentType (int type)
virtual int GetContentType ()
virtual void SetFieldType (int type)
virtual int GetFieldType ()
virtual void SetSelectedProp (vtkProp *prop)
virtual vtkPropGetSelectedProp ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkSelectionNodeSafeDownCast (vtkObject *o)
static vtkSelectionNodeNew ()
static vtkInformationDoubleKeyEPSILON ()
static vtkInformationIntegerKeyCONTAINING_CELLS ()
static vtkInformationIntegerKeyCOMPONENT_NUMBER ()
static vtkInformationIntegerKeyINVERSE ()
static vtkInformationIntegerKeyPIXEL_COUNT ()
static
vtkInformationObjectBaseKey
SOURCE ()
static vtkInformationIntegerKeySOURCE_ID ()
static
vtkInformationObjectBaseKey
PROP ()
static vtkInformationIntegerKeyPROP_ID ()
static vtkInformationIntegerKeyPROCESS_ID ()
static vtkInformationIntegerKeyCOMPOSITE_INDEX ()
static vtkInformationIntegerKeyINDEXED_VERTICES ()
static vtkInformationIntegerKeyHIERARCHICAL_LEVEL ()
static vtkInformationIntegerKeyHIERARCHICAL_INDEX ()
- Static Public Member Functions inherited from vtkObject
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

Protected Member Functions

 vtkSelectionNode ()
 ~vtkSelectionNode ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkInformationProperties
vtkDataSetAttributesSelectionData
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers
enum  SelectionContent {
  SELECTIONS, GLOBALIDS, PEDIGREEIDS, VALUES,
  INDICES, FRUSTUM, LOCATIONS, THRESHOLDS,
  BLOCKS
}
static vtkInformationIntegerKeyCONTENT_TYPE ()
enum  SelectionField {
  CELL, POINT, FIELD, VERTEX,
  EDGE, ROW
}
static vtkInformationIntegerKeyFIELD_TYPE ()

Detailed Description

A node in a selection tree. Used to store selection results.

vtkSelectionNode stores selection parameters for a selection (or part of a selection). It stores a list of properties (in a vtkInformation) and a list of selection values (in a vtkAbstractArray). The properties provide information about what the selection values mean. For example the CONTENT_TYPE property gives information about what is stored by the node. If the CONTENT_TYPE is GLOBALIDS, the SelectionList array should contain a list of cell or point ids, which identify the particular cells or points that have matching values in the GLOBALID vtkDataSetAttribute array. If the CONTENT_TYPE is PEDIGREEIDS, the SelectionList array should contain a list of cell or point ids, which identify the particular cells or points that have matching values in the PEDIGREEID vtkDataSetAttribute array. The FIELD_TYPE property designates whether the selection refers to cells or points.

Usually, each node under the root is a selection from one data object. SOURCE or SOURCE_ID properties point to this object. If the selection was performed on a renderer, PROP or PROP_ID point to the prop the selection was made on. Selection nodes corresponding to composite datasets may contain child nodes. Each child node of a composite dataset should have COMPOSITE_INDEX set. This is the flat-index to identify a node with in the composite dataset to which the selection applies.

Warning:
No SelectionList is created by default. It should be assigned.
Examples:
vtkSelectionNode (Examples)
Tests:
vtkSelectionNode (Tests)

Definition at line 67 of file vtkSelectionNode.h.


Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 70 of file vtkSelectionNode.h.


Member Enumeration Documentation

Get the (primary) property that describes the content of a selection node's data. Other auxiliary description properties follow. GLOBALIDS means that the selection list contains values from the vtkDataSetAttribute array of the same name. PEDIGREEIDS means that the selection list contains values from the vtkDataSetAttribute array of the same name. VALUES means the the selection list contains values from an arbitrary attribute array (ignores any globalids attribute) INDICES means that the selection list contains indexes into the cell or point arrays. FRUSTUM means the set of points and cells inside a frustum LOCATIONS means the set of points and cells near a set of positions THRESHOLDS means the points and cells with values within a set of ranges GetContentType() returns -1 if the content type is not set.

Enumerator:
SELECTIONS 
GLOBALIDS 
PEDIGREEIDS 
VALUES 
INDICES 
FRUSTUM 
LOCATIONS 
THRESHOLDS 
BLOCKS 

Definition at line 122 of file vtkSelectionNode.h.

Controls whether cell, point, or field data determine what is inside and out. The default is CELL. Vertex and edge types are also available for graph classes. GetFieldType() returns -1 if the field type is not set.

Enumerator:
CELL 
POINT 
FIELD 
VERTEX 
EDGE 
ROW 

Definition at line 151 of file vtkSelectionNode.h.


Constructor & Destructor Documentation

vtkSelectionNode::vtkSelectionNode ( )
protected
vtkSelectionNode::~vtkSelectionNode ( )
protected

Member Function Documentation

virtual const char* vtkSelectionNode::GetClassName ( )
virtual

Reimplemented from vtkObject.

static int vtkSelectionNode::IsTypeOf ( const char *  name)
static

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

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

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

Reimplemented from vtkObject.

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

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

static vtkSelectionNode* vtkSelectionNode::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual void vtkSelectionNode::Initialize ( )
virtual

Restore data object to initial state,

virtual void vtkSelectionNode::SetSelectionList ( vtkAbstractArray )
virtual

Sets the selection list.

virtual vtkAbstractArray* vtkSelectionNode::GetSelectionList ( )
virtual

Sets the selection list.

virtual void vtkSelectionNode::SetSelectionData ( vtkDataSetAttributes data)
virtual

Sets the selection table.

virtual vtkDataSetAttributes* vtkSelectionNode::GetSelectionData ( )
virtual

Sets the selection table.

virtual vtkInformation* vtkSelectionNode::GetProperties ( )
virtual

Returns the property map.

virtual void vtkSelectionNode::DeepCopy ( vtkSelectionNode src)
virtual

Copy properties, selection list and children of the input.

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.

unsigned long vtkSelectionNode::GetMTime ( )
virtual

Return the MTime taking into account changes to the properties

Reimplemented from vtkObject.

static vtkInformationIntegerKey* vtkSelectionNode::CONTENT_TYPE ( )
static

Get the (primary) property that describes the content of a selection node's data. Other auxiliary description properties follow. GLOBALIDS means that the selection list contains values from the vtkDataSetAttribute array of the same name. PEDIGREEIDS means that the selection list contains values from the vtkDataSetAttribute array of the same name. VALUES means the the selection list contains values from an arbitrary attribute array (ignores any globalids attribute) INDICES means that the selection list contains indexes into the cell or point arrays. FRUSTUM means the set of points and cells inside a frustum LOCATIONS means the set of points and cells near a set of positions THRESHOLDS means the points and cells with values within a set of ranges GetContentType() returns -1 if the content type is not set.

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.

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.

static vtkInformationIntegerKey* vtkSelectionNode::FIELD_TYPE ( )
static

Controls whether cell, point, or field data determine what is inside and out. The default is CELL. Vertex and edge types are also available for graph classes. GetFieldType() returns -1 if the field type is not set.

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.

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.

virtual void vtkSelectionNode::SetSelectedProp ( vtkProp prop)
virtual

Get or set the prop of the selection. This is the same as setting the PROP() key on the property.

virtual vtkProp* vtkSelectionNode::GetSelectedProp ( )
virtual

Get or set the prop of the selection. This is the same as setting the PROP() key on the property.

static vtkInformationDoubleKey* vtkSelectionNode::EPSILON ( )
static

For location selection of points, if distance is greater than this reject.

static vtkInformationIntegerKey* vtkSelectionNode::CONTAINING_CELLS ( )
static

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* vtkSelectionNode::COMPONENT_NUMBER ( )
static

When ContentType==THRESHOLDS or ContentType==VALUES i.e. threshold and value based selections, it is possible pick the component number using this key. If none is specified, the 0th component is used. If any number less than 0 is specified, then the magnitude is used.

static vtkInformationIntegerKey* vtkSelectionNode::INVERSE ( )
static

This flag tells the extraction filter to exclude the selection.

static vtkInformationIntegerKey* vtkSelectionNode::PIXEL_COUNT ( )
static

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* vtkSelectionNode::SOURCE ( )
static

Pointer to the data or algorithm the selection belongs to.

static vtkInformationIntegerKey* vtkSelectionNode::SOURCE_ID ( )
static

ID of the data or algorithm the selection belongs to. What ID means is application specific.

static vtkInformationObjectBaseKey* vtkSelectionNode::PROP ( )
static

Pointer to the prop the selection belongs to.

static vtkInformationIntegerKey* vtkSelectionNode::PROP_ID ( )
static

ID of the prop the selection belongs to. What ID means is application specific.

static vtkInformationIntegerKey* vtkSelectionNode::PROCESS_ID ( )
static

Process id the selection is on.

static vtkInformationIntegerKey* vtkSelectionNode::COMPOSITE_INDEX ( )
static

Used to identify a node in composite datasets.

static vtkInformationIntegerKey* vtkSelectionNode::HIERARCHICAL_LEVEL ( )
static

Used to identify a dataset in a hiererchical box dataset.

static vtkInformationIntegerKey* vtkSelectionNode::HIERARCHICAL_INDEX ( )
static

Used to identify a dataset in a hiererchical box dataset.

static vtkInformationIntegerKey* vtkSelectionNode::INDEXED_VERTICES ( )
static

This key is used when making visible vertex selection. It means that the cell ID selection has data about which vertices for each cell are visible.

void vtkSelectionNode::UnionSelectionList ( vtkSelectionNode other)

Merges the selection list between self and the other. Assumes that both has identical properties.

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

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


Member Data Documentation

vtkInformation* vtkSelectionNode::Properties
protected

Definition at line 243 of file vtkSelectionNode.h.

vtkDataSetAttributes* vtkSelectionNode::SelectionData
protected

Definition at line 244 of file vtkSelectionNode.h.


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