vtkBlockSelector Class Reference

selector for blocks More...

#include <vtkBlockSelector.h>

Inheritance diagram for vtkBlockSelector:

Collaboration diagram for vtkBlockSelector:

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.
vtkBlockSelector *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Initialize (vtkSelectionNode *node) override
	Sets the vtkSelectionNode used by this selection operator and initializes the data structures in the selection operator based on the selection.
void	Execute (vtkDataObject *input, vtkDataObject *output) override
	Overridden to handle BLOCK_SELECTORS.
Public Member Functions inherited from vtkSelector
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkSelector *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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.
virtual void	Finalize ()
	Does any cleanup of objects created in Initialize.
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.
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.
virtual std::string	GetInsidednessArrayName ()
	Get/Set the name of the array to use for the insidedness array to add to the output in Execute call.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkBlockSelector *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkBlockSelector *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkSelector
static vtkTypeBool	IsTypeOf (const char *type)
static vtkSelector *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkBlockSelector ()
	~vtkBlockSelector () override
bool	ComputeSelectedElements (vtkDataObject *input, vtkSignedCharArray *insidednessArray) 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).
SelectionMode	GetAMRBlockSelection (unsigned int level, unsigned int index) override
	Returns whether the AMR block is to be processed.
SelectionMode	GetBlockSelection (unsigned int compositeIndex, bool isDataObjectTree=true) override
	Returns whether the block is to be processed.
Protected Member Functions inherited from vtkSelector
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkSelector ()
	~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).
virtual SelectionMode	GetAMRBlockSelection (unsigned int level, unsigned int index)
	Returns whether the AMR block is to be processed.
virtual SelectionMode	GetBlockSelection (unsigned int compositeIndex, bool isDataObjectTree=true)
	Returns whether the block is to be processed.
vtkSmartPointer< vtkSignedCharArray >	CreateInsidednessArray (vtkIdType numElems)
	Creates an array suitable for storing insideness.
vtkSmartPointer< vtkSignedCharArray >	ComputeCellsContainingSelectedPoints (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.
void	ExpandToConnectedElements (vtkDataObject *output)
	Handle expanding to connected cells or point, if requested.
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Types inherited from vtkSelector
enum	SelectionMode { INCLUDE , EXCLUDE , INHERIT }
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkSelector
vtkSelectionNode *	Node = nullptr
std::string	InsidednessArrayName
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

selector for blocks

Selects cells or points contained in a block as defined in the vtkSelectionNode used to initialize this operator.

This selector supports vtkSelectionNode::BLOCKS and vtkSelectionNode::BLOCK_SELECTORS.

Definition at line 20 of file vtkBlockSelector.h.

Member Typedef Documentation

Superclass

typedef vtkSelector vtkBlockSelector::Superclass

Definition at line 24 of file vtkBlockSelector.h.

Constructor & Destructor Documentation

vtkBlockSelector()

vtkBlockSelector::vtkBlockSelector ( )

protected

~vtkBlockSelector()

vtkBlockSelector::~vtkBlockSelector ( )

overrideprotected

Member Function Documentation

New()

static vtkBlockSelector * vtkBlockSelector::New ( )

static

IsTypeOf()

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

static

IsA()

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

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkBlockSelector::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkSelector.

NewInstance()

vtkBlockSelector * vtkBlockSelector::NewInstance

(

)

const

PrintSelf()

void vtkBlockSelector::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 vtkObjectBase.

Initialize()

void vtkBlockSelector::Initialize ( vtkSelectionNode *  node )

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

node	The selection node that determines the behavior of this operator.

Reimplemented from vtkSelector.

Execute()

void vtkBlockSelector::Execute ( vtkDataObject *  input, vtkDataObject *  output  )

overridevirtual

Overridden to handle BLOCK_SELECTORS.

We need the data to convert selector expressions to composite indices for quick check if block is selected. We do that here.

Reimplemented from vtkSelector.

ComputeSelectedElements()

bool vtkBlockSelector::ComputeSelectedElements ( vtkDataObject *  input, vtkSignedCharArray *  insidednessArray  )

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

Implements vtkSelector.

GetAMRBlockSelection()

SelectionMode vtkBlockSelector::GetAMRBlockSelection ( unsigned int  level, unsigned int  index  )

overrideprotectedvirtual

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

GetBlockSelection()

SelectionMode vtkBlockSelector::GetBlockSelection ( unsigned int  compositeIndex, bool  isDataObjectTree = true  )

overrideprotectedvirtual

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. isDataObjectTree is true for vtkDataObjectTree and false for vtkUniformGridAMR. When isDataObjectTree == true, we treat compositeIndex == 0 differently.

Reimplemented from vtkSelector.

---

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

• Filters/Extraction/vtkBlockSelector.h