VTK  9.0.20210510
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
vtkDataAssemblyUtilities Class Reference

collections of utilities for vtkDataAssembly More...

#include <vtkDataAssemblyUtilities.h>

Inheritance diagram for vtkDataAssemblyUtilities:
[legend]
Collaboration diagram for vtkDataAssemblyUtilities:
[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...
 
vtkDataAssemblyUtilitiesNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. 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...
 
vtkCommandGetCommand (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 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). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkDataAssemblyUtilitiesNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataAssemblyUtilitiesSafeDownCast (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. More...
 
static vtkSmartPointer< vtkDataAssemblyGetDataAssembly (const char *name, vtkCompositeDataSet *cd)
 Convenience method to get a named vtkDataAssembly from a vtkCompositeDataSet, if available. More...
 
static bool GenerateHierarchy (vtkCompositeDataSet *input, vtkDataAssembly *hierarchy, vtkPartitionedDataSetCollection *output=nullptr)
 Populates hierarchy with a representation of the hierarchy for the given composite dataset input. More...
 
static vtkSmartPointer< vtkCompositeDataSetGenerateCompositeDataSetFromHierarchy (vtkPartitionedDataSetCollection *input, vtkDataAssembly *hierarchy)
 Inverse of GenerateHierarchy. More...
 
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. More...
 
static std::string GetSelectorForCompositeId (unsigned int id, vtkDataAssembly *hierarchy)
 For a vtkDataAssembly representing an hierarchy, returns the selector for the given composite id. More...
 
- 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 ()
 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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. 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 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

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.

◆ 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: