VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSelectionSource Class Reference

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). More...

#include <vtkSelectionSource.h>

Inheritance diagram for vtkSelectionSource:
[legend]
Collaboration diagram for vtkSelectionSource:
[legend]

Public Types

typedef vtkSelectionAlgorithm Superclass
- Public Types inherited from vtkSelectionAlgorithm
typedef vtkAlgorithm Superclass
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase 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 ()
- Public Member Functions inherited from vtkSelectionAlgorithm
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkSelectionGetOutput ()
vtkSelectionGetOutput (int index)
void SetInput (vtkDataObject *obj)
void SetInput (int index, vtkDataObject *obj)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
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 vtkSelectionSourceNew ()
static int IsTypeOf (const char *type)
static vtkSelectionSourceSafeDownCast (vtkObject *o)

Protected Member Functions

virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
- Protected Member Functions inherited from vtkSelectionAlgorithm
 vtkSelectionAlgorithm ()
 ~vtkSelectionAlgorithm ()
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- 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 &)

Protected Attributes

vtkSelectionSourceInternals * Internal
int ContentType
int FieldType
int ContainingCells
int PreserveTopology
int Inverse
int CompositeIndex
int HierarchicalLevel
int HierarchicalIndex
char * ArrayName
int ArrayComponent
virtual void SetHierarchicalLevel (int)
virtual int GetHierarchicalLevel ()
virtual void SetHierarchicalIndex (int)
virtual int GetHierarchicalIndex ()
 vtkSelectionSource ()
 ~vtkSelectionSource ()

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
- Friends inherited from vtkObject

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.

Member Typedef Documentation

Definition at line 41 of file vtkSelectionSource.h.

Constructor & Destructor Documentation

vtkSelectionSource::vtkSelectionSource ( )
protected

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

vtkSelectionSource::~vtkSelectionSource ( )
protected

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

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 
)
protectedvirtual

Reimplemented from vtkSelectionAlgorithm.

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

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.

int vtkSelectionSource::ContentType
protected

Definition at line 150 of file vtkSelectionSource.h.

int vtkSelectionSource::FieldType
protected

Definition at line 151 of file vtkSelectionSource.h.

int vtkSelectionSource::ContainingCells
protected

Definition at line 152 of file vtkSelectionSource.h.

int vtkSelectionSource::PreserveTopology
protected

Definition at line 153 of file vtkSelectionSource.h.

int vtkSelectionSource::Inverse
protected

Definition at line 154 of file vtkSelectionSource.h.

int vtkSelectionSource::CompositeIndex
protected

Definition at line 155 of file vtkSelectionSource.h.

int vtkSelectionSource::HierarchicalLevel
protected

Definition at line 156 of file vtkSelectionSource.h.

int vtkSelectionSource::HierarchicalIndex
protected

Definition at line 157 of file vtkSelectionSource.h.

char* vtkSelectionSource::ArrayName
protected

Definition at line 158 of file vtkSelectionSource.h.

int vtkSelectionSource::ArrayComponent
protected

Definition at line 159 of file vtkSelectionSource.h.


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