VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkSelection Class Reference

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

#include <vtkSelection.h>

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

Public Types

typedef vtkDataObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Initialize ()
 
virtual int GetDataObjectType ()
 
unsigned int GetNumberOfNodes ()
 
virtual vtkSelectionNode * GetNode (unsigned int idx)
 
virtual void AddNode (vtkSelectionNode *)
 
virtual void DeepCopy (vtkDataObject *src)
 
virtual void ShallowCopy (vtkDataObject *src)
 
virtual void Union (vtkSelection *selection)
 
virtual void Union (vtkSelectionNode *node)
 
unsigned long GetMTime ()
 
virtual void RemoveNode (unsigned int idx)
 
virtual void RemoveNode (vtkSelectionNode *)
 
virtual void RemoveAllNodes ()
 
virtual void Dump ()
 
virtual void Dump (ostream &os)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkSelectionSafeDownCast (vtkObject *o)
 
static vtkSelectionNew ()
 
static vtkSelectionGetData (vtkInformation *info)
 
static vtkSelectionGetData (vtkInformationVector *v, int i=0)
 

Protected Member Functions

 vtkSelection ()
 
 ~vtkSelection ()
 

Detailed Description

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

vtkSelection is a collection of vtkSelectionNode objects, each of which contains information about a piece of the whole selection. Each selection node may contain different types of selections.

See Also
vtkSelectionNode
Examples:
vtkSelection (Examples)
Tests:
vtkSelection (Tests)

Definition at line 43 of file vtkSelection.h.

Member Typedef Documentation

Definition at line 46 of file vtkSelection.h.

Constructor & Destructor Documentation

vtkSelection::vtkSelection ( )
protected
vtkSelection::~vtkSelection ( )
protected

Member Function Documentation

virtual const char* vtkSelection::GetClassName ( )
virtual
static int vtkSelection::IsTypeOf ( const char *  type)
static
virtual int vtkSelection::IsA ( const char *  type)
virtual
static vtkSelection* vtkSelection::SafeDownCast ( vtkObject o)
static
void vtkSelection::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkSelection* vtkSelection::New ( )
static
virtual void vtkSelection::Initialize ( )
virtual

Restore data object to initial state,

virtual int vtkSelection::GetDataObjectType ( )
inlinevirtual

Returns VTK_SELECTION enumeration value.

Definition at line 54 of file vtkSelection.h.

unsigned int vtkSelection::GetNumberOfNodes ( )

Returns the number of nodes in this selection. Each node contains information about part of the selection.

virtual vtkSelectionNode* vtkSelection::GetNode ( unsigned int  idx)
virtual

Returns a node given it's index. Performs bound checking and will return 0 if out-of-bounds.

virtual void vtkSelection::AddNode ( vtkSelectionNode *  )
virtual

Adds a selection node.

virtual void vtkSelection::RemoveNode ( unsigned int  idx)
virtual

Removes a selection node.

virtual void vtkSelection::RemoveNode ( vtkSelectionNode *  )
virtual

Removes a selection node.

virtual void vtkSelection::RemoveAllNodes ( )
virtual

Removes a selection node.

virtual void vtkSelection::DeepCopy ( vtkDataObject src)
virtual

Copy selection nodes of the input.

virtual void vtkSelection::ShallowCopy ( vtkDataObject src)
virtual

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

virtual void vtkSelection::Union ( vtkSelection selection)
virtual

Union this selection with the specified selection. Attempts to reuse selection nodes in this selection if properties match exactly. Otherwise, creates new selection nodes.

virtual void vtkSelection::Union ( vtkSelectionNode *  node)
virtual

Union this selection with the specified selection node. Attempts to reuse a selection node in this selection if properties match exactly. Otherwise, creates a new selection node.

unsigned long vtkSelection::GetMTime ( )

Return the MTime taking into account changes to the properties

virtual void vtkSelection::Dump ( )
virtual

Dumps the contents of the selection, giving basic information only.

virtual void vtkSelection::Dump ( ostream &  os)
virtual

Dumps the contents of the selection, giving basic information only.

static vtkSelection* vtkSelection::GetData ( vtkInformation info)
static

Retrieve a vtkSelection stored inside an invormation object.

static vtkSelection* vtkSelection::GetData ( vtkInformationVector v,
int  i = 0 
)
static

Retrieve a vtkSelection stored inside an invormation object.


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