VTK  9.3.20240619
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCellGridRangeQuery Class Reference

Compute the range of a component of some vtkCellAttribute. More...

#include <vtkCellGridRangeQuery.h>

Inheritance diagram for vtkCellGridRangeQuery:
[legend]
Collaboration diagram for vtkCellGridRangeQuery:
[legend]

Classes

struct  ComponentRange
 Store the finite/entire range for a single component of a cell-attribute. More...
 

Public Types

typedef vtkCellGridQuery Superclass
 
using CacheMap = std::map< vtkCellAttribute *, std::vector< ComponentRange > >
 
- 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.
 
vtkCellGridRangeQueryNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void SetComponent (int)
 Set/get the component whose range should be computed.
 
virtual int GetComponent ()
 
virtual void SetFiniteRange (vtkTypeBool)
 Set/get whether component whose range should be computed.
 
virtual vtkTypeBool GetFiniteRange ()
 
virtual void SetCellGrid (vtkCellGrid *grid)
 Set/get the cell-grid that holds the cell-attribute's arrays.
 
virtual vtkCellGridGetCellGrid ()
 
virtual void SetCellAttribute (vtkCellAttribute *)
 Set/get the cell-attribute whose range should be computed.
 
virtual vtkCellAttributeGetCellAttribute ()
 
bool Initialize () override
 Invoked during evaluation before any cell-grid responders are run.
 
bool Finalize () override
 Invoked during evaluation after all cell-grid responders are run.
 
void GetRange (int component, double *range)
 Return the computed range (after the query is evaluated).
 
const std::array< double, 2 > & GetRange (int component) const
 
void GetRange (double *range)
 
const std::array< double, 2 > & GetRange () const
 
void AddRange (const std::array< double, 2 > &other)
 Used by query-responders to update the range during evaluation.
 
void AddRange (int component, const std::array< double, 2 > &other)
 This is an additional call that responders can use to provide range for components not currently queried.
 
- 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.
 
vtkCellGridQueryNewInstance () 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.
 
vtkCommandGetCommand (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 vtkCellGridRangeQueryNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellGridRangeQuerySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkCellGridQuery
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellGridQuerySafeDownCast (vtkObjectBase *o)
 
- 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.
 
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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkCellGridRangeQuery ()=default
 
 ~vtkCellGridRangeQuery () override
 
- Protected Member Functions inherited from vtkCellGridQuery
virtual vtkObjectBaseNewInstanceInternal () 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 Component { -2 }
 
vtkTypeBool FiniteRange { false }
 
vtkCellGridCellGrid { nullptr }
 
vtkCellAttributeCellAttribute { nullptr }
 
std::vector< std::array< double, 2 > > Ranges
 
- 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 ()
 

Detailed Description

Compute the range of a component of some vtkCellAttribute.

If FiniteRange is true, then the range will omit any NaN or ±Inf values present in the data. Otherwise (the default), the range may contain these exceptional values.

If Component is

Note that this query is intended to be run by vtkCellGrid::GetRange() since the cell-grid holds a cache of ranges. You may run it outside of this method, but that may cause unnecessary re-computation of ranges.

Definition at line 32 of file vtkCellGridRangeQuery.h.

Member Typedef Documentation

◆ Superclass

Definition at line 36 of file vtkCellGridRangeQuery.h.

◆ CacheMap

Definition at line 108 of file vtkCellGridRangeQuery.h.

Constructor & Destructor Documentation

◆ vtkCellGridRangeQuery()

vtkCellGridRangeQuery::vtkCellGridRangeQuery ( )
protecteddefault

◆ ~vtkCellGridRangeQuery()

vtkCellGridRangeQuery::~vtkCellGridRangeQuery ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkCellGridRangeQuery * vtkCellGridRangeQuery::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkCellGridRangeQuery::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()

static vtkCellGridRangeQuery * vtkCellGridRangeQuery::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCellGridRangeQuery::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCellGridQuery.

◆ NewInstance()

vtkCellGridRangeQuery * vtkCellGridRangeQuery::NewInstance ( ) const

◆ PrintSelf()

void vtkCellGridRangeQuery::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 vtkCellGridQuery.

◆ SetComponent()

virtual void vtkCellGridRangeQuery::SetComponent ( int  )
virtual

Set/get the component whose range should be computed.

This must be modified before the query is evaluated.

◆ GetComponent()

virtual int vtkCellGridRangeQuery::GetComponent ( )
virtual

◆ SetFiniteRange()

virtual void vtkCellGridRangeQuery::SetFiniteRange ( vtkTypeBool  )
virtual

Set/get whether component whose range should be computed.

This must be modified before the query is evaluated.

◆ GetFiniteRange()

virtual vtkTypeBool vtkCellGridRangeQuery::GetFiniteRange ( )
virtual

◆ SetCellGrid()

virtual void vtkCellGridRangeQuery::SetCellGrid ( vtkCellGrid grid)
virtual

Set/get the cell-grid that holds the cell-attribute's arrays.

This must be set before the query is evaluated.

◆ GetCellGrid()

virtual vtkCellGrid * vtkCellGridRangeQuery::GetCellGrid ( )
virtual

◆ SetCellAttribute()

virtual void vtkCellGridRangeQuery::SetCellAttribute ( vtkCellAttribute )
virtual

Set/get the cell-attribute whose range should be computed.

This must be modified before the query is evaluated.

◆ GetCellAttribute()

virtual vtkCellAttribute * vtkCellGridRangeQuery::GetCellAttribute ( )
virtual

◆ Initialize()

bool vtkCellGridRangeQuery::Initialize ( )
overridevirtual

Invoked during evaluation before any cell-grid responders are run.

Reimplemented from vtkCellGridQuery.

◆ Finalize()

bool vtkCellGridRangeQuery::Finalize ( )
overridevirtual

Invoked during evaluation after all cell-grid responders are run.

Reimplemented from vtkCellGridQuery.

◆ GetRange() [1/4]

void vtkCellGridRangeQuery::GetRange ( int  component,
double *  range 
)

Return the computed range (after the query is evaluated).

◆ GetRange() [2/4]

const std::array< double, 2 > & vtkCellGridRangeQuery::GetRange ( int  component) const

◆ GetRange() [3/4]

void vtkCellGridRangeQuery::GetRange ( double *  range)
inline

Definition at line 72 of file vtkCellGridRangeQuery.h.

◆ GetRange() [4/4]

const std::array< double, 2 > & vtkCellGridRangeQuery::GetRange ( ) const
inline

Definition at line 76 of file vtkCellGridRangeQuery.h.

◆ AddRange() [1/2]

void vtkCellGridRangeQuery::AddRange ( const std::array< double, 2 > &  other)

Used by query-responders to update the range during evaluation.

Calling AddRange() with an invalid range has no effect.

◆ AddRange() [2/2]

void vtkCellGridRangeQuery::AddRange ( int  component,
const std::array< double, 2 > &  other 
)

This is an additional call that responders can use to provide range for components not currently queried.

Member Data Documentation

◆ Component

int vtkCellGridRangeQuery::Component { -2 }
protected

Definition at line 114 of file vtkCellGridRangeQuery.h.

◆ FiniteRange

vtkTypeBool vtkCellGridRangeQuery::FiniteRange { false }
protected

Definition at line 115 of file vtkCellGridRangeQuery.h.

◆ CellGrid

vtkCellGrid* vtkCellGridRangeQuery::CellGrid { nullptr }
protected

Definition at line 116 of file vtkCellGridRangeQuery.h.

◆ CellAttribute

vtkCellAttribute* vtkCellGridRangeQuery::CellAttribute { nullptr }
protected

Definition at line 117 of file vtkCellGridRangeQuery.h.

◆ Ranges

std::vector<std::array<double, 2> > vtkCellGridRangeQuery::Ranges
protected

Definition at line 118 of file vtkCellGridRangeQuery.h.


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