VTK  9.7.20261119
vtkCellGridIsocontour::Query Class Reference

#include <vtkCellGridIsocontour.h>

Detailed Description

A cell-grid query for the cells that may hold an isocontour.

Responders report, for their cell type, the IDs of the cells where a scalar cell-attribute may take the isovalue, judged by the bound that the attribute's basis gives on its values in each cell, and the order of the basis there. A cell type no responder can judge is left out.

Definition at line 90 of file vtkCellGridIsocontour.h.

Inheritance diagram for vtkCellGridIsocontour::Query:
[legend]
Collaboration diagram for vtkCellGridIsocontour::Query:
[legend]

Public Types

typedef vtkCellGridQuery Superclass
using CandidateCells = std::unordered_map<vtkStringToken, vtkSmartPointer<vtkIdTypeArray>>
 The IDs of the cells that may hold the isocontour, by cell type.
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.
vtkCellGridIsocontour::Query * NewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
bool Initialize () override
 Forget the cells found by a previous run.
void AddCandidateCells (vtkStringToken cellType, vtkIdTypeArray *cellIds, int order)
 Called by a responder: the cells cellIds of type cellType may hold the isocontour, and the attribute's basis has the order order there.
const CandidateCells & GetCandidateCells () const
 Return the cells that may hold the isocontour, by cell type.
int GetMaximumOrder () const
 Return the highest order of the attribute's basis among the cell types that have candidate cells (0 when there are none).
virtual void SetCellAttribute (vtkCellAttribute *)
virtual vtkCellAttribute * GetCellAttribute ()
virtual void SetIsovalue (double)
virtual double GetIsovalue ()
Public Member Functions inherited from vtkCellGridQuery
vtkCellGridQuery * NewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
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 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 Query * New ()
static vtkTypeBool IsTypeOf (const char *type)
static vtkCellGridIsocontour::Query * SafeDownCast (vtkObjectBase *o)
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.

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 Query ()=default
 ~Query () override
Protected Member Functions inherited from vtkCellGridQuery
 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 ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkCellAttribute * CellAttribute { nullptr }
double Isovalue { 0. }
CandidateCells Candidates
int MaximumOrder { 0 }
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

Additional Inherited Members

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
static vtkReallocingFunction GetCurrentReallocFunction ()
static vtkFreeingFunction GetCurrentFreeFunction ()
static vtkFreeingFunction GetAlternateFreeFunction ()

Member Typedef Documentation

◆ Superclass

◆ CandidateCells

The IDs of the cells that may hold the isocontour, by cell type.

Definition at line 98 of file vtkCellGridIsocontour.h.

Constructor & Destructor Documentation

◆ Query()

vtkCellGridIsocontour::Query::Query ( )
protecteddefault

◆ ~Query()

vtkCellGridIsocontour::Query::~Query ( )
overrideprotected

Member Function Documentation

◆ New()

Query * vtkCellGridIsocontour::Query::New ( )
static

◆ IsTypeOf()

vtkTypeBool vtkCellGridIsocontour::Query::IsTypeOf ( const char * type)
static

◆ IsA()

virtual vtkTypeBool vtkCellGridIsocontour::Query::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 vtkCellGridQuery.

◆ SafeDownCast()

vtkCellGridIsocontour::Query * vtkCellGridIsocontour::Query::SafeDownCast ( vtkObjectBase * o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCellGridIsocontour::Query::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCellGridQuery.

◆ NewInstance()

vtkCellGridIsocontour::Query * vtkCellGridIsocontour::Query::NewInstance ( ) const

◆ PrintSelf()

void vtkCellGridIsocontour::Query::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 vtkObjectBase.

◆ Initialize()

bool vtkCellGridIsocontour::Query::Initialize ( )
overridevirtual

Forget the cells found by a previous run.

Reimplemented from vtkCellGridQuery.

◆ SetCellAttribute()

virtual void vtkCellGridIsocontour::Query::SetCellAttribute ( vtkCellAttribute * )
virtual

Set/get the scalar cell-attribute whose isocontour is sought.

◆ GetCellAttribute()

virtual vtkCellAttribute * vtkCellGridIsocontour::Query::GetCellAttribute ( )
virtual

Set/get the scalar cell-attribute whose isocontour is sought.

◆ SetIsovalue()

virtual void vtkCellGridIsocontour::Query::SetIsovalue ( double )
virtual

Set/get the isovalue.

◆ GetIsovalue()

virtual double vtkCellGridIsocontour::Query::GetIsovalue ( )
virtual

Set/get the isovalue.

◆ AddCandidateCells()

void vtkCellGridIsocontour::Query::AddCandidateCells ( vtkStringToken cellType,
vtkIdTypeArray * cellIds,
int order )

Called by a responder: the cells cellIds of type cellType may hold the isocontour, and the attribute's basis has the order order there.

A cell type with no such cell need not be reported.

◆ GetCandidateCells()

const CandidateCells & vtkCellGridIsocontour::Query::GetCandidateCells ( ) const
inline

Return the cells that may hold the isocontour, by cell type.

Definition at line 121 of file vtkCellGridIsocontour.h.

◆ GetMaximumOrder()

int vtkCellGridIsocontour::Query::GetMaximumOrder ( ) const
inline

Return the highest order of the attribute's basis among the cell types that have candidate cells (0 when there are none).

Definition at line 125 of file vtkCellGridIsocontour.h.

Member Data Documentation

◆ CellAttribute

vtkCellAttribute* vtkCellGridIsocontour::Query::CellAttribute { nullptr }
protected

Definition at line 131 of file vtkCellGridIsocontour.h.

◆ Isovalue

double vtkCellGridIsocontour::Query::Isovalue { 0. }
protected

Definition at line 132 of file vtkCellGridIsocontour.h.

◆ Candidates

CandidateCells vtkCellGridIsocontour::Query::Candidates
protected

Definition at line 133 of file vtkCellGridIsocontour.h.

◆ MaximumOrder

int vtkCellGridIsocontour::Query::MaximumOrder { 0 }
protected

Definition at line 134 of file vtkCellGridIsocontour.h.


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