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 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 Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkSelection * NewInstance () const
 
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)
 
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
vtkDataObject * NewInstance () const
 
void ReleaseData ()
 
unsigned long GetUpdateTime ()
 
virtual unsigned long GetActualMemorySize ()
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
 
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 ()
 
- Public Member Functions inherited from vtkObject
vtkObject * NewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool 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)
 
vtkCommand * GetCommand (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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(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 &)
 
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 vtkSelection * SafeDownCast (vtkObjectBase *o)
 
static vtkSelection * New ()
 
static vtkSelection * GetData (vtkInformation *info)
 
static vtkSelection * GetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObject * New ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObject * SafeDownCast (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 vtkInformationIntegerVectorKey * ALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKey * DATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKey * DATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKey * DATA_NUMBER_OF_GHOST_LEVELS ()
 
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 vtkInformationIntegerVectorKey * PIECE_EXTENT ()
 
static vtkInformationStringKey * FIELD_NAME ()
 
static vtkInformationDoubleVectorKey * ORIGIN ()
 
static vtkInformationDoubleVectorKey * SPACING ()
 
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 vtkDataObject * GetData (vtkInformation *info)
 
static vtkDataObject * GetData (vtkInformationVector *v, int i=0)
 
static void SetGlobalReleaseDataFlag (int val)
 
static int GetGlobalReleaseDataFlag ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObject * SafeDownCast (vtkObjectBase *o)
 
static vtkObject * New ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBase * New ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkSelection ()
 
 ~vtkSelection ()
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject ()
 
- 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 &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkDataObject
vtkFieldData * FieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformation * Information
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

typedef vtkDataObject vtkSelection::Superclass

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 *  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 ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkSelection::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataObject.

vtkSelection* vtkSelection::NewInstance ( ) const
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
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 ( )
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.

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:
Generated on Wed Dec 16 2015 17:19:33 for VTK by   doxygen 1.8.9.1