VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 Types inherited from vtkDataObject
typedef vtkObject Superclass
 
enum  FieldAssociations {
  FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS,
  FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS
}
 
enum  AttributeTypes {
  POINT, CELL, FIELD, POINT_THEN_CELL,
  VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES
}
 
enum  FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkSelectionNewInstance () const
 
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)
 
- Public Member Functions inherited from vtkDataObject
vtkDataObjectNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
unsigned long int GetMTime ()
 
void ReleaseData ()
 
unsigned long GetUpdateTime ()
 
virtual unsigned long GetActualMemorySize ()
 
void DataHasBeenGenerated ()
 
virtual void PrepareForNewData ()
 
virtual int GetExtentType ()
 
virtual void Crop (const int *updateExtent)
 
virtual vtkDataSetAttributes * GetAttributes (int type)
 
virtual vtkFieldData * GetAttributesAsFieldData (int type)
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 
virtual vtkIdType GetNumberOfElements (int type)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual int GetDataReleased ()
 
virtual void SetFieldData (vtkFieldData *)
 
virtual vtkFieldData * GetFieldData ()
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkSelectionSafeDownCast (vtkObjectBase *o)
 
static vtkSelectionNew ()
 
static vtkSelectionGetData (vtkInformation *info)
 
static vtkSelectionGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static const char * GetAssociationTypeAsString (int associationType)
 
static int GetAssociationTypeFromString (const char *associationType)
 
static vtkInformationStringKey * DATA_TYPE_NAME ()
 
static
vtkInformationDataObjectKey * 
DATA_OBJECT ()
 
static vtkInformationIntegerKey * DATA_EXTENT_TYPE ()
 
static
vtkInformationIntegerPointerKey * 
DATA_EXTENT ()
 
static vtkInformationIntegerKey * DATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKey * DATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKey * DATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKey * DATA_RESOLUTION ()
 
static vtkInformationDoubleKey * DATA_TIME_STEP ()
 
static
vtkInformationInformationVectorKey * 
POINT_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey * 
CELL_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey * 
VERTEX_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey * 
EDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKey * FIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKey * FIELD_ASSOCIATION ()
 
static vtkInformationIntegerKey * FIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKey * FIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKey * FIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKey * FIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKey * FIELD_OPERATION ()
 
static
vtkInformationDoubleVectorKey * 
FIELD_RANGE ()
 
static
vtkInformationDoubleVectorKey * 
PIECE_FIELD_RANGE ()
 
static vtkInformationStringKey * FIELD_ARRAY_NAME ()
 
static
vtkInformationIntegerVectorKey * 
PIECE_EXTENT ()
 
static vtkInformationStringKey * FIELD_NAME ()
 
static
vtkInformationDoubleVectorKey * 
ORIGIN ()
 
static
vtkInformationDoubleVectorKey * 
SPACING ()
 
static vtkInformationIntegerKey * DATA_GEOMETRY_UNMODIFIED ()
 
static
vtkInformationDoubleVectorKey * 
BOUNDING_BOX ()
 
static
vtkInformationDataObjectKey * 
SIL ()
 
static vtkInformation * GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
 
static vtkInformation * GetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static vtkInformation * SetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
 
static void SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 
static vtkDataObjectGetData (vtkInformation *info)
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 
static void SetGlobalReleaseDataFlag (int val)
 
static int GetGlobalReleaseDataFlag ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkSelection ()
 
 ~vtkSelection ()
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject ()
 

Additional Inherited Members

- Protected Attributes inherited from vtkDataObject
vtkFieldData * FieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformation * Information
 

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 44 of file vtkSelection.h.

Member Typedef Documentation

Definition at line 47 of file vtkSelection.h.

Constructor & Destructor Documentation

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

Member Function Documentation

static int vtkSelection::IsTypeOf ( const char *  type)
static
virtual int vtkSelection::IsA ( const char *  type)
virtual

Reimplemented from vtkDataObject.

static vtkSelection* vtkSelection::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkSelection::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataObject.

vtkSelection* vtkSelection::NewInstance ( ) const
void vtkSelection::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkSelection* vtkSelection::New ( )
static
virtual void vtkSelection::Initialize ( )
virtual

Restore data object to initial state,

Reimplemented from vtkDataObject.

virtual int vtkSelection::GetDataObjectType ( )
inlinevirtual

Returns VTK_SELECTION enumeration value.

Reimplemented from vtkDataObject.

Definition at line 55 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 ( )

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: