VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
vtkSelector Class Referenceabstract

#include <vtkSelector.h>

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

Public Types

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...
 
vtkSelectorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Initialize (vtkSelectionNode *node)
 Sets the vtkSelectionNode used by this selection operator and initializes the data structures in the selection operator based on the selection. More...
 
virtual void Finalize ()
 Does any cleanup of objects created in Initialize. More...
 
virtual void Execute (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...
 
virtual void SetInsidednessArrayName (std::string)
 Get/Set the name of the array to use for the insidedness array to add to the output in Execute call. More...
 
virtual std::string GetInsidednessArrayName ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 Types

enum  SelectionMode { INCLUDE, EXCLUDE, INHERIT }
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkSelector ()
 
virtual ~vtkSelector () override
 
virtual bool ComputeSelectedElements (vtkDataObject *input, vtkSignedCharArray *insidednessArray)=0
 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...
 
virtual SelectionMode GetAMRBlockSelection (unsigned int level, unsigned int index)
 Returns whether the AMR block is to be processed. More...
 
virtual SelectionMode GetBlockSelection (unsigned int compositeIndex)
 Returns whether the block is to be processed. 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkSelectionNodeNode = nullptr
 
std::string InsidednessArrayName
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Definition at line 38 of file vtkSelector.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkSelector.h.

Member Enumeration Documentation

◆ SelectionMode

Enumerator
INCLUDE 
EXCLUDE 
INHERIT 

Definition at line 108 of file vtkSelector.h.

Constructor & Destructor Documentation

◆ vtkSelector()

vtkSelector::vtkSelector ( )
protected

◆ ~vtkSelector()

virtual vtkSelector::~vtkSelector ( )
overrideprotectedvirtual

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkSelector::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkSelector::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 vtkObjectBase.

Reimplemented in vtkValueSelector, vtkFrustumSelector, vtkLocationSelector, and vtkBlockSelector.

◆ SafeDownCast()

static vtkSelector* vtkSelector::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSelector::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkSelector* vtkSelector::NewInstance ( ) const

◆ PrintSelf()

void vtkSelector::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 vtkObject.

Reimplemented in vtkValueSelector.

◆ Initialize()

virtual void vtkSelector::Initialize ( vtkSelectionNode node)
virtual

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.

Reimplemented in vtkValueSelector, vtkFrustumSelector, vtkLocationSelector, and vtkBlockSelector.

◆ Finalize()

virtual void vtkSelector::Finalize ( )
inlinevirtual

Does any cleanup of objects created in Initialize.

Reimplemented in vtkValueSelector, and vtkLocationSelector.

Definition at line 58 of file vtkSelector.h.

◆ Execute()

virtual void vtkSelector::Execute ( vtkDataObject input,
vtkDataObject output 
)
virtual

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.

The attribute (point data or cell data) is determined by the vtkSelection that owns the vtkSelectionNode set in Initialize(). The insidedness array is named with the value of InsidednessArrayName. If input is a vtkCompositeDataSet, the insidedness array is added to each block.

◆ SetInsidednessArrayName()

virtual void vtkSelector::SetInsidednessArrayName ( std::string  )
virtual

Get/Set the name of the array to use for the insidedness array to add to the output in Execute call.

◆ GetInsidednessArrayName()

virtual std::string vtkSelector::GetInsidednessArrayName ( )
virtual

◆ ComputeSelectedElements()

virtual bool vtkSelector::ComputeSelectedElements ( vtkDataObject input,
vtkSignedCharArray insidednessArray 
)
protectedpure virtual

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 will never be a vtkCompositeDataSet subclass.

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.

Returns true for successful completion. The operator should only return false when it cannot operate on the inputs. In which case, it is assumed that the insidednessArray may have been left untouched by this method and the calling code will fill it with 0.

Implemented in vtkFrustumSelector, vtkValueSelector, vtkLocationSelector, and vtkBlockSelector.

◆ GetAMRBlockSelection()

virtual SelectionMode vtkSelector::GetAMRBlockSelection ( unsigned int  level,
unsigned int  index 
)
protectedvirtual

Returns whether the AMR block is to be processed.

Return INCLUDE to indicate it must be processed or EXCLUDE to indicate it must not be processed. If the selector cannot make an exact determination for the given level, index it should return INHERIT. If the selection did not specify which AMR block to extract, then too return INHERIT.

Reimplemented in vtkBlockSelector.

◆ GetBlockSelection()

virtual SelectionMode vtkSelector::GetBlockSelection ( unsigned int  compositeIndex)
protectedvirtual

Returns whether the block is to be processed.

Return INCLUDE to indicate it must be processed or EXCLUDE to indicate it must not be processed. If the selector cannot make an exact determination for the given level and index, it should return INHERIT. Note, returning INCLUDE or EXCLUDE has impact on all nodes in the subtree unless any of the node explicitly overrides the block selection mode.

Reimplemented in vtkBlockSelector.

◆ CreateInsidednessArray()

vtkSmartPointer<vtkSignedCharArray> vtkSelector::CreateInsidednessArray ( vtkIdType  numElems)
protected

Creates an array suitable for storing insideness.

The array is named using this->InsidednessArrayName and is sized to exactly numElems values.

◆ ComputeCellsContainingSelectedPoints()

vtkSmartPointer<vtkSignedCharArray> vtkSelector::ComputeCellsContainingSelectedPoints ( vtkDataObject data,
vtkSignedCharArray selectedPoints 
)
protected

Given a data object and selected points, return an array indicating the insidedness of cells that contain at least one of the selected points.

Member Data Documentation

◆ Node

vtkSelectionNode* vtkSelector::Node = nullptr
protected

Definition at line 84 of file vtkSelector.h.

◆ InsidednessArrayName

std::string vtkSelector::InsidednessArrayName
protected

Definition at line 88 of file vtkSelector.h.


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