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:
[legend]
Collaboration diagram for vtkSelection:
[legend]

List of all members.

Public Types

typedef vtkDataObject Superclass
- Public Types inherited from vtkDataObject
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

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)
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
virtual vtkAlgorithmOutputGetProducerPort ()
void ReleaseData ()
int ShouldIReleaseData ()
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void Update ()
virtual void UpdateInformation ()
virtual void PropagateUpdateExtent ()
virtual void TriggerAsynchronousUpdate ()
virtual void UpdateData ()
virtual unsigned long GetEstimatedMemorySize ()
unsigned long GetUpdateTime ()
void SetUpdateExtentToWholeExtent ()
unsigned long GetPipelineMTime ()
virtual unsigned long GetActualMemorySize ()
void CopyInformation (vtkDataObject *data)
virtual void CopyInformationFromPipeline (vtkInformation *request)
void DataHasBeenGenerated ()
virtual void PrepareForNewData ()
virtual int GetExtentType ()
virtual void Crop ()
virtual vtkDataSetAttributesGetAttributes (int type)
virtual vtkFieldDataGetAttributesAsFieldData (int type)
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
virtual vtkIdType GetNumberOfElements (int type)
virtual vtkSourceGetSource ()
void SetSource (vtkSource *s)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual vtkInformationGetPipelineInformation ()
virtual void SetPipelineInformation (vtkInformation *)
virtual int GetDataReleased ()
void SetReleaseDataFlag (int)
int GetReleaseDataFlag ()
virtual void ReleaseDataFlagOn ()
virtual void ReleaseDataFlagOff ()
virtual void SetFieldData (vtkFieldData *)
virtual vtkFieldDataGetFieldData ()
virtual void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void SetUpdateExtent (int piece, int numPieces)
virtual void SetUpdateExtent (int x0, int x1, int y0, int y1, int z0, int z1)
virtual void SetUpdateExtent (int extent[6])
virtual int * GetUpdateExtent ()
virtual void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
virtual void GetUpdateExtent (int extent[6])
virtual void CopyTypeSpecificInformation (vtkDataObject *data)
void SetUpdatePiece (int piece)
void SetUpdateNumberOfPieces (int num)
virtual int GetUpdatePiece ()
virtual int GetUpdateNumberOfPieces ()
void SetUpdateGhostLevel (int level)
virtual int GetUpdateGhostLevel ()
virtual void SetRequestExactExtent (int flag)
virtual int GetRequestExactExtent ()
virtual void RequestExactExtentOn ()
virtual void RequestExactExtentOff ()
virtual void SetWholeExtent (int x0, int x1, int y0, int y1, int z0, int z1)
virtual void SetWholeExtent (int extent[6])
virtual int * GetWholeExtent ()
virtual void GetWholeExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
virtual void GetWholeExtent (int extent[6])
virtual void SetWholeBoundingBox (double x0, double x1, double y0, double y1, double z0, double z1)
virtual void SetWholeBoundingBox (double bb[6])
virtual double * GetWholeBoundingBox ()
virtual void GetWholeBoundingBox (double &x0, double &x1, double &y0, double &y1, double &z0, double &z1)
virtual void GetWholeBoundingBox (double extent[6])
virtual void SetMaximumNumberOfPieces (int)
virtual int GetMaximumNumberOfPieces ()
virtual void CopyInformationToPipeline (vtkInformation *request, vtkInformation *input, vtkInformation *output, int forceCopy)
void CopyInformationToPipeline (vtkInformation *request, vtkInformation *input)
void SetExtentTranslator (vtkExtentTranslator *translator)
vtkExtentTranslatorGetExtentTranslator ()
void GlobalReleaseDataFlagOn ()
void GlobalReleaseDataFlagOff ()
- 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)
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 vtkSelectionSafeDownCast (vtkObject *o)
static vtkSelectionNew ()
static vtkSelectionGetData (vtkInformation *info)
static vtkSelectionGetData (vtkInformationVector *v, int i=0)
- Static Public Member Functions inherited from vtkDataObject
static const char * GetAssociationTypeAsString (int associationType)
static vtkInformationStringKeyDATA_TYPE_NAME ()
static
vtkInformationDataObjectKey
DATA_OBJECT ()
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
static
vtkInformationIntegerPointerKey
DATA_EXTENT ()
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
static vtkInformationDoubleKeyDATA_RESOLUTION ()
static
vtkInformationDoubleVectorKey
DATA_TIME_STEPS ()
static
vtkInformationInformationVectorKey
POINT_DATA_VECTOR ()
static
vtkInformationInformationVectorKey
CELL_DATA_VECTOR ()
static
vtkInformationInformationVectorKey
VERTEX_DATA_VECTOR ()
static
vtkInformationInformationVectorKey
EDGE_DATA_VECTOR ()
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
static vtkInformationIntegerKeyFIELD_OPERATION ()
static
vtkInformationDoubleVectorKey
FIELD_RANGE ()
static
vtkInformationDoubleVectorKey
PIECE_FIELD_RANGE ()
static vtkInformationStringKeyFIELD_ARRAY_NAME ()
static
vtkInformationIntegerVectorKey
PIECE_EXTENT ()
static vtkInformationStringKeyFIELD_NAME ()
static
vtkInformationDoubleVectorKey
ORIGIN ()
static
vtkInformationDoubleVectorKey
SPACING ()
static vtkInformationIntegerKeyDATA_GEOMETRY_UNMODIFIED ()
static
vtkInformationDataObjectKey
SIL ()
static vtkInformationGetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
static vtkInformationGetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
static vtkInformationSetActiveAttribute (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 void SetGlobalReleaseDataFlag (int val)
static int GetGlobalReleaseDataFlag ()
- 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

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

Additional Inherited Members

- Protected Types inherited from vtkDataObject
typedef
vtkStreamingDemandDrivenPipeline 
SDDP
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
vtkSourceSource
int DataReleased
vtkTimeStamp UpdateTime
vtkInformationInformation
vtkInformationPipelineInformation
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers
- Static Protected Attributes inherited from vtkDataObject
static const char AssociationNames [NUMBER_OF_ASSOCIATIONS][55]

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 ( )
inlinevirtual

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.

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: