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

Hold a map from hash-ids (representing sides of cells of multiple types) to details on the cells that claim the corresponding side. More...

#include <vtkCellGridSidesCache.h>

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

Classes

struct  Entry
 Each hash entry corresponds to one or more sides of one or more cells. More...
 
struct  Side
 Records held by a hash-entry that represent the side of one cell. More...
 

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.
 
vtkCellGridSidesCacheNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
std::unordered_map< std::size_t, Entry > & GetHashes ()
 Return the map of hashed side information.
 
template<typename C , typename T = typename C::value_type>
std::size_t HashSide (vtkStringToken shape, const C &conn)
 Compute the hash of a side (but do not insert a side into the map).
 
template<typename C , typename T = typename C::value_type>
void AddSide (vtkStringToken cellType, vtkIdType cell, int side, vtkStringToken shape, const C &conn)
 Add a side with the given shape and connectivity to the request's state.
 
void Initialize ()
 Empty the cache of all hashes.
 
- 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 vtkCellGridSidesCacheNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellGridSidesCacheSafeDownCast (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
 
 vtkCellGridSidesCache ()=default
 
 ~vtkCellGridSidesCache () 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

std::unordered_map< std::size_t, EntryHashes
 
- 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

Hold a map from hash-ids (representing sides of cells of multiple types) to details on the cells that claim the corresponding side.

This class is created by filters such as vtkCellGridComputeSides and vtkCellGridExtractCrinkle; it can be re-used by the same filter and any others that process the same input (since it is stored in a cache available to them).

Definition at line 33 of file vtkCellGridSidesCache.h.

Member Typedef Documentation

◆ Superclass

Definition at line 37 of file vtkCellGridSidesCache.h.

Constructor & Destructor Documentation

◆ vtkCellGridSidesCache()

vtkCellGridSidesCache::vtkCellGridSidesCache ( )
protecteddefault

◆ ~vtkCellGridSidesCache()

vtkCellGridSidesCache::~vtkCellGridSidesCache ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkCellGridSidesCache * vtkCellGridSidesCache::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkCellGridSidesCache::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 vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCellGridSidesCache::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkCellGridSidesCache * vtkCellGridSidesCache::NewInstance ( ) const

◆ PrintSelf()

void vtkCellGridSidesCache::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.

◆ GetHashes()

std::unordered_map< std::size_t, Entry > & vtkCellGridSidesCache::GetHashes ( )
inline

Return the map of hashed side information.

Definition at line 71 of file vtkCellGridSidesCache.h.

◆ HashSide()

template<typename C , typename T = typename C::value_type>
std::size_t vtkCellGridSidesCache::HashSide ( vtkStringToken  shape,
const C &  conn 
)
inline

Compute the hash of a side (but do not insert a side into the map).

Definition at line 75 of file vtkCellGridSidesCache.h.

◆ AddSide()

template<typename C , typename T = typename C::value_type>
void vtkCellGridSidesCache::AddSide ( vtkStringToken  cellType,
vtkIdType  cell,
int  side,
vtkStringToken  shape,
const C &  conn 
)
inline

Add a side with the given shape and connectivity to the request's state.

The shape, conn size, and conn entries are hashed together into a key which is mapped to a set of all the matching sides. The cellType and cell ID are also stored with each matching side; these are used during Finalize() to generate the output map-of-maps returned by GetSides() so that the sides are reported by cell type, cell ID, and then side ID.

Note that the conn entries are hashed in a particular canonical order so that the same hash is generated for sides with point IDs that have been shifted and/or reversed. The hash always starts at the smallest entry of conn and goes in the direction that has the largest next entry. Examples: (3, 2, 0, 1) → starts at index 2 (0) and hashes backwards: (0, 2, 3, 1) (4, 5, 6, 7) → starts at index 0 (4) and hashes backwards: (4, 7, 6, 5) (7, 3, 6, 2) → starts at index 3 (2) and hashes forwards: (2, 7, 3, 6) By storing the cellType, we avoid requiring a global-to-local cell numbering in vtkCellGrid instances (as vtkPolyData incurs) which may hold multiple types of cells.

Definition at line 143 of file vtkCellGridSidesCache.h.

◆ Initialize()

void vtkCellGridSidesCache::Initialize ( )

Empty the cache of all hashes.

Member Data Documentation

◆ Hashes

std::unordered_map<std::size_t, Entry> vtkCellGridSidesCache::Hashes
protected

Definition at line 158 of file vtkCellGridSidesCache.h.


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