VTK
|
Composite dataset that organizes datasets into blocks. More...
#include <vtkMultiBlockDataSet.h>
Public Types | |
typedef vtkDataObjectTree | Superclass |
Public Types inherited from vtkDataObjectTree | |
typedef vtkCompositeDataSet | Superclass |
Public Types inherited from vtkCompositeDataSet | |
typedef vtkDataObject | Superclass |
Public Types inherited from vtkDataObject | |
enum | FieldAssociations { FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS, FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS } |
Possible values for the FIELD_ASSOCIATION information entry. More... | |
enum | AttributeTypes { POINT, CELL, FIELD, POINT_THEN_CELL, VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES } |
Possible attribute types. More... | |
enum | FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED } |
Possible values for the FIELD_OPERATION information entry. More... | |
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... | |
vtkMultiBlockDataSet * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
int | GetDataObjectType () override |
Return class name of data type (see vtkType.h for definitions). More... | |
void | SetNumberOfBlocks (unsigned int numBlocks) |
Set the number of blocks. More... | |
unsigned int | GetNumberOfBlocks () |
Returns the number of blocks. More... | |
vtkDataObject * | GetBlock (unsigned int blockno) |
Returns the block at the given index. More... | |
void | SetBlock (unsigned int blockno, vtkDataObject *block) |
Sets the data object as the given block. More... | |
void | RemoveBlock (unsigned int blockno) |
Remove the given block from the dataset. More... | |
int | HasMetaData (unsigned int blockno) |
Returns true if meta-data is available for a given block. More... | |
vtkInformation * | GetMetaData (unsigned int blockno) |
Returns the meta-data for the block. More... | |
vtkInformation * | GetMetaData (vtkCompositeDataIterator *iter) override |
Unhiding superclass method. More... | |
int | HasMetaData (vtkCompositeDataIterator *iter) override |
Unhiding superclass method. More... | |
Public Member Functions inherited from vtkDataObjectTree | |
vtkDataObjectTree * | NewInstance () const |
virtual vtkDataObjectTreeIterator * | NewTreeIterator () |
Return a new iterator (the iterator has to be deleted by user). More... | |
vtkCompositeDataIterator * | NewIterator () override |
Return a new iterator (the iterator has to be deleted by user). More... | |
void | CopyStructure (vtkCompositeDataSet *input) override |
Copies the tree structure from the input. More... | |
void | SetDataSet (vtkCompositeDataIterator *iter, vtkDataObject *dataObj) override |
Sets the data set at the location pointed by the iterator. More... | |
void | SetDataSetFrom (vtkDataObjectTreeIterator *iter, vtkDataObject *dataObj) |
Sets the data at the location provided by a vtkDataObjectTreeIterator. More... | |
vtkDataObject * | GetDataSet (vtkCompositeDataIterator *iter) override |
Returns the dataset located at the positiong pointed by the iterator. More... | |
unsigned long | GetActualMemorySize () override |
Return the actual size of the data in kibibytes (1024 bytes). More... | |
void | Initialize () override |
Restore data object to initial state,. More... | |
vtkIdType | GetNumberOfPoints () override |
Returns the total number of points of all blocks. More... | |
vtkIdType | GetNumberOfCells () override |
Returns the total number of cells of all blocks. More... | |
void | ShallowCopy (vtkDataObject *src) override |
Shallow and Deep copy. More... | |
void | DeepCopy (vtkDataObject *src) override |
Shallow and Deep copy. More... | |
Public Member Functions inherited from vtkCompositeDataSet | |
vtkCompositeDataSet * | NewInstance () const |
Public Member Functions inherited from vtkDataObject | |
vtkDataObject * | NewInstance () const |
vtkMTimeType | GetMTime () override |
Data objects are composite objects and need to check each part for MTime. More... | |
void | ReleaseData () |
Release data back to system to conserve memory resource. More... | |
vtkMTimeType | GetUpdateTime () |
Used by Threaded ports to determine if they should initiate an asynchronous update (still in development). More... | |
virtual void | CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info)) |
Copy from the pipeline information to the data object's own information. More... | |
virtual void | CopyInformationToPipeline (vtkInformation *vtkNotUsed(info)) |
Copy information from this data object to the pipeline information. More... | |
void | DataHasBeenGenerated () |
This method is called by the source when it executes to generate data. More... | |
virtual void | PrepareForNewData () |
make the output data ready for new data to be inserted. More... | |
virtual int | GetExtentType () |
The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid. More... | |
virtual void | Crop (const int *updateExtent) |
This method crops the data object (if necessary) so that the extent matches the update extent. More... | |
virtual vtkDataSetAttributes * | GetAttributes (int type) |
Returns the attributes of the data object of the specified attribute type. More... | |
virtual vtkFieldData * | GetAttributesAsFieldData (int type) |
Returns the attributes of the data object as a vtkFieldData. More... | |
virtual int | GetAttributeTypeForArray (vtkAbstractArray *arr) |
Retrieves the attribute type that an array came from. More... | |
virtual vtkIdType | GetNumberOfElements (int type) |
Get the number of elements for a specific attribute type (POINT, CELL, etc.). More... | |
virtual vtkInformation * | GetInformation () |
Set/Get the information object associated with this data object. More... | |
virtual void | SetInformation (vtkInformation *) |
Set/Get the information object associated with this data object. More... | |
virtual int | GetDataReleased () |
Get the flag indicating the data has been released. More... | |
virtual void | SetFieldData (vtkFieldData *) |
Assign or retrieve a general field data to this data object. More... | |
virtual vtkFieldData * | GetFieldData () |
Assign or retrieve a general field data to this data object. More... | |
void | GlobalReleaseDataFlagOn () |
Turn on/off flag to control whether every object releases its data after being used by a filter. More... | |
void | GlobalReleaseDataFlagOff () |
Turn on/off flag to control whether every object releases its data after being used by a filter. 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... | |
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 vtkMultiBlockDataSet * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkMultiBlockDataSet * | SafeDownCast (vtkObjectBase *o) |
static vtkMultiBlockDataSet * | GetData (vtkInformation *info) |
Retrieve an instance of this class from an information object. More... | |
static vtkMultiBlockDataSet * | GetData (vtkInformationVector *v, int i=0) |
Retrieve an instance of this class from an information object. More... | |
Static Public Member Functions inherited from vtkDataObjectTree | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkDataObjectTree * | SafeDownCast (vtkObjectBase *o) |
static vtkDataObjectTree * | GetData (vtkInformation *info) |
Retrieve an instance of this class from an information object. More... | |
static vtkDataObjectTree * | GetData (vtkInformationVector *v, int i=0) |
Retrieve an instance of this class from an information object. More... | |
Static Public Member Functions inherited from vtkCompositeDataSet | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkCompositeDataSet * | SafeDownCast (vtkObjectBase *o) |
static vtkInformationStringKey * | NAME () |
Key used to put node name in the meta-data associated with a node. More... | |
static vtkInformationIntegerKey * | CURRENT_PROCESS_CAN_LOAD_BLOCK () |
Key used to indicate that the current process can load the data in the node. More... | |
static vtkCompositeDataSet * | GetData (vtkInformation *info) |
Retrieve an instance of this class from an information object. More... | |
static vtkCompositeDataSet * | GetData (vtkInformationVector *v, int i=0) |
Retrieve an instance of this class from an information object. More... | |
Static Public Member Functions inherited from vtkDataObject | |
static vtkDataObject * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkDataObject * | SafeDownCast (vtkObjectBase *o) |
static vtkInformation * | GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType) |
Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) More... | |
static vtkInformation * | GetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name) |
Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name. More... | |
static void | RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name) |
Remove the info associated with an array. More... | |
static vtkInformation * | SetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType) |
Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More... | |
static void | SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples) |
Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More... | |
static void | SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents) |
Convenience version of previous method for use (primarily) by the Imaging filters. More... | |
static const char * | GetAssociationTypeAsString (int associationType) |
Given an integer association type, this static method returns a string type for the attribute (i.e. More... | |
static int | GetAssociationTypeFromString (const char *associationType) |
Given an integer association type, this static method returns a string type for the attribute (i.e. More... | |
static vtkInformationStringKey * | DATA_TYPE_NAME () |
static vtkInformationDataObjectKey * | DATA_OBJECT () |
static vtkInformationIntegerKey * | DATA_EXTENT_TYPE () |
static vtkInformationIntegerPointerKey * | DATA_EXTENT () |
static vtkInformationIntegerVectorKey * | ALL_PIECES_EXTENT () |
static vtkInformationIntegerKey * | DATA_PIECE_NUMBER () |
static vtkInformationIntegerKey * | DATA_NUMBER_OF_PIECES () |
static vtkInformationIntegerKey * | DATA_NUMBER_OF_GHOST_LEVELS () |
static vtkInformationDoubleKey * | DATA_TIME_STEP () |
static vtkInformationInformationVectorKey * | POINT_DATA_VECTOR () |
static vtkInformationInformationVectorKey * | CELL_DATA_VECTOR () |
static vtkInformationInformationVectorKey * | VERTEX_DATA_VECTOR () |
static vtkInformationInformationVectorKey * | EDGE_DATA_VECTOR () |
static vtkInformationIntegerKey * | FIELD_ARRAY_TYPE () |
static vtkInformationIntegerKey * | FIELD_ASSOCIATION () |
static vtkInformationIntegerKey * | FIELD_ATTRIBUTE_TYPE () |
static vtkInformationIntegerKey * | FIELD_ACTIVE_ATTRIBUTE () |
static vtkInformationIntegerKey * | FIELD_NUMBER_OF_COMPONENTS () |
static vtkInformationIntegerKey * | FIELD_NUMBER_OF_TUPLES () |
static vtkInformationIntegerKey * | FIELD_OPERATION () |
static vtkInformationDoubleVectorKey * | FIELD_RANGE () |
static vtkInformationIntegerVectorKey * | PIECE_EXTENT () |
static vtkInformationStringKey * | FIELD_NAME () |
static vtkInformationDoubleVectorKey * | ORIGIN () |
static vtkInformationDoubleVectorKey * | SPACING () |
static vtkInformationDoubleVectorKey * | BOUNDING_BOX () |
static vtkInformationDataObjectKey * | SIL () |
static vtkDataObject * | GetData (vtkInformation *info) |
Retrieve an instance of this class from an information object. More... | |
static vtkDataObject * | GetData (vtkInformationVector *v, int i=0) |
Retrieve an instance of this class from an information object. More... | |
static void | SetGlobalReleaseDataFlag (int val) |
Turn on/off flag to control whether every object releases its data after being used by a filter. More... | |
static int | GetGlobalReleaseDataFlag () |
Turn on/off flag to control whether every object releases its data after being used by a filter. More... | |
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 |
vtkMultiBlockDataSet () | |
~vtkMultiBlockDataSet () override | |
Protected Member Functions inherited from vtkDataObjectTree | |
vtkDataObjectTree () | |
~vtkDataObjectTree () override | |
void | SetNumberOfChildren (unsigned int num) |
Set the number of children. More... | |
unsigned int | GetNumberOfChildren () |
Get the number of children. More... | |
void | SetChild (unsigned int index, vtkDataObject *) |
Set child dataset at a given index. More... | |
void | RemoveChild (unsigned int index) |
Remove the child at a given index. More... | |
vtkDataObject * | GetChild (unsigned int num) |
Returns a child dataset at a given index. More... | |
vtkInformation * | GetChildMetaData (unsigned int index) |
Returns the meta-data at a given index. More... | |
void | SetChildMetaData (unsigned int index, vtkInformation *info) |
Sets the meta-data at a given index. More... | |
int | HasChildMetaData (unsigned int index) |
Returns if meta-data information is available for the given child index. More... | |
Protected Member Functions inherited from vtkCompositeDataSet | |
vtkCompositeDataSet () | |
~vtkCompositeDataSet () override | |
Protected Member Functions inherited from vtkDataObject | |
vtkDataObject () | |
~vtkDataObject () 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 | CollectRevisions (ostream &) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Additional Inherited Members | |
Protected Attributes inherited from vtkDataObjectTree | |
vtkDataObjectTreeInternals * | Internals |
Protected Attributes inherited from vtkDataObject | |
vtkFieldData * | FieldData |
int | DataReleased |
vtkTimeStamp | UpdateTime |
vtkInformation * | Information |
Protected Attributes inherited from vtkObject | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
Protected Attributes inherited from vtkObjectBase | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Composite dataset that organizes datasets into blocks.
vtkMultiBlockDataSet is a vtkCompositeDataSet that stores a hierarchy of datasets. The dataset collection consists of multiple blocks. Each block can itself be a vtkMultiBlockDataSet, thus providing for a full tree structure. Sub-blocks are usually used to distribute blocks across processors. For example, a 1 block dataset can be distributed as following:
* proc 0: * Block 0: * * ds 0 * * (null) * * proc 1: * Block 0: * * (null) * * ds 1 *
Definition at line 51 of file vtkMultiBlockDataSet.h.
Definition at line 55 of file vtkMultiBlockDataSet.h.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
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 vtkDataObjectTree.
|
static |
|
protectedvirtual |
Reimplemented from vtkDataObjectTree.
vtkMultiBlockDataSet* vtkMultiBlockDataSet::NewInstance | ( | ) | const |
|
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 vtkDataObjectTree.
|
inlineoverridevirtual |
Return class name of data type (see vtkType.h for definitions).
Reimplemented from vtkCompositeDataSet.
Definition at line 62 of file vtkMultiBlockDataSet.h.
void vtkMultiBlockDataSet::SetNumberOfBlocks | ( | unsigned int | numBlocks | ) |
Set the number of blocks.
This will cause allocation if the new number of blocks is greater than the current size. All new blocks are initialized to null.
unsigned int vtkMultiBlockDataSet::GetNumberOfBlocks | ( | ) |
Returns the number of blocks.
vtkDataObject* vtkMultiBlockDataSet::GetBlock | ( | unsigned int | blockno | ) |
Returns the block at the given index.
It is recommended that one uses the iterators to iterate over composite datasets rather than using this API.
void vtkMultiBlockDataSet::SetBlock | ( | unsigned int | blockno, |
vtkDataObject * | block | ||
) |
Sets the data object as the given block.
The total number of blocks will be resized to fit the requested block no.
void vtkMultiBlockDataSet::RemoveBlock | ( | unsigned int | blockno | ) |
Remove the given block from the dataset.
Returns true if meta-data is available for a given block.
Definition at line 96 of file vtkMultiBlockDataSet.h.
|
inline |
Returns the meta-data for the block.
If none is already present, a new vtkInformation object will be allocated. Use HasMetaData to avoid allocating vtkInformation objects.
Definition at line 104 of file vtkMultiBlockDataSet.h.
|
static |
Retrieve an instance of this class from an information object.
|
static |
Retrieve an instance of this class from an information object.
|
inlineoverridevirtual |
Unhiding superclass method.
Reimplemented from vtkDataObjectTree.
Definition at line 118 of file vtkMultiBlockDataSet.h.
|
inlineoverridevirtual |
Unhiding superclass method.
Reimplemented from vtkDataObjectTree.
Definition at line 124 of file vtkMultiBlockDataSet.h.