ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
vtkPVSelectionSource Class Reference

selection source used to produce different types of vtkSelections. More...

#include <vtkPVSelectionSource.h>

Inherits vtkSelectionAlgorithm.

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 SetFrustum (double vertices[32])
 Set a frustum to choose within. More...
 
void SetArrayName (const char *arrayName)
 For threshold and value selection, this controls the name of the scalar array that will be thresholded within. More...
 
void AddGlobalID (vtkIdType id)
 Add global IDs. More...
 
void RemoveAllGlobalIDs ()
 Add global IDs. More...
 
void AddPedigreeID (const char *domain, vtkIdType id)
 Add integer pedigree IDs in a particular domain. More...
 
void RemoveAllPedigreeIDs ()
 Add integer pedigree IDs in a particular domain. More...
 
void AddPedigreeStringID (const char *domain, const char *id)
 Add string pedigree IDs in a particular domain. More...
 
void RemoveAllPedigreeStringIDs ()
 Add string pedigree IDs in a particular domain. More...
 
void AddID (vtkIdType piece, vtkIdType id)
 Add a (piece, id) to the selection set. More...
 
void RemoveAllIDs ()
 Add a (piece, id) to the selection set. More...
 
void AddCompositeID (unsigned int composite_index, vtkIdType piece, vtkIdType id)
 Add IDs that will be added to the selection produced by the selection source. More...
 
void RemoveAllCompositeIDs ()
 Add IDs that will be added to the selection produced by the selection source. More...
 
void AddHierarhicalID (unsigned int level, unsigned int dataset, vtkIdType id)
 The list of IDs that will be added to the selection produced by the selection source. More...
 
void RemoveAllHierarchicalIDs ()
 The list of IDs that will be added to the selection produced by the selection source. More...
 
void AddThreshold (double min, double max)
 Add a value range to threshold within. More...
 
void RemoveAllThresholds ()
 Add a value range to threshold within. More...
 
void AddBlock (vtkIdType blockno)
 Add the flat-index/composite index for a block. More...
 
void RemoveAllBlocks ()
 Add the flat-index/composite index for a block. More...
 
void AddLocation (double x, double y, double z)
 Add a point in world space to probe at. More...
 
void RemoveAllLocations ()
 Add a point in world space to probe at. More...
 
virtual void SetFieldType (int)
 Set the field type for the generated selection. More...
 
virtual int GetFieldType ()
 Set the field type for the generated selection. More...
 
virtual void SetContainingCells (int)
 When extracting by points, extract the cells that contain the passing points. More...
 
virtual int GetContainingCells ()
 When extracting by points, extract the cells that contain the passing points. More...
 
virtual void SetInverse (int)
 
virtual int GetInverse ()
 
virtual void SetQueryString (const char *)
 Set/get the query expression string. More...
 
virtual char * GetQueryString ()
 Set/get the query expression string. More...
 

Static Public Member Functions

static vtkPVSelectionSourceNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVSelectionSourceSafeDownCast (vtkObject *o)
 

Protected Types

enum  Modes {
  FRUSTUM, GLOBALIDS, ID, COMPOSITEID,
  HIERARCHICALID, THRESHOLDS, LOCATIONS, BLOCKS,
  PEDIGREEIDS, QUERY
}
 

Protected Member Functions

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

Protected Attributes

Modes Mode
 
int FieldType
 
int ContainingCells
 
int Inverse
 
double Frustum [32]
 
char * ArrayName
 
char * QueryString
 

Detailed Description

selection source used to produce different types of vtkSelections.

vtkPVSelectionSource is used to create different types of selections. It provides different APIs for different types of selections to create. The output selection type depends on the API used most recently.

Definition at line 31 of file vtkPVSelectionSource.h.

Member Typedef Documentation

§ Superclass

typedef vtkSelectionAlgorithm vtkPVSelectionSource::Superclass

Definition at line 35 of file vtkPVSelectionSource.h.

Member Enumeration Documentation

§ Modes

Enumerator
FRUSTUM 
GLOBALIDS 
ID 
COMPOSITEID 
HIERARCHICALID 
THRESHOLDS 
LOCATIONS 
BLOCKS 
PEDIGREEIDS 
QUERY 

Definition at line 169 of file vtkPVSelectionSource.h.

Constructor & Destructor Documentation

§ vtkPVSelectionSource()

vtkPVSelectionSource::vtkPVSelectionSource ( )
protected

§ ~vtkPVSelectionSource()

vtkPVSelectionSource::~vtkPVSelectionSource ( )
protected

Member Function Documentation

§ New()

static vtkPVSelectionSource* vtkPVSelectionSource::New ( )
static

§ GetClassName()

virtual const char* vtkPVSelectionSource::GetClassName ( )
virtual

§ IsTypeOf()

static int vtkPVSelectionSource::IsTypeOf ( const char *  type)
static

§ IsA()

virtual int vtkPVSelectionSource::IsA ( const char *  type)
virtual

§ SafeDownCast()

static vtkPVSelectionSource* vtkPVSelectionSource::SafeDownCast ( vtkObject *  o)
static

§ PrintSelf()

void vtkPVSelectionSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

§ SetFrustum()

void vtkPVSelectionSource::SetFrustum ( double  vertices[32])

Set a frustum to choose within.

§ AddGlobalID()

void vtkPVSelectionSource::AddGlobalID ( vtkIdType  id)

Add global IDs.

§ RemoveAllGlobalIDs()

void vtkPVSelectionSource::RemoveAllGlobalIDs ( )

Add global IDs.

§ AddPedigreeID()

void vtkPVSelectionSource::AddPedigreeID ( const char *  domain,
vtkIdType  id 
)

Add integer pedigree IDs in a particular domain.

§ RemoveAllPedigreeIDs()

void vtkPVSelectionSource::RemoveAllPedigreeIDs ( )

Add integer pedigree IDs in a particular domain.

§ AddPedigreeStringID()

void vtkPVSelectionSource::AddPedigreeStringID ( const char *  domain,
const char *  id 
)

Add string pedigree IDs in a particular domain.

§ RemoveAllPedigreeStringIDs()

void vtkPVSelectionSource::RemoveAllPedigreeStringIDs ( )

Add string pedigree IDs in a particular domain.

§ AddID()

void vtkPVSelectionSource::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.

§ RemoveAllIDs()

void vtkPVSelectionSource::RemoveAllIDs ( )

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.

§ AddCompositeID()

void vtkPVSelectionSource::AddCompositeID ( unsigned int  composite_index,
vtkIdType  piece,
vtkIdType  id 
)

Add IDs that will be added to the selection produced by the selection source.

The source will generate only the ids for which piece == UPDATE_PIECE_NUMBER. If piece == -1, the id applies to all pieces.

§ RemoveAllCompositeIDs()

void vtkPVSelectionSource::RemoveAllCompositeIDs ( )

Add IDs that will be added to the selection produced by the selection source.

The source will generate only the ids for which piece == UPDATE_PIECE_NUMBER. If piece == -1, the id applies to all pieces.

§ AddHierarhicalID()

void vtkPVSelectionSource::AddHierarhicalID ( unsigned int  level,
unsigned int  dataset,
vtkIdType  id 
)

The list of IDs that will be added to the selection produced by the selection source.

§ RemoveAllHierarchicalIDs()

void vtkPVSelectionSource::RemoveAllHierarchicalIDs ( )

The list of IDs that will be added to the selection produced by the selection source.

§ AddThreshold()

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

Add a value range to threshold within.

§ RemoveAllThresholds()

void vtkPVSelectionSource::RemoveAllThresholds ( )

Add a value range to threshold within.

§ AddBlock()

void vtkPVSelectionSource::AddBlock ( vtkIdType  blockno)

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

§ RemoveAllBlocks()

void vtkPVSelectionSource::RemoveAllBlocks ( )

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

§ SetArrayName()

void vtkPVSelectionSource::SetArrayName ( const char *  arrayName)

For threshold and value selection, this controls the name of the scalar array that will be thresholded within.

§ AddLocation()

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

Add a point in world space to probe at.

§ RemoveAllLocations()

void vtkPVSelectionSource::RemoveAllLocations ( )

Add a point in world space to probe at.

§ SetFieldType()

virtual void vtkPVSelectionSource::SetFieldType ( int  )
virtual

Set the field type for the generated selection.

Possible values are as defined by vtkSelection::SelectionField.

§ GetFieldType()

virtual int vtkPVSelectionSource::GetFieldType ( )
virtual

Set the field type for the generated selection.

Possible values are as defined by vtkSelection::SelectionField.

§ SetContainingCells()

virtual void vtkPVSelectionSource::SetContainingCells ( int  )
virtual

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

§ GetContainingCells()

virtual int vtkPVSelectionSource::GetContainingCells ( )
virtual

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

§ SetInverse()

virtual void vtkPVSelectionSource::SetInverse ( int  )
virtual

§ GetInverse()

virtual int vtkPVSelectionSource::GetInverse ( )
virtual

§ SetQueryString()

virtual void vtkPVSelectionSource::SetQueryString ( const char *  )
virtual

Set/get the query expression string.

§ GetQueryString()

virtual char* vtkPVSelectionSource::GetQueryString ( )
virtual

Set/get the query expression string.

§ RequestInformation()

virtual int vtkPVSelectionSource::RequestInformation ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

§ RequestData()

virtual int vtkPVSelectionSource::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

Member Data Documentation

§ Mode

Modes vtkPVSelectionSource::Mode
protected

Definition at line 183 of file vtkPVSelectionSource.h.

§ FieldType

int vtkPVSelectionSource::FieldType
protected

Definition at line 184 of file vtkPVSelectionSource.h.

§ ContainingCells

int vtkPVSelectionSource::ContainingCells
protected

Definition at line 185 of file vtkPVSelectionSource.h.

§ Inverse

int vtkPVSelectionSource::Inverse
protected

Definition at line 186 of file vtkPVSelectionSource.h.

§ Frustum

double vtkPVSelectionSource::Frustum[32]
protected

Definition at line 187 of file vtkPVSelectionSource.h.

§ ArrayName

char* vtkPVSelectionSource::ArrayName
protected

Definition at line 188 of file vtkPVSelectionSource.h.

§ QueryString

char* vtkPVSelectionSource::QueryString
protected

Definition at line 189 of file vtkPVSelectionSource.h.


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