VTK
9.4.20250201
|
An internal query object for transcribing cells from input to output. More...
#include <vtkUnstructuredGridToCellGrid.h>
Classes | |
struct | Claim |
A claim on input vtkCell types registered by an output vtkCellMetadata subclass. More... | |
Public Types | |
typedef vtkCellGridQuery | Superclass |
using | BlockAttributesKey = vtkUnstructuredGridFieldAnnotations::BlockAttributesKey |
A key for indexing fields defined on a partitioned dataset collection entry. | |
using | FieldGlom = vtkUnstructuredGridFieldAnnotations::FieldGlom |
Gloms of multiple field names that represent vectors or tensors. | |
using | BlockAttributesValue = vtkUnstructuredGridFieldAnnotations::BlockAttributesValue |
Configuration hints for a partitioned dataset collection entry. | |
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. | |
vtkUnstructuredGridToCellGrid::TranscribeQuery * | NewInstance () const |
bool | Initialize () override |
Override this if your query-result state requires initialization. | |
bool | Finalize () override |
Override this if your query-result state requires finalization. | |
bool | SumOutputCounts () |
Sum counts of all input cell types that generate the same output cell type. | |
void | AddCellAttributes (vtkDataSetAttributes *attributes) |
For each point- or cell-data array from the Input, create an output cell-attribute. | |
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 vtkTypeBool | IsTypeOf (const char *type) |
static vtkUnstructuredGridToCellGrid::TranscribeQuery * | SafeDownCast (vtkObjectBase *o) |
static TranscribeQuery * | New () |
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. | |
Public Attributes | |
int | Phase { 0 } |
The phase of the query: 0 → claiming input cells; 1 → transcribing claimed cells. | |
vtkUnstructuredGrid * | Input { nullptr } |
The input dataset whose cells should be transcribed. | |
vtkCellGrid * | Output { nullptr } |
The output cell-grid. | |
unsigned int | FlatIndex { 0 } |
The flat index of the current Input and Output data objects inside the collection. | |
vtkDataArray * | Coordinates { nullptr } |
The input point-coordinates (3-component) array, which is copied to the output. | |
std::map< int, Claim > | CellTypeMap |
A map from input cell type to counts and the output cell type (if any). | |
std::unordered_map< vtkStringToken, vtkIdType > | OutputAllocations |
A map from output cell type-token to output count. | |
vtkNew< vtkUnstructuredGridFieldAnnotations > | Annotations |
Container for field annotations capture from the input unstructured grid. | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
TranscribeQuery ()=default | |
~TranscribeQuery () override=default | |
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 &) |
Additional Inherited Members | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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 |
An internal query object for transcribing cells from input to output.
Note that before this query is called, the Input grid has its cells counted by type and each type of cell has been claimed by a responder.
Definition at line 75 of file vtkUnstructuredGridToCellGrid.h.
Definition at line 78 of file vtkUnstructuredGridToCellGrid.h.
using vtkUnstructuredGridToCellGrid::TranscribeQuery::BlockAttributesKey = vtkUnstructuredGridFieldAnnotations::BlockAttributesKey |
A key for indexing fields defined on a partitioned dataset collection entry.
Definition at line 136 of file vtkUnstructuredGridToCellGrid.h.
using vtkUnstructuredGridToCellGrid::TranscribeQuery::FieldGlom = vtkUnstructuredGridFieldAnnotations::FieldGlom |
Gloms of multiple field names that represent vectors or tensors.
Definition at line 139 of file vtkUnstructuredGridToCellGrid.h.
using vtkUnstructuredGridToCellGrid::TranscribeQuery::BlockAttributesValue = vtkUnstructuredGridFieldAnnotations::BlockAttributesValue |
Configuration hints for a partitioned dataset collection entry.
Definition at line 142 of file vtkUnstructuredGridToCellGrid.h.
|
protecteddefault |
|
overrideprotecteddefault |
|
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 vtkCellGridQuery.
|
static |
|
protectedvirtual |
Reimplemented from vtkCellGridQuery.
vtkUnstructuredGridToCellGrid::TranscribeQuery * vtkUnstructuredGridToCellGrid::TranscribeQuery::NewInstance | ( | ) | const |
|
static |
|
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.
|
overridevirtual |
Override this if your query-result state requires finalization.
Reimplemented from vtkCellGridQuery.
bool vtkUnstructuredGridToCellGrid::TranscribeQuery::SumOutputCounts | ( | ) |
Sum counts of all input cell types that generate the same output cell type.
This returns true if all the input cells are claimed or false if some are unclaimed.
void vtkUnstructuredGridToCellGrid::TranscribeQuery::AddCellAttributes | ( | vtkDataSetAttributes * | attributes | ) |
For each point- or cell-data array from the Input, create an output cell-attribute.
int vtkUnstructuredGridToCellGrid::TranscribeQuery::Phase { 0 } |
The phase of the query: 0 → claiming input cells; 1 → transcribing claimed cells.
Definition at line 121 of file vtkUnstructuredGridToCellGrid.h.
vtkUnstructuredGrid* vtkUnstructuredGridToCellGrid::TranscribeQuery::Input { nullptr } |
The input dataset whose cells should be transcribed.
Definition at line 123 of file vtkUnstructuredGridToCellGrid.h.
vtkCellGrid* vtkUnstructuredGridToCellGrid::TranscribeQuery::Output { nullptr } |
The output cell-grid.
Definition at line 125 of file vtkUnstructuredGridToCellGrid.h.
unsigned int vtkUnstructuredGridToCellGrid::TranscribeQuery::FlatIndex { 0 } |
The flat index of the current Input and Output data objects inside the collection.
Definition at line 127 of file vtkUnstructuredGridToCellGrid.h.
vtkDataArray* vtkUnstructuredGridToCellGrid::TranscribeQuery::Coordinates { nullptr } |
The input point-coordinates (3-component) array, which is copied to the output.
Definition at line 129 of file vtkUnstructuredGridToCellGrid.h.
std::map<int, Claim> vtkUnstructuredGridToCellGrid::TranscribeQuery::CellTypeMap |
A map from input cell type to counts and the output cell type (if any).
Definition at line 131 of file vtkUnstructuredGridToCellGrid.h.
std::unordered_map<vtkStringToken, vtkIdType> vtkUnstructuredGridToCellGrid::TranscribeQuery::OutputAllocations |
A map from output cell type-token to output count.
Definition at line 133 of file vtkUnstructuredGridToCellGrid.h.
vtkNew<vtkUnstructuredGridFieldAnnotations> vtkUnstructuredGridToCellGrid::TranscribeQuery::Annotations |
Container for field annotations capture from the input unstructured grid.
Definition at line 145 of file vtkUnstructuredGridToCellGrid.h.