#include <vtkSelector.h>

Inheritance diagram for vtkSelector:

Collaboration diagram for vtkSelector:

Classes
class	h
	Computes the portion of a dataset which is inside a selection. More...

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

vtkSelector *	NewInstance () 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, const std::string &insidednessArrayName)
	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 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...

vtkCommand *	GetCommand (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 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. 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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkSelector ()

virtual	~vtkSelector () override

virtual bool	ComputeSelectedElementsForBlock (vtkDataObject input, vtkSignedCharArray insidednessArray, unsigned int compositeIndex, unsigned int amrLevel, unsigned int amrIndex)=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 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< vtkSignedCharArray >	CreateInsidednessArray (vtkIdType numElems)
	Creates an array suitable for storing insideness. More...

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

Protected Attributes
vtkSelectionNode *	Node = 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

Definition at line 35 of file vtkSelector.h.

Member Typedef Documentation

typedef vtkObject vtkSelector::Superclass

Definition at line 38 of file vtkSelector.h.

Constructor & Destructor Documentation

vtkSelector::vtkSelector ( )

protected

virtual vtkSelector::~vtkSelector ( )

overrideprotectedvirtual

Member Function Documentation

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

static

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.

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

static

virtual vtkObjectBase* vtkSelector::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkValueSelector, vtkFrustumSelector, vtkLocationSelector, and vtkBlockSelector.

vtkSelector* vtkSelector::NewInstance ( ) const

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.

virtual void vtkSelector::Initialize	(	vtkSelectionNode *	node,
		const std::string &	insidednessArrayName
	)

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

node	The selection node that determines the behavior of this operator.
insidednessArrayName	The name of the insidedness array to add to the output from this operator.

Reimplemented in vtkValueSelector, vtkFrustumSelector, vtkLocationSelector, and vtkBlockSelector.

virtual void vtkSelector::Finalize ( )

inlinevirtual

Does any cleanup of objects created in Initialize.

Reimplemented in vtkValueSelector, and vtkLocationSelector.

Definition at line 57 of file vtkSelector.h.

virtual bool vtkSelector::ComputeSelectedElements	(	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.

virtual bool vtkSelector::ComputeSelectedElementsForBlock	(	vtkDataObject *	input,
		vtkSignedCharArray *	insidednessArray,
		unsigned int	compositeIndex,
		unsigned int	amrLevel,
		unsigned int	amrIndex
	)

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

Implemented in vtkFrustumSelector, vtkValueSelector, vtkLocationSelector, and vtkBlockSelector.

virtual bool vtkSelector::ComputeSelectedElementsForCompositeDataSet	(	vtkCompositeDataSet *	input,
		vtkCompositeDataSet *	output
	)

protectedvirtual

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

This methods operates on an input vtkCompositeDataSet. It stores results in arrays associated with the element data in a copy of the input data object.

What type of elements are operated over is determined by the vtkSelectionNode's field association.

Returns true after successful completion. The operator should only return false when it cannot operate on the inputs. Selectors that do not apply to vtkCompositeDataSets should do nothing and return true.

bool vtkSelector::SkipBlock	(	unsigned int	compositeIndex,
		unsigned int	amrLevel,
		unsigned int	amrIndex
	)

protected

Subclasses can call this to check if the block should be skipped.

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

protected

Creates an array suitable for storing insideness.

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

vtkSelectionNode* vtkSelector::Node = nullptr

protected

Definition at line 74 of file vtkSelector.h.

std::string vtkSelector::InsidednessArrayName

protected

Definition at line 78 of file vtkSelector.h.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Filters/Extraction/vtkSelector.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation