VTK
9.4.20241106
|
Perform an operation on cells in a vtkCellMetadata instance. More...
#include <vtkCellGridQuery.h>
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. | |
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 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. | |
Protected Member Functions | |
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 &) |
Protected Attributes | |
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 |
Additional Inherited Members | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
Perform an operation on cells in a vtkCellMetadata instance.
This is an empty base class that all query types must inherit.
The vtkCellGrid::Query()
method calls the query's Initialize()
implementation; then loops over all its cell-types (calling the best-matching responder's Query()
method for that cell-type); then calls Finalize()
.
The responders have an opportunity to modify the state of the query object, so these methods are a chance to prepare your query's state and then perform reduce-like computations after all the cells have been handled.
Definition at line 26 of file vtkCellGridQuery.h.
Definition at line 29 of file vtkCellGridQuery.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 vtkObjectBase.
Reimplemented in vtkCellGridBoundsQuery, vtkCellGridCopyQuery, vtkCellGridEvaluator, vtkCellGridRangeQuery, vtkCellGridSidesQuery, vtkCellGridCellCenters::Query, vtkCellGridCellSource::Query, vtkCellGridElevationQuery, vtkCellGridToUnstructuredGrid::Query, vtkCellGridTransform::Query, vtkCellGridWarp::Query, vtkUnstructuredGridToCellGrid::TranscribeQuery, vtkCellGridIOQuery, and vtkCellGridRenderRequest.
|
static |
|
protectedvirtual |
Reimplemented in vtkCellGridBoundsQuery, vtkCellGridCopyQuery, vtkCellGridEvaluator, vtkCellGridRangeQuery, vtkCellGridSidesQuery, vtkCellGridCellCenters::Query, vtkCellGridCellSource::Query, vtkCellGridElevationQuery, vtkCellGridToUnstructuredGrid::Query, vtkCellGridTransform::Query, vtkCellGridWarp::Query, vtkUnstructuredGridToCellGrid::TranscribeQuery, vtkCellGridIOQuery, and vtkCellGridRenderRequest.
vtkCellGridQuery * vtkCellGridQuery::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 vtkObjectBase.
Reimplemented in vtkCellGridRangeQuery, vtkCellGridSidesQuery, and vtkCellGridRenderRequest.
|
virtual |
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 in vtkCellGridBoundsQuery, vtkCellGridCopyQuery, vtkCellGridEvaluator, vtkCellGridRangeQuery, vtkCellGridSidesQuery, vtkCellGridCellCenters::Query, vtkCellGridElevationQuery, vtkCellGridToUnstructuredGrid::Query, vtkUnstructuredGridToCellGrid::TranscribeQuery, and vtkCellGridRenderRequest.
|
virtual |
Mark the start of a pass through each cell type.
This increments the Pass ivar which responders can access.
You may override this method to do additional work, but you must be careful to call the base method from your override.
Reimplemented in vtkCellGridEvaluator, vtkCellGridSidesQuery, and vtkCellGridToUnstructuredGrid::Query.
|
virtual |
Return the current pass (the number of times each responder has been evaluated so far).
|
inlinevirtual |
Override this if your query allows responders to execute in multiple phases.
This method may do work in addition to returning whether another pass is needed.
Reimplemented in vtkCellGridEvaluator, vtkCellGridSidesQuery, vtkCellGridCellCenters::Query, and vtkCellGridToUnstructuredGrid::Query.
Definition at line 53 of file vtkCellGridQuery.h.
|
inlinevirtual |
Override this if your query-result state requires finalization.
Reimplemented in vtkCellGridCopyQuery, vtkCellGridEvaluator, vtkCellGridRangeQuery, vtkCellGridSidesQuery, vtkCellGridElevationQuery, vtkCellGridToUnstructuredGrid::Query, vtkUnstructuredGridToCellGrid::TranscribeQuery, and vtkCellGridRenderRequest.
Definition at line 56 of file vtkCellGridQuery.h.
|
protected |
Definition at line 62 of file vtkCellGridQuery.h.