collections of utilities for vtkDataAssembly More...

#include <vtkDataAssemblyUtilities.h>

Inheritance diagram for vtkDataAssemblyUtilities:

Collaboration diagram for vtkDataAssemblyUtilities:

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.

vtkDataAssemblyUtilities *	NewInstance () const

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

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)

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.

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.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

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.

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

Static Public Member Functions
static vtkDataAssemblyUtilities *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataAssemblyUtilities *	SafeDownCast (vtkObjectBase *o)

static const char *	HierarchyName ()
	Returns the named used by VTK to correspond to a vtkDataAssembly associated with the structure of a composite dataset.

static vtkSmartPointer< vtkDataAssembly >	GetDataAssembly (const char name, vtkCompositeDataSet cd)
	Convenience method to get a named vtkDataAssembly from a vtkCompositeDataSet, if available.

static bool	GenerateHierarchy (vtkCompositeDataSet input, vtkDataAssembly hierarchy, vtkPartitionedDataSetCollection *output=nullptr)
	Populates `hierarchy` with a representation of the hierarchy for the given composite dataset `input`.

static vtkSmartPointer< vtkCompositeDataSet >	GenerateCompositeDataSetFromHierarchy (vtkPartitionedDataSetCollection input, vtkDataAssembly hierarchy)
	Inverse of `GenerateHierarchy`.

static std::vector< unsigned int >	GetSelectedCompositeIds (const std::vector< std::string > &selectors, vtkDataAssembly hierarchyOrAssembly, vtkPartitionedDataSetCollection data=nullptr, bool leaf_nodes_only=false)
	Given a vtkDataAssembly and collection of selectors, returns a list of selected composite indices for the selected nodes.


static std::string	GetSelectorForCompositeId (unsigned int id, vtkDataAssembly *hierarchy)
	For a vtkDataAssembly representing an hierarchy, returns the selector for the given composite id.

static std::vector< std::string >	GetSelectorsForCompositeIds (const std::vector< unsigned int > &ids, vtkDataAssembly *hierarchy)
	For a vtkDataAssembly representing an hierarchy, returns the selector for the given composite id.

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 (int 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 int	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

	vtkDataAssemblyUtilities ()

	~vtkDataAssemblyUtilities () override

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

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static bool	GenerateHierarchyInternal (vtkUniformGridAMR input, vtkDataAssembly hierarchy, vtkPartitionedDataSetCollection *output)

static bool	GenerateHierarchyInternal (vtkMultiBlockDataSet input, vtkDataAssembly hierarchy, vtkPartitionedDataSetCollection *output)

static bool	GenerateHierarchyInternal (vtkPartitionedDataSetCollection input, vtkDataAssembly hierarchy, vtkPartitionedDataSetCollection *output)

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Additional Inherited Members
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

collections of utilities for vtkDataAssembly

vtkDataAssemblyUtilities provides useful utilities for working with vtkDataAssembly.

Definition at line 40 of file vtkDataAssemblyUtilities.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkDataAssemblyUtilities::Superclass

Definition at line 44 of file vtkDataAssemblyUtilities.h.

Constructor & Destructor Documentation

◆ vtkDataAssemblyUtilities()

vtkDataAssemblyUtilities::vtkDataAssemblyUtilities ( )

protected

◆ ~vtkDataAssemblyUtilities()

vtkDataAssemblyUtilities::~vtkDataAssemblyUtilities ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkDataAssemblyUtilities * vtkDataAssemblyUtilities::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDataAssemblyUtilities::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkDataAssemblyUtilities * vtkDataAssemblyUtilities::NewInstance ( ) const

◆ PrintSelf()

void vtkDataAssemblyUtilities::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.

◆ HierarchyName()

static const char * vtkDataAssemblyUtilities::HierarchyName ( )

inlinestatic

Returns the named used by VTK to correspond to a vtkDataAssembly associated with the structure of a composite dataset.

Definition at line 51 of file vtkDataAssemblyUtilities.h.

◆ GetDataAssembly()

static vtkSmartPointer< vtkDataAssembly > vtkDataAssemblyUtilities::GetDataAssembly	(	const char *	name,
		vtkCompositeDataSet *	cd
	)

static

Convenience method to get a named vtkDataAssembly from a vtkCompositeDataSet, if available.

May return nullptr if none exists or possible.

◆ GenerateHierarchy()

static bool vtkDataAssemblyUtilities::GenerateHierarchy	(	vtkCompositeDataSet *	input,
		vtkDataAssembly *	hierarchy,
		vtkPartitionedDataSetCollection *	output = `nullptr`
	)

static

Populates hierarchy with a representation of the hierarchy for the given composite dataset input.

A hierarchy represents the input dataset's structure as represented in the dataset itself.

If output is non-null, then the input is also converted to a vtkPartitionedDataSetCollection. The vtkDataAssembly on the output is updated to be a copy of the hierarchy with correct dataset indices so that relationships in the input blocks are preserved.

If input is not a vtkMultiBlockDataSet, vtkPartitionedDataSetCollection, or vtkUniformGridAMR, then there's no hierarchy to represent and hence this function will return false.

◆ GenerateCompositeDataSetFromHierarchy()

static vtkSmartPointer< vtkCompositeDataSet > vtkDataAssemblyUtilities::GenerateCompositeDataSetFromHierarchy	(	vtkPartitionedDataSetCollection *	input,
		vtkDataAssembly *	hierarchy
	)

static

Inverse of GenerateHierarchy.

Given a vtkPartitionedDataSetCollection and a vtkDataAssembly representing a target hierarchy, create a appropriate vtkCompositeDataSet subclass representing that hierarchy.

A note about vtkOverlappingAMR: since all meta-data necessary for defining a valid vtkOverlappingAMR is not encoded in the hierarchy, the return vtkOverlappingAMR is not complete (or valid) and is missing key meta-data. Calling code must use other mechanisms to make the dataset valid.

◆ GetSelectedCompositeIds()

static std::vector< unsigned int > vtkDataAssemblyUtilities::GetSelectedCompositeIds	(	const std::vector< std::string > &	selectors,
		vtkDataAssembly *	hierarchyOrAssembly,
		vtkPartitionedDataSetCollection *	data = `nullptr`,
		bool	leaf_nodes_only = `false`
	)

static

Given a vtkDataAssembly and collection of selectors, returns a list of selected composite indices for the selected nodes.

The vtkDataAssembly can represent either a hierarchy or simply be an assembly. For the later, an associated vtkPartitionedDataSetCollection must be provided to correctly determine the composite index for the selected nodes. When an hierarchy is used, the hierarchy encodes enough information to determine composite ids and hence the data argument must be nullptr.

leaf_nodes_only can be used to indicate if the composite ids must only refer to leaf nodes i.e. nodes that cannot have additional child nodes.

◆ GetSelectorForCompositeId()

static std::string vtkDataAssemblyUtilities::GetSelectorForCompositeId	(	unsigned int	id,
		vtkDataAssembly *	hierarchy
	)

static

For a vtkDataAssembly representing an hierarchy, returns the selector for the given composite id.

Note, the selectors maybe best-match. When dealing with vtkPartitionedDataSetCollection, for example, a composite id may point to a particular dataset in a nested vtkPartitionedDataSet, however, selectors are simply not expressive enough to pick a dataset at that level and hence will simply point to the parent vtkPartitionedDataSet.

◆ GetSelectorsForCompositeIds()

static std::vector< std::string > vtkDataAssemblyUtilities::GetSelectorsForCompositeIds	(	const std::vector< unsigned int > &	ids,
		vtkDataAssembly *	hierarchy
	)

static

For a vtkDataAssembly representing an hierarchy, returns the selector for the given composite id.

Note, the selectors maybe best-match. When dealing with vtkPartitionedDataSetCollection, for example, a composite id may point to a particular dataset in a nested vtkPartitionedDataSet, however, selectors are simply not expressive enough to pick a dataset at that level and hence will simply point to the parent vtkPartitionedDataSet.

◆ GenerateHierarchyInternal() [1/3]

static bool vtkDataAssemblyUtilities::GenerateHierarchyInternal	(	vtkUniformGridAMR *	input,
		vtkDataAssembly *	hierarchy,
		vtkPartitionedDataSetCollection *	output
	)

staticprotected

◆ GenerateHierarchyInternal() [2/3]

static bool vtkDataAssemblyUtilities::GenerateHierarchyInternal	(	vtkMultiBlockDataSet *	input,
		vtkDataAssembly *	hierarchy,
		vtkPartitionedDataSetCollection *	output
	)

staticprotected

◆ GenerateHierarchyInternal() [3/3]

static bool vtkDataAssemblyUtilities::GenerateHierarchyInternal	(	vtkPartitionedDataSetCollection *	input,
		vtkDataAssembly *	hierarchy,
		vtkPartitionedDataSetCollection *	output
	)

staticprotected

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

Common/DataModel/vtkDataAssemblyUtilities.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkDataAssemblyUtilities()

◆ ~vtkDataAssemblyUtilities()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ HierarchyName()

◆ GetDataAssembly()

◆ GenerateHierarchy()

◆ GenerateCompositeDataSetFromHierarchy()

◆ GetSelectedCompositeIds()

◆ GetSelectorForCompositeId()

◆ GetSelectorsForCompositeIds()

◆ GenerateHierarchyInternal() [1/3]

◆ GenerateHierarchyInternal() [2/3]

◆ GenerateHierarchyInternal() [3/3]