vtkSelectionSource Class Reference

#include <vtkSelectionSource.h>

Inheritance diagram for vtkSelectionSource:

Inheritance graph
[legend]
Collaboration diagram for vtkSelectionSource:

Collaboration graph
[legend]

List of all members.


Detailed Description

Generate selection from given set of ids vtkSelectionSource generates a vtkSelection from a set of (piece id, cell id) pairs. It will only generate the selection values that match UPDATE_PIECE_NUMBER (i.e. piece == UPDATE_PIECE_NUMBER).

Examples:
vtkSelectionSource (Examples)
Tests:
vtkSelectionSource (Tests)

Definition at line 37 of file vtkSelectionSource.h.


Public Types

typedef vtkSelectionAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void AddLocation (double x, double y, double z)
void AddThreshold (double min, double max)
void SetFrustum (double *vertices)
void AddBlock (vtkIdType blockno)
void RemoveAllThresholds ()
void RemoveAllLocations ()
void RemoveAllBlocks ()
void AddID (vtkIdType piece, vtkIdType id)
void AddStringID (vtkIdType piece, const char *id)
void RemoveAllIDs ()
void RemoveAllStringIDs ()
virtual void SetContentType (int)
virtual int GetContentType ()
virtual void SetFieldType (int)
virtual int GetFieldType ()
virtual void SetContainingCells (int)
virtual int GetContainingCells ()
virtual void SetInverse (int)
virtual int GetInverse ()
virtual void SetArrayName (const char *)
virtual char * GetArrayName ()
virtual void SetArrayComponent (int)
virtual int GetArrayComponent ()
virtual void SetCompositeIndex (int)
virtual int GetCompositeIndex ()
virtual void SetHierarchicalLevel (int)
virtual int GetHierarchicalLevel ()
virtual void SetHierarchicalIndex (int)
virtual int GetHierarchicalIndex ()

Static Public Member Functions

static vtkSelectionSourceNew ()
static int IsTypeOf (const char *type)
static vtkSelectionSourceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkSelectionSource ()
 ~vtkSelectionSource ()
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)

Protected Attributes

vtkSelectionSourceInternals * Internal
int ContentType
int FieldType
int ContainingCells
int PreserveTopology
int Inverse
int CompositeIndex
int HierarchicalLevel
int HierarchicalIndex
char * ArrayName
int ArrayComponent

Member Typedef Documentation

Reimplemented from vtkSelectionAlgorithm.

Definition at line 41 of file vtkSelectionSource.h.


Constructor & Destructor Documentation

vtkSelectionSource::vtkSelectionSource (  )  [protected]

vtkSelectionSource::~vtkSelectionSource (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkSelectionAlgorithm.

virtual const char* vtkSelectionSource::GetClassName (  )  [virtual]

Reimplemented from vtkSelectionAlgorithm.

static int vtkSelectionSource::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 vtkSelectionAlgorithm.

virtual int vtkSelectionSource::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 vtkSelectionAlgorithm.

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

Reimplemented from vtkSelectionAlgorithm.

void vtkSelectionSource::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 vtkSelectionAlgorithm.

void vtkSelectionSource::AddID ( vtkIdType  piece,
vtkIdType  id 
)

Add a (piece, id) to the selection set. The source will generate only the ids for which piece == UPDATE_PIECE_NUMBER. If piece == -1, the id applies to all pieces.

void vtkSelectionSource::AddStringID ( vtkIdType  piece,
const char *  id 
)

Add a (piece, id) to the selection set. The source will generate only the ids for which piece == UPDATE_PIECE_NUMBER. If piece == -1, the id applies to all pieces.

void vtkSelectionSource::AddLocation ( double  x,
double  y,
double  z 
)

Add a point in world space to probe at.

void vtkSelectionSource::AddThreshold ( double  min,
double  max 
)

Add a value range to threshold within.

void vtkSelectionSource::SetFrustum ( double *  vertices  ) 

Set a frustum to choose within.

void vtkSelectionSource::AddBlock ( vtkIdType  blockno  ) 

Add the flat-index/composite index for a block.

void vtkSelectionSource::RemoveAllIDs (  ) 

Removes all IDs.

void vtkSelectionSource::RemoveAllStringIDs (  ) 

Removes all IDs.

void vtkSelectionSource::RemoveAllThresholds (  ) 

Remove all thresholds added with AddThreshold.

void vtkSelectionSource::RemoveAllLocations (  ) 

Remove all locations added with AddLocation.

void vtkSelectionSource::RemoveAllBlocks (  ) 

Remove all blocks added with AddBlock.

virtual void vtkSelectionSource::SetContentType ( int   )  [virtual]

Set the content type for the generated selection. Possible values are as defined by vtkSelection::SelectionContent.

virtual int vtkSelectionSource::GetContentType (  )  [virtual]

Set the content type for the generated selection. Possible values are as defined by vtkSelection::SelectionContent.

virtual void vtkSelectionSource::SetFieldType ( int   )  [virtual]

Set the field type for the generated selection. Possible values are as defined by vtkSelection::SelectionField.

virtual int vtkSelectionSource::GetFieldType (  )  [virtual]

Set the field type for the generated selection. Possible values are as defined by vtkSelection::SelectionField.

virtual void vtkSelectionSource::SetContainingCells ( int   )  [virtual]

When extracting by points, extract the cells that contain the passing points.

virtual int vtkSelectionSource::GetContainingCells (  )  [virtual]

When extracting by points, extract the cells that contain the passing points.

virtual void vtkSelectionSource::SetInverse ( int   )  [virtual]

Determines whether the selection describes what to include or exclude. Default is 0, meaning include.

virtual int vtkSelectionSource::GetInverse (  )  [virtual]

Determines whether the selection describes what to include or exclude. Default is 0, meaning include.

virtual void vtkSelectionSource::SetArrayName ( const char *   )  [virtual]

Access to the name of the selection's subset description array.

virtual char* vtkSelectionSource::GetArrayName (  )  [virtual]

Access to the name of the selection's subset description array.

virtual void vtkSelectionSource::SetArrayComponent ( int   )  [virtual]

Access to the component number for the array specified by ArrayName. Default is component 0. Use -1 for magnitude.

virtual int vtkSelectionSource::GetArrayComponent (  )  [virtual]

Access to the component number for the array specified by ArrayName. Default is component 0. Use -1 for magnitude.

virtual void vtkSelectionSource::SetCompositeIndex ( int   )  [virtual]

If CompositeIndex < 0 then COMPOSITE_INDEX() is not added to the output.

virtual int vtkSelectionSource::GetCompositeIndex (  )  [virtual]

If CompositeIndex < 0 then COMPOSITE_INDEX() is not added to the output.

virtual void vtkSelectionSource::SetHierarchicalLevel ( int   )  [virtual]

If HierarchicalLevel or HierarchicalIndex < 0 , then HIERARCHICAL_LEVEL() and HIERARCHICAL_INDEX() keys are not added to the output.

virtual int vtkSelectionSource::GetHierarchicalLevel (  )  [virtual]

If HierarchicalLevel or HierarchicalIndex < 0 , then HIERARCHICAL_LEVEL() and HIERARCHICAL_INDEX() keys are not added to the output.

virtual void vtkSelectionSource::SetHierarchicalIndex ( int   )  [virtual]

If HierarchicalLevel or HierarchicalIndex < 0 , then HIERARCHICAL_LEVEL() and HIERARCHICAL_INDEX() keys are not added to the output.

virtual int vtkSelectionSource::GetHierarchicalIndex (  )  [virtual]

If HierarchicalLevel or HierarchicalIndex < 0 , then HIERARCHICAL_LEVEL() and HIERARCHICAL_INDEX() keys are not added to the output.

virtual int vtkSelectionSource::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

Reimplemented from vtkSelectionAlgorithm.

virtual int vtkSelectionSource::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkSelectionAlgorithm.


Member Data Documentation

vtkSelectionSourceInternals* vtkSelectionSource::Internal [protected]

Definition at line 148 of file vtkSelectionSource.h.

Definition at line 150 of file vtkSelectionSource.h.

Definition at line 151 of file vtkSelectionSource.h.

Definition at line 152 of file vtkSelectionSource.h.

Definition at line 153 of file vtkSelectionSource.h.

int vtkSelectionSource::Inverse [protected]

Definition at line 154 of file vtkSelectionSource.h.

Definition at line 155 of file vtkSelectionSource.h.

Definition at line 156 of file vtkSelectionSource.h.

Definition at line 157 of file vtkSelectionSource.h.

char* vtkSelectionSource::ArrayName [protected]

Definition at line 158 of file vtkSelectionSource.h.

Definition at line 159 of file vtkSelectionSource.h.


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

Generated on Mon Sep 27 18:49:21 2010 for VTK by  doxygen 1.5.6