VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkSelection Class Reference

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

#include <vtkSelection.h>

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

List of all members.

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 vtkSelectionNodeGetNode (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)
virtual void Subtract (vtkSelection *selection)
virtual void Subtract (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

Reimplemented from vtkDataObject.

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]

Reimplemented from vtkDataObject.

static int vtkSelection::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 vtkDataObject.

virtual int vtkSelection::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 vtkDataObject.

static vtkSelection* vtkSelection::SafeDownCast ( vtkObject o) [static]

Reimplemented from vtkDataObject.

void vtkSelection::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 vtkDataObject.

static vtkSelection* vtkSelection::New ( ) [static]

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

Reimplemented from vtkDataObject.

virtual void vtkSelection::Initialize ( ) [virtual]

Restore data object to initial state,

Reimplemented from vtkDataObject.

virtual int vtkSelection::GetDataObjectType ( ) [inline, virtual]

Returns VTK_SELECTION enumeration value.

Reimplemented from vtkDataObject.

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.

Reimplemented from vtkDataObject.

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.

Reimplemented from vtkDataObject.

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.

virtual void vtkSelection::Subtract ( vtkSelection selection) [virtual]

Remove the nodes from the specified selection from this selection. Assumes that selection node internal arrays are vtkIdTypeArrays.

virtual void vtkSelection::Subtract ( vtkSelectionNode node) [virtual]

Remove the nodes from the specified selection from this selection. Assumes that selection node internal arrays are vtkIdTypeArrays.

unsigned long vtkSelection::GetMTime ( ) [virtual]

Return the MTime taking into account changes to the properties

Reimplemented from vtkDataObject.

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.

Reimplemented from vtkDataObject.

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

Retrieve a vtkSelection stored inside an invormation object.

Reimplemented from vtkDataObject.


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