A cell-grid query for enumerating sides of cells. More...

#include <vtkCellGridSidesQuery.h>

Inheritance diagram for vtkCellGridSidesQuery:

Collaboration diagram for vtkCellGridSidesQuery:

Classes
struct	SideSetArray
	A structure created by the GetSideSetArrays() method for responders to use. More...

Public Types
enum	SideFlags : int { VerticesOfEdges = 0x01 , VerticesOfSurfaces = 0x02 , EdgesOfSurfaces = 0x04 , VerticesOfVolumes = 0x08 , EdgesOfVolumes = 0x10 , SurfacesOfVolumes = 0x20 , SurfacesOfInputs = 0x20 , EdgesOfInputs = 0x14 , VerticesOfInputs = 0x0b , AllSides = 0x3f , NextLowestDimension = 0x25 }
	An enum specifying which side(s) each responder should generate. More...

enum	PassWork : int { HashSides = 0 , Summarize = 1 , GenerateSideSets = 2 }
	An enum specifying the work responders should perform for each pass. More...

enum	SummaryStrategy { Winding , AnyOccurrence , Boundary }
	An enum specifying the strategy by which input hashes are summarized into output Sides entries. More...

enum	SelectionMode { Input , Output }
	Indicate how output should be generated or marked so selection works as expected. More...

typedef vtkCellGridQuery	Superclass

Public Types inherited from vtkCellGridQuery
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.

vtkCellGridSidesQuery *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	SetPreserveRenderableInputs (vtkTypeBool)
	Set/get whether renderable cells should be included in the output or the output should strictly contain sides of cells.

virtual vtkTypeBool	GetPreserveRenderableInputs ()

virtual void	PreserveRenderableInputsOn ()

virtual void	PreserveRenderableInputsOff ()

virtual void	SetOmitSidesForRenderableInputs (vtkTypeBool)
	Set/get whether to omit computation of sides for renderable cells.

virtual vtkTypeBool	GetOmitSidesForRenderableInputs ()

virtual void	OmitSidesForRenderableInputsOn ()

virtual void	OmitSidesForRenderableInputsOff ()

virtual void	SetOutputDimensionControl (int)
	Set/get which sides to generate given input cells/sides.

virtual int	GetOutputDimensionControl ()

virtual void	OutputDimensionControlOn ()

virtual void	OutputDimensionControlOff ()

	vtkSetEnumMacro (Strategy, SummaryStrategy)
	Set/get the strategy responders should use to generate entries in Sides from entries in SideCache.

	vtkGetEnumMacro (Strategy, SummaryStrategy)

void	SetStrategyToWinding ()

void	SetStrategyToAnyOccurrence ()

void	SetStrategyToBoundary ()

virtual void	SetStrategy (int strategy)
	This method exists for ParaView to set the strategy.

	vtkSetEnumMacro (SelectionType, SelectionMode)
	Set/get whether the extracted sides should be marked as selectable or whether their originating data should be selectable.

	vtkGetEnumMacro (SelectionType, SelectionMode)

virtual void	SetSelectionType (int selnType)
	This method exists for ParaView to set the selection mode.

bool	Initialize () override
	Override this if your query-result state requires initialization.

void	StartPass () override
	Mark the start of a pass through each cell type.

bool	IsAnotherPassRequired () override
	Override this if your query allows responders to execute in multiple phases.

bool	Finalize () override
	Override this if your query-result state requires finalization.

std::unordered_map< vtkStringToken, std::unordered_map< vtkStringToken, std::unordered_map< vtkIdType, std::set< int > > > > &	GetSides ()

std::vector< SideSetArray >	GetSideSetArrays (vtkStringToken cellType)
	Return arrays of cell+side IDs for the given cellType.

virtual vtkCellGridSidesCache *	GetSideCache ()
	Set/get cached hashtable of sides.

virtual void	SetSideCache (vtkCellGridSidesCache *cache)

Public Member Functions inherited from vtkCellGridQuery
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkCellGridQuery *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual bool	Initialize ()
	Override this if your query-result state requires initialization.

virtual void	StartPass ()
	Mark the start of a pass through each cell type.

virtual int	GetPass ()
	Return the current pass (the number of times each responder has been evaluated so far).

virtual bool	IsAnotherPassRequired ()
	Override this if your query allows responders to execute in multiple phases.

virtual bool	Finalize ()
	Override this if your query-result state requires finalization.

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 vtkCellGridSidesQuery *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkCellGridSidesQuery *	SafeDownCast (vtkObjectBase *o)

static vtkStringToken	SelectionModeToLabel (SelectionMode mode)
	Return a string-token with the given selection mode or vice-versa.

static SelectionMode	SelectionModeFromLabel (vtkStringToken token)

static vtkStringToken	SummaryStrategyToLabel (SummaryStrategy strategy)
	Return a string-token with the given summarization strategy or vice-versa.

static SummaryStrategy	SummaryStrategyFromLabel (vtkStringToken token)

Static Public Member Functions inherited from vtkCellGridQuery
static vtkTypeBool	IsTypeOf (const char *type)

static vtkCellGridQuery *	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

	vtkCellGridSidesQuery ()=default

	~vtkCellGridSidesQuery () override

Protected Member Functions inherited from vtkCellGridQuery
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCellGridQuery ()=default

	~vtkCellGridQuery () override=default

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

Protected Attributes
vtkTypeBool	PreserveRenderableInputs { false }

vtkTypeBool	OmitSidesForRenderableInputs { false }

int	OutputDimensionControl { SideFlags::SurfacesOfInputs }

SelectionMode	SelectionType { SelectionMode::Input }

SummaryStrategy	Strategy { SummaryStrategy::Boundary }

vtkCellGridSidesCache *	SideCache { nullptr }

bool	TemporarySideCache { false }

std::unordered_map< vtkStringToken, std::unordered_map< vtkStringToken, std::unordered_map< vtkIdType, std::set< int > > > >	Sides

Protected Attributes inherited from vtkCellGridQuery
int	Pass { -1 }

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

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

A cell-grid query for enumerating sides of cells.

This query runs in 3 passes (see vtkCellGridSidesQuery::PassWork):

In the first pass, responders invoke the AddSides() method on this query, entries are added to this->Hashes storage indicating the cells which are bounded by a given shape + connectivity.
In the second pass, responders mark the entries created above and add entries in this->Sides. This reorganizes the hashes into groups more amenable to output as side arrays. This pass is called "Summarization," since not every input side identified will be output.
In the third and final pass, responders create new cells in the output cell-grid that correspond to the selected sides of the input.

Definition at line 37 of file vtkCellGridSidesQuery.h.

Member Typedef Documentation

◆ Superclass

typedef vtkCellGridQuery vtkCellGridSidesQuery::Superclass

Definition at line 41 of file vtkCellGridSidesQuery.h.

Member Enumeration Documentation

◆ SideFlags

enum vtkCellGridSidesQuery::SideFlags : int

An enum specifying which side(s) each responder should generate.

Enumerator
VerticesOfEdges	Input edges should produce endpoint vertices.
VerticesOfSurfaces	Input surfaces should produce corner vertices.
EdgesOfSurfaces	Input surfaces should produce bounding edges.
VerticesOfVolumes	Input volumes should produce corner vertices.
EdgesOfVolumes	Input volumes should produce edges bounding faces.
SurfacesOfVolumes	Input volumes should produce bounding surfaces.
SurfacesOfInputs	Produce surfaces (i.e., omit sides of renderable geometry).
EdgesOfInputs	Produce edges of inputs of higher dimension.
VerticesOfInputs	Produce vertices of inputs of higher dimension.
AllSides	Produce all sides of inputs that have any sides.
NextLowestDimension	Given an input of dimension D, produce sides of dimension D-1.

Definition at line 45 of file vtkCellGridSidesQuery.h.

◆ PassWork

enum vtkCellGridSidesQuery::PassWork : int

An enum specifying the work responders should perform for each pass.

Enumerator
HashSides	Responders should call AddSide() on each cell's sides to insert entries into this->SideCache.
Summarize	Responders should claim entries in this->SideCache by transcribing them to this->Sides and then deleting the entry in this->SideCache to prevent multiple responders from processing them.
GenerateSideSets	Responders should insert new side sets into their parent cell-grid by examining this->Sides.

Definition at line 64 of file vtkCellGridSidesQuery.h.

◆ SummaryStrategy

enum vtkCellGridSidesQuery::SummaryStrategy

An enum specifying the strategy by which input hashes are summarized into output Sides entries.

Enumerator

Winding

The number of hash entries for a given side should be used to decide whether to include a hash's side in the output.

If a side occurs an odd number of times, it should be included in the output.

AnyOccurrence

If a hash entry entry exists, a single side should be included in the output.

Boundary

Hashes for shapes (a) of dimension (d-1) that occur an odd number of times and (b) of dimension < (d-1) that occur once or more should be included in the output.

(Dimension d is the dimension of the input shapes, whether they are cells or sides.

Definition at line 80 of file vtkCellGridSidesQuery.h.

◆ SelectionMode

enum vtkCellGridSidesQuery::SelectionMode

Indicate how output should be generated or marked so selection works as expected.

Enumerator
Input	Input shapes should be selected when output sides are picked.
Output	Output sides should be selected when they are picked.

Definition at line 98 of file vtkCellGridSidesQuery.h.

Constructor & Destructor Documentation

◆ vtkCellGridSidesQuery()

vtkCellGridSidesQuery::vtkCellGridSidesQuery ( )

protecteddefault

◆ ~vtkCellGridSidesQuery()

vtkCellGridSidesQuery::~vtkCellGridSidesQuery ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkCellGridSidesQuery * vtkCellGridSidesQuery::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCellGridSidesQuery::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCellGridQuery.

◆ NewInstance()

vtkCellGridSidesQuery * vtkCellGridSidesQuery::NewInstance ( ) const

◆ PrintSelf()

void vtkCellGridSidesQuery::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 vtkCellGridQuery.

◆ SetPreserveRenderableInputs()

virtual void vtkCellGridSidesQuery::SetPreserveRenderableInputs ( vtkTypeBool )

virtual

Set/get whether renderable cells should be included in the output or the output should strictly contain sides of cells.

A cell is renderable if it is of dimension 2 or less (i.e., surfaces, edges, and vertices are all renderable; volumetric cells are not).

The default is false.

◆ GetPreserveRenderableInputs()

virtual vtkTypeBool vtkCellGridSidesQuery::GetPreserveRenderableInputs ( )

virtual

◆ PreserveRenderableInputsOn()

virtual void vtkCellGridSidesQuery::PreserveRenderableInputsOn ( )

virtual

◆ PreserveRenderableInputsOff()

virtual void vtkCellGridSidesQuery::PreserveRenderableInputsOff ( )

virtual

◆ SetOmitSidesForRenderableInputs()

virtual void vtkCellGridSidesQuery::SetOmitSidesForRenderableInputs ( vtkTypeBool )

virtual

Set/get whether to omit computation of sides for renderable cells.

A cell is renderable if it is of dimension 2 or less (i.e., surfaces, edges, and vertices are all renderable; volumetric cells are not). This setting, when used in combination with PreserveRenderableInputs, allows the filter to behave similar to vtkPolyData surface extraction filters; volumetric cells will have sides computed but others will be passed through from the input unaltered.

The default is false.

◆ GetOmitSidesForRenderableInputs()

virtual vtkTypeBool vtkCellGridSidesQuery::GetOmitSidesForRenderableInputs ( )

virtual

◆ OmitSidesForRenderableInputsOn()

virtual void vtkCellGridSidesQuery::OmitSidesForRenderableInputsOn ( )

virtual

◆ OmitSidesForRenderableInputsOff()

virtual void vtkCellGridSidesQuery::OmitSidesForRenderableInputsOff ( )

virtual

◆ SetOutputDimensionControl()

virtual void vtkCellGridSidesQuery::SetOutputDimensionControl ( int )

virtual

Set/get which sides to generate given input cells/sides.

OutputDimensionControl is a bit-vector taking values from the SideFlags enumeration. It determines which sides of the input should be generated. The default is SideFlags::SurfacesOfInputs, which will only emit surfaces of volumetric cells.

◆ GetOutputDimensionControl()

virtual int vtkCellGridSidesQuery::GetOutputDimensionControl ( )

virtual

◆ OutputDimensionControlOn()

virtual void vtkCellGridSidesQuery::OutputDimensionControlOn ( )

virtual

◆ OutputDimensionControlOff()

virtual void vtkCellGridSidesQuery::OutputDimensionControlOff ( )

virtual

◆ vtkSetEnumMacro() [1/2]

vtkCellGridSidesQuery::vtkSetEnumMacro	(	Strategy	,
		SummaryStrategy
	)

Set/get the strategy responders should use to generate entries in Sides from entries in SideCache.

The default is BoundaryStrategy.

◆ vtkGetEnumMacro() [1/2]

vtkCellGridSidesQuery::vtkGetEnumMacro	(	Strategy	,
		SummaryStrategy
	)

◆ SetStrategyToWinding()

void vtkCellGridSidesQuery::SetStrategyToWinding ( )

inline

Definition at line 156 of file vtkCellGridSidesQuery.h.

◆ SetStrategyToAnyOccurrence()

void vtkCellGridSidesQuery::SetStrategyToAnyOccurrence ( )

inline

Definition at line 157 of file vtkCellGridSidesQuery.h.

◆ SetStrategyToBoundary()

void vtkCellGridSidesQuery::SetStrategyToBoundary ( )

inline

Definition at line 158 of file vtkCellGridSidesQuery.h.

◆ SetStrategy()

virtual void vtkCellGridSidesQuery::SetStrategy ( int strategy )

inlinevirtual

This method exists for ParaView to set the strategy.

Definition at line 160 of file vtkCellGridSidesQuery.h.

◆ vtkSetEnumMacro() [2/2]

vtkCellGridSidesQuery::vtkSetEnumMacro	(	SelectionType	,
		SelectionMode
	)

Set/get whether the extracted sides should be marked as selectable or whether their originating data should be selectable.

Responders should use this to either: (a) mark the output to indicate what shapes should be selected upon being picked; or (b) output different shapes so that picking implicitly results in the proper shape being picked.

The default SelectionMode::Input indicates the input data should be selected. Other values indicate the generated output sides should be selected.

◆ vtkGetEnumMacro() [2/2]

vtkCellGridSidesQuery::vtkGetEnumMacro	(	SelectionType	,
		SelectionMode
	)

◆ SetSelectionType()

virtual void vtkCellGridSidesQuery::SetSelectionType ( int selnType )

inlinevirtual

This method exists for ParaView to set the selection mode.

Definition at line 178 of file vtkCellGridSidesQuery.h.

◆ Initialize()

bool vtkCellGridSidesQuery::Initialize ( )

overridevirtual

Override this if your query-result state requires initialization.

You may override this method to do additional work, but you must be careful to call the base method from your override.

Returning false will abort processing of the query. No error message will be printed.

Reimplemented from vtkCellGridQuery.

◆ StartPass()

void vtkCellGridSidesQuery::StartPass ( )

overridevirtual

Mark the start of a pass through each cell type.

This increments the Pass ivar which responders can access.

You may override this method to do additional work, but you must be careful to call the base method from your override.

Reimplemented from vtkCellGridQuery.

◆ IsAnotherPassRequired()

bool vtkCellGridSidesQuery::IsAnotherPassRequired ( )

overridevirtual

Override this if your query allows responders to execute in multiple phases.

This method may do work in addition to returning whether another pass is needed.

Reimplemented from vtkCellGridQuery.

◆ Finalize()

bool vtkCellGridSidesQuery::Finalize ( )

overridevirtual

Override this if your query-result state requires finalization.

Reimplemented from vtkCellGridQuery.

◆ GetSides()

std::unordered_map< vtkStringToken, std::unordered_map< vtkStringToken, std::unordered_map< vtkIdType, std::set< int > > > > & vtkCellGridSidesQuery::GetSides ( )

inline

Definition at line 190 of file vtkCellGridSidesQuery.h.

◆ GetSideSetArrays()

std::vector< SideSetArray > vtkCellGridSidesQuery::GetSideSetArrays ( vtkStringToken cellType )

Return arrays of cell+side IDs for the given cellType.

◆ SelectionModeToLabel()

static vtkStringToken vtkCellGridSidesQuery::SelectionModeToLabel ( SelectionMode mode )

static

Return a string-token with the given selection mode or vice-versa.

◆ SelectionModeFromLabel()

static SelectionMode vtkCellGridSidesQuery::SelectionModeFromLabel ( vtkStringToken token )

static

◆ SummaryStrategyToLabel()

static vtkStringToken vtkCellGridSidesQuery::SummaryStrategyToLabel ( SummaryStrategy strategy )

static

Return a string-token with the given summarization strategy or vice-versa.

◆ SummaryStrategyFromLabel()

static SummaryStrategy vtkCellGridSidesQuery::SummaryStrategyFromLabel ( vtkStringToken token )

static

◆ GetSideCache()

virtual vtkCellGridSidesCache * vtkCellGridSidesQuery::GetSideCache ( )

virtual

Set/get cached hashtable of sides.

The idea is that vtkCellGridSidesCache is generic enough to accommodate a wide variety of cell types and that many of them will be capable of having sides that are conformal to cells of different types that may reside in the same cell-grid. Filters may own this cache or they may attach it to a collection of cell-grid objects that participate by inserting their cells' sides into the cache. (For example, all the cell-grids within a partitioned dataset collection may wish to insert sides in the same cache.)

◆ SetSideCache()

virtual void vtkCellGridSidesQuery::SetSideCache ( vtkCellGridSidesCache * cache )

virtual

Member Data Documentation

◆ PreserveRenderableInputs

vtkTypeBool vtkCellGridSidesQuery::PreserveRenderableInputs { false }

protected

Definition at line 222 of file vtkCellGridSidesQuery.h.

◆ OmitSidesForRenderableInputs

vtkTypeBool vtkCellGridSidesQuery::OmitSidesForRenderableInputs { false }

protected

Definition at line 223 of file vtkCellGridSidesQuery.h.

◆ OutputDimensionControl

int vtkCellGridSidesQuery::OutputDimensionControl { SideFlags::SurfacesOfInputs }

protected

Definition at line 224 of file vtkCellGridSidesQuery.h.

◆ SelectionType

SelectionMode vtkCellGridSidesQuery::SelectionType { SelectionMode::Input }

protected

Definition at line 225 of file vtkCellGridSidesQuery.h.

◆ Strategy

SummaryStrategy vtkCellGridSidesQuery::Strategy { SummaryStrategy::Boundary }

protected

Definition at line 226 of file vtkCellGridSidesQuery.h.

◆ SideCache

vtkCellGridSidesCache* vtkCellGridSidesQuery::SideCache { nullptr }

protected

Definition at line 227 of file vtkCellGridSidesQuery.h.

◆ TemporarySideCache

bool vtkCellGridSidesQuery::TemporarySideCache { false }

protected

Definition at line 228 of file vtkCellGridSidesQuery.h.

◆ Sides

std::unordered_map<vtkStringToken, std::unordered_map<vtkStringToken, std::unordered_map<vtkIdType, std::set<int> > > > vtkCellGridSidesQuery::Sides

protected

Definition at line 231 of file vtkCellGridSidesQuery.h.

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

Common/DataModel/vtkCellGridSidesQuery.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ SideFlags

◆ PassWork

◆ SummaryStrategy

◆ SelectionMode

Constructor & Destructor Documentation

◆ vtkCellGridSidesQuery()

◆ ~vtkCellGridSidesQuery()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetPreserveRenderableInputs()

◆ GetPreserveRenderableInputs()

◆ PreserveRenderableInputsOn()

◆ PreserveRenderableInputsOff()

◆ SetOmitSidesForRenderableInputs()

◆ GetOmitSidesForRenderableInputs()

◆ OmitSidesForRenderableInputsOn()

◆ OmitSidesForRenderableInputsOff()

◆ SetOutputDimensionControl()

◆ GetOutputDimensionControl()

◆ OutputDimensionControlOn()

◆ OutputDimensionControlOff()

◆ vtkSetEnumMacro() [1/2]

◆ vtkGetEnumMacro() [1/2]

◆ SetStrategyToWinding()

◆ SetStrategyToAnyOccurrence()

◆ SetStrategyToBoundary()

◆ SetStrategy()

◆ vtkSetEnumMacro() [2/2]

◆ vtkGetEnumMacro() [2/2]

◆ SetSelectionType()

◆ Initialize()

◆ StartPass()

◆ IsAnotherPassRequired()

◆ Finalize()

◆ GetSides()

◆ GetSideSetArrays()

◆ SelectionModeToLabel()

◆ SelectionModeFromLabel()

◆ SummaryStrategyToLabel()

◆ SummaryStrategyFromLabel()

◆ GetSideCache()

◆ SetSideCache()

Member Data Documentation

◆ PreserveRenderableInputs

◆ OmitSidesForRenderableInputs

◆ OutputDimensionControl

◆ SelectionType

◆ Strategy

◆ SideCache

◆ TemporarySideCache

◆ Sides