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

selects elements matching chosen values. More...

#include <vtkValueSelector.h>

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

Public Types

typedef vtkSelector Superclass
 
- Public Types inherited from vtkSelector
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkValueSelectorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Initialize (vtkSelectionNode *node, const std::string &insidednessArrayName) override
 Sets the vtkSelectionNode used by this selection operator and initializes the data structures in the selection operator based on the selection. More...
 
void Finalize () override
 Does any cleanup of objects created in Initialize. More...
 
- Public Member Functions inherited from vtkSelector
vtkSelectorNewInstance () const
 
virtual bool ComputeSelectedElements (vtkDataObject *input, vtkDataObject *output)
 Given an input and the vtkSelectionNode passed into the Initialize() method, add to the output a vtkSignedChar attribute array indicating whether each element is inside (1) or outside (0) the selection. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkValueSelectorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkValueSelectorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkSelector
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSelectorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkValueSelector ()
 
 ~vtkValueSelector () override
 
bool ComputeSelectedElementsForBlock (vtkDataObject *input, vtkSignedCharArray *insidednessArray, unsigned int compositeIndex, unsigned int amrLevel, unsigned int amrIndex) override
 This method computes whether or not each element in the dataset is inside the selection and populates the given array with 0 (outside the selection) or 1 (inside the selection). More...
 
- Protected Member Functions inherited from vtkSelector
 vtkSelector ()
 
virtual ~vtkSelector () override
 
virtual bool ComputeSelectedElementsForCompositeDataSet (vtkCompositeDataSet *input, vtkCompositeDataSet *output)
 Computes whether each element in the dataset is inside the selection and populates the given array with 0 (outside the selection) or 1 (inside the selection). More...
 
bool SkipBlock (unsigned int compositeIndex, unsigned int amrLevel, unsigned int amrIndex)
 Subclasses can call this to check if the block should be skipped. More...
 
vtkSmartPointer< vtkSignedCharArrayCreateInsidednessArray (vtkIdType numElems)
 Creates an array suitable for storing insideness. More...
 
vtkSmartPointer< vtkSignedCharArrayComputeCellsContainingSelectedPoints (vtkDataObject *data, vtkSignedCharArray *selectedPoints)
 Given a data object and selected points, return an array indicating the insidedness of cells that contain at least one of the selected points. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- 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 vtkSelector
vtkSelectionNodeNode = nullptr
 
std::string InsidednessArrayName
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

selects elements matching chosen values.

vtkValueSelector is a vtkSelector that can select elements matching values. This can handle a wide array of vtkSelectionNode::SelectionContent types. These include vtkSelectionNode::GLOBALIDS, vtkSelectionNode::PEDIGREEIDS, vtkSelectionNode::VALUES, vtkSelectionNode::INDICES, and vtkSelectionNode::THRESHOLDS.

A few things to note:

Definition at line 47 of file vtkValueSelector.h.

Member Typedef Documentation

Definition at line 51 of file vtkValueSelector.h.

Constructor & Destructor Documentation

vtkValueSelector::vtkValueSelector ( )
protected
vtkValueSelector::~vtkValueSelector ( )
overrideprotected

Member Function Documentation

static vtkValueSelector* vtkValueSelector::New ( )
static
static vtkTypeBool vtkValueSelector::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkValueSelector::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 vtkSelector.

static vtkValueSelector* vtkValueSelector::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkValueSelector::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkSelector.

vtkValueSelector* vtkValueSelector::NewInstance ( ) const
void vtkValueSelector::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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 vtkSelector.

void vtkValueSelector::Initialize ( vtkSelectionNode node,
const std::string &  insidednessArrayName 
)
overridevirtual

Sets the vtkSelectionNode used by this selection operator and initializes the data structures in the selection operator based on the selection.

(for example in the vtkFrustumSelector this creates the vtkPlanes implicit function to represent the frustum).

Parameters
nodeThe selection node that determines the behavior of this operator.
insidednessArrayNameThe name of the insidedness array to add to the output from this operator.

Reimplemented from vtkSelector.

void vtkValueSelector::Finalize ( )
overridevirtual

Does any cleanup of objects created in Initialize.

Reimplemented from vtkSelector.

bool vtkValueSelector::ComputeSelectedElementsForBlock ( vtkDataObject input,
vtkSignedCharArray insidednessArray,
unsigned int  compositeIndex,
unsigned int  amrLevel,
unsigned int  amrIndex 
)
overrideprotectedvirtual

This method computes whether or not each element in the dataset is inside the selection and populates the given array with 0 (outside the selection) or 1 (inside the selection).

The vtkDataObject passed in should be a non-composite data object.

What type of elements are operated over is determined by the vtkSelectionNode's field association. The insidednessArray passed in should have the correct number of elements for that field type or it will be resized. The last three parameters give the data object's composite index, AMR level or AMR index.

Returns true for successful completion. The operator should only return false when it cannot operate on the inputs.

Implements vtkSelector.


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