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

collection of helper functions for working with DIY More...

#include <vtkDIYUtilities.h>

Inheritance diagram for vtkDIYUtilities:
[legend]
Collaboration diagram for vtkDIYUtilities:
[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...
 
vtkDIYUtilitiesNewInstance () 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDIYUtilitiesSafeDownCast (vtkObjectBase *o)
 
static void InitializeEnvironmentForDIY ()
 In MPI-enabled builds, DIY filters need MPI to be initialized. More...
 
static diy::mpi::communicator GetCommunicator (vtkMultiProcessController *controller)
 Converts a vtkMultiProcessController to a diy::mpi::communicator. More...
 
static void Save (diy::BinaryBuffer &bb, vtkDataSet *)
 Load/Save a vtkDataSet in a diy::BinaryBuffer. More...
 
static void Load (diy::BinaryBuffer &bb, vtkDataSet *&)
 
static void AllReduce (diy::mpi::communicator &comm, vtkBoundingBox &bbox)
 Reduce bounding box. More...
 
static diy::ContinuousBounds Convert (const vtkBoundingBox &bbox)
 Convert vtkBoundingBox to diy::ContinuousBounds. More...
 
static vtkBoundingBox Convert (const diy::ContinuousBounds &bds)
 Convert diy::ContinuousBounds to vtkBoundingBox. More...
 
static void Broadcast (diy::mpi::communicator &comm, std::vector< vtkBoundingBox > &boxes, int source)
 Broadcast a vector of bounding boxes. More...
 
static std::vector< vtkDataSet * > GetDataSets (vtkDataObject *dobj)
 Extract datasets from the given data object. More...
 
static std::vector< vtkSmartPointer< vtkPoints > > ExtractPoints (const std::vector< vtkDataSet * > &datasets, bool use_cell_centers)
 Extracts points from the input. 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDIYUtilities ()
 
 ~vtkDIYUtilities () 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

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

collection of helper functions for working with DIY

vtkDIYUtilities provides a set of utility functions when using DIY in a VTK filters.

Definition at line 42 of file vtkDIYUtilities.h.

Member Typedef Documentation

◆ Superclass

Definition at line 45 of file vtkDIYUtilities.h.

Constructor & Destructor Documentation

◆ vtkDIYUtilities()

vtkDIYUtilities::vtkDIYUtilities ( )
protected

◆ ~vtkDIYUtilities()

vtkDIYUtilities::~vtkDIYUtilities ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkDIYUtilities::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 vtkDIYUtilities* vtkDIYUtilities::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkDIYUtilities::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkDIYUtilities* vtkDIYUtilities::NewInstance ( ) const

◆ PrintSelf()

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

◆ InitializeEnvironmentForDIY()

static void vtkDIYUtilities::InitializeEnvironmentForDIY ( )
static

In MPI-enabled builds, DIY filters need MPI to be initialized.

Calling this method in such filters will ensure that that's the case.

◆ GetCommunicator()

static diy::mpi::communicator vtkDIYUtilities::GetCommunicator ( vtkMultiProcessController controller)
static

Converts a vtkMultiProcessController to a diy::mpi::communicator.

If controller is nullptr or not a vtkMPIController, then diy::mpi::communicator(MPI_COMM_NULL) is created.

◆ Save()

static void vtkDIYUtilities::Save ( diy::BinaryBuffer &  bb,
vtkDataSet  
)
static

Load/Save a vtkDataSet in a diy::BinaryBuffer.

◆ Load()

static void vtkDIYUtilities::Load ( diy::BinaryBuffer &  bb,
vtkDataSet *&   
)
static

◆ AllReduce()

static void vtkDIYUtilities::AllReduce ( diy::mpi::communicator &  comm,
vtkBoundingBox bbox 
)
static

Reduce bounding box.

◆ Convert() [1/2]

static diy::ContinuousBounds vtkDIYUtilities::Convert ( const vtkBoundingBox bbox)
static

Convert vtkBoundingBox to diy::ContinuousBounds.

Note, there is a loss of precision since vtkBoundingBox uses double while diy::ContinuousBounds uses float.

◆ Convert() [2/2]

static vtkBoundingBox vtkDIYUtilities::Convert ( const diy::ContinuousBounds &  bds)
static

Convert diy::ContinuousBounds to vtkBoundingBox.

Note, there is a change of precision since vtkBoundingBox uses double while diy::ContinuousBounds uses float.

◆ Broadcast()

static void vtkDIYUtilities::Broadcast ( diy::mpi::communicator &  comm,
std::vector< vtkBoundingBox > &  boxes,
int  source 
)
static

Broadcast a vector of bounding boxes.

Only the source vector needs to have a valid size.

◆ GetDataSets()

static std::vector<vtkDataSet*> vtkDIYUtilities::GetDataSets ( vtkDataObject dobj)
static

Extract datasets from the given data object.

This method returns a vector of vtkDataSet* from the dobj. If dobj is a vtkDataSet, the returned vector will have just 1 vtkDataSet. If dobj is a vtkCompositeDataSet, then we iterate over it and add all non-null leaf nodes to the returned vector.

◆ ExtractPoints()

static std::vector<vtkSmartPointer<vtkPoints> > vtkDIYUtilities::ExtractPoints ( const std::vector< vtkDataSet * > &  datasets,
bool  use_cell_centers 
)
static

Extracts points from the input.

If input is not a vtkPointSet, it will use an appropriate filter to extract the vtkPoints. If use_cell_centers is true, cell-centers will be computed and extracted instead of the dataset points.


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