implicit object to represent cell connectivity More...

#include <vtkStructuredCellArray.h>

Inheritance diagram for vtkStructuredCellArray:

Collaboration diagram for vtkStructuredCellArray:

Classes
struct	vtkStructuredTCellBackend

Public Types
typedef vtkAbstractCellArray	Superclass

Public Types inherited from vtkAbstractCellArray
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.

vtkStructuredCellArray *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	Initialize () override
	Free any memory and reset to an empty state.

vtkIdType	GetNumberOfCells () const override
	Get the number of cells in the array.

vtkIdType	GetNumberOfOffsets () const override
	Get the number of elements in the offsets array.

vtkIdType	GetOffset (vtkIdType cellId) override
	Get the offset (into the connectivity) for a specified cell id.

vtkIdType	GetNumberOfConnectivityIds () const override
	Get the size of the connectivity array that stores the point ids.

void	SetData (int extent[6], bool usePixelVoxelOrientation)
	Create a new cell array given extent and a flag indicating whether the data should be stored in a voxel or pixel orientation.

bool	IsStorageShareable () const override

vtkIdType	IsHomogeneous () override
	Check if all cells have the same number of vertices.

void	GetCellAtId (vtkIdType cellId, vtkIdType &cellSize, vtkIdType const &cellPoints, vtkIdList ptIds) override
	Return the point ids for the cell at cellId.

void	GetCellAtId (vtkIdType cellId, vtkIdList *ptIds) override
	Return the point ids for the cell at cellId.

void	GetCellAtId (vtkIdType cellId, vtkIdType &cellSize, vtkIdType *cellPoints) override
	Return the point ids for the cell at cellId.

void	GetCellAtId (int ijk[3], vtkIdList *ptIds)
	Return the point ids for the cell at ijk.

void	GetCellAtId (int ijk[3], vtkIdType &cellSize, vtkIdType *cellPoints)
	Return the point ids for the cell at ijk.

vtkIdType	GetCellSize (vtkIdType cellId) const override
	Return the size of the cell at cellId.

int	GetMaxCellSize () override
	Returns the size of the largest cell.

void	DeepCopy (vtkAbstractCellArray *ca) override
	Perform a deep copy (no reference counting) of the given cell array.

void	ShallowCopy (vtkAbstractCellArray *ca) override
	Shallow copy ca into this cell array.

Public Member Functions inherited from vtkAbstractCellArray
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAbstractCellArray *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	Initialize ()=0
	Free any memory and reset to an empty state.

virtual vtkIdType	GetNumberOfCells () const =0
	Get the number of cells in the array.

virtual vtkIdType	GetNumberOfOffsets () const =0
	Get the number of elements in the offsets array.

virtual vtkIdType	GetOffset (vtkIdType cellId)=0
	Get the offset (into the connectivity) for a specified cell id.

virtual vtkIdType	GetNumberOfConnectivityIds () const =0
	Get the size of the connectivity array that stores the point ids.

virtual bool	IsStorageShareable () const =0

virtual vtkIdType	IsHomogeneous ()=0
	Check if all cells have the same number of vertices.

void	GetCellAtId (vtkIdType cellId, vtkIdType &cellSize, vtkIdType const *&cellPoints)
	Return the point ids for the cell at cellId.

virtual void	GetCellAtId (vtkIdType cellId, vtkIdType &cellSize, vtkIdType const &cellPoints, vtkIdList ptIds)=0
	Return the point ids for the cell at cellId.

virtual void	GetCellAtId (vtkIdType cellId, vtkIdList *pts)=0
	Return the point ids for the cell at cellId.

virtual void	GetCellAtId (vtkIdType cellId, vtkIdType &cellSize, vtkIdType *cellPoints)=0
	Return the point ids for the cell at cellId.

virtual vtkIdType	GetCellSize (vtkIdType cellId) const =0
	Return the size of the cell at cellId.

virtual int	GetMaxCellSize ()=0
	Returns the size of the largest cell.

virtual void	DeepCopy (vtkAbstractCellArray *ca)=0
	Perform a deep copy (no reference counting) of the given cell array.

virtual void	ShallowCopy (vtkAbstractCellArray *ca)=0
	Shallow copy ca into this cell array.

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 vtkStructuredCellArray *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkStructuredCellArray *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractCellArray
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractCellArray *	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

	vtkStructuredCellArray ()

	~vtkStructuredCellArray () override

Protected Member Functions inherited from vtkAbstractCellArray
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractCellArray ()

	~vtkAbstractCellArray () override

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
vtkSmartPointer< vtkImplicitArray< vtkStructuredCellBackend > >	Connectivity

Protected Attributes inherited from vtkAbstractCellArray
vtkNew< vtkIdList >	TempCell

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

implicit object to represent cell connectivity

vtkStructuredCellArray stores dataset topologies as an structured connectivity table listing the point ids that make up each cell.

Internally, the connectivity is stored as a vtkImplicitArray that is constructed using the SetData function by providing the dimensions of the dataset and a flag indicating whether the data should use voxel/pixel orientation.

This class was designed as a more performant alternative to vtkStructuredData::GetCellPoints.

See also: vtkCellArray vtkAbstractCellArray

Tests:: vtkStructuredCellArray (Tests)

Definition at line 34 of file vtkStructuredCellArray.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAbstractCellArray vtkStructuredCellArray::Superclass

Definition at line 38 of file vtkStructuredCellArray.h.

Constructor & Destructor Documentation

◆ vtkStructuredCellArray()

vtkStructuredCellArray::vtkStructuredCellArray ( )

protected

◆ ~vtkStructuredCellArray()

vtkStructuredCellArray::~vtkStructuredCellArray ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkStructuredCellArray * vtkStructuredCellArray::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkStructuredCellArray::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 vtkAbstractCellArray.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkStructuredCellArray::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractCellArray.

◆ NewInstance()

vtkStructuredCellArray * vtkStructuredCellArray::NewInstance ( ) const

◆ PrintSelf()

void vtkStructuredCellArray::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 vtkAbstractCellArray.

◆ Initialize()

void vtkStructuredCellArray::Initialize ( )

overridevirtual

Free any memory and reset to an empty state.

Implements vtkAbstractCellArray.

◆ GetNumberOfCells()

vtkIdType vtkStructuredCellArray::GetNumberOfCells ( ) const

overridevirtual

Get the number of cells in the array.

Implements vtkAbstractCellArray.

◆ GetNumberOfOffsets()

vtkIdType vtkStructuredCellArray::GetNumberOfOffsets ( ) const

overridevirtual

Get the number of elements in the offsets array.

This will be the number of cells + 1.

Implements vtkAbstractCellArray.

◆ GetOffset()

vtkIdType vtkStructuredCellArray::GetOffset ( vtkIdType cellId )

overridevirtual

Get the offset (into the connectivity) for a specified cell id.

Implements vtkAbstractCellArray.

◆ GetNumberOfConnectivityIds()

vtkIdType vtkStructuredCellArray::GetNumberOfConnectivityIds ( ) const

overridevirtual

Get the size of the connectivity array that stores the point ids.

Note: Do not confuse this with the deprecated GetNumberOfConnectivityEntries(), which refers to the legacy memory layout.

Implements vtkAbstractCellArray.

◆ SetData()

void vtkStructuredCellArray::SetData	(	int	extent[6],
		bool	usePixelVoxelOrientation
	)

Create a new cell array given extent and a flag indicating whether the data should be stored in a voxel or pixel orientation.

◆ IsStorageShareable()

bool vtkStructuredCellArray::IsStorageShareable ( ) const

inlineoverridevirtual

Returns: True if the internal storage can be shared as a pointer to vtkIdType, i.e., the type and organization of internal storage is such that copying of data can be avoided, and instead a pointer to vtkIdType can be used.

Implements vtkAbstractCellArray.

Definition at line 82 of file vtkStructuredCellArray.h.

◆ IsHomogeneous()

vtkIdType vtkStructuredCellArray::IsHomogeneous ( )

overridevirtual

Check if all cells have the same number of vertices.

The return value is coded as:

-1 = heterogeneous
0 = Cell array empty
n (positive integer) = homogeneous array of cell size n

Implements vtkAbstractCellArray.

◆ GetCellAtId() [1/5]

void vtkStructuredCellArray::GetCellAtId	(	vtkIdType	cellId,
		vtkIdType &	cellSize,
		vtkIdType const *&	cellPoints,
		vtkIdList *	ptIds
	)

overridevirtual

Return the point ids for the cell at cellId.

Subsequent calls to this method may invalidate previous call results if the internal storage type is not the same as vtkIdType and cannot be shared through the cellPoints pointer. If that occurs, the method will use ptIds, which is an object that is created by each thread, to guarantee thread safety.

Implements vtkAbstractCellArray.

◆ GetCellAtId() [2/5]

void vtkStructuredCellArray::GetCellAtId	(	vtkIdType	cellId,
		vtkIdList *	ptIds
	)

overridevirtual

Return the point ids for the cell at cellId.

This always copies the cell ids (i.e., the list of points pts into the supplied vtkIdList). This method is thread safe.

Implements vtkAbstractCellArray.

◆ GetCellAtId() [3/5]

void vtkStructuredCellArray::GetCellAtId	(	vtkIdType	cellId,
		vtkIdType &	cellSize,
		vtkIdType *	cellPoints
	)

overridevirtual

Return the point ids for the cell at cellId.

This always copies the cell ids into cellSize and cellPoints. This method is thread safe.

Note: the cellPoints need to have the correct size already allocated otherwise memory issues can occur.

Implements vtkAbstractCellArray.

◆ GetCellAtId() [4/5]

void vtkStructuredCellArray::GetCellAtId	(	int	ijk[3],
		vtkIdList *	ptIds
	)

Return the point ids for the cell at ijk.

This always copies the cell ids (i.e., the list of points pts into the supplied vtkIdList). This method is thread safe.

◆ GetCellAtId() [5/5]

void vtkStructuredCellArray::GetCellAtId	(	int	ijk[3],
		vtkIdType &	cellSize,
		vtkIdType *	cellPoints
	)

Return the point ids for the cell at ijk.

This always copies the cell ids into cellSize cellPoints. This method is thread safe.

Note: the cellPoints need to have the correct size already allocated otherwise memory issues can occur.

◆ GetCellSize()

vtkIdType vtkStructuredCellArray::GetCellSize ( vtkIdType cellId ) const

overridevirtual

Return the size of the cell at cellId.

Implements vtkAbstractCellArray.

◆ GetMaxCellSize()

int vtkStructuredCellArray::GetMaxCellSize ( )

overridevirtual

Returns the size of the largest cell.

The size is the number of points defining the cell.

Implements vtkAbstractCellArray.

◆ DeepCopy()

void vtkStructuredCellArray::DeepCopy ( vtkAbstractCellArray * ca )

overridevirtual

Perform a deep copy (no reference counting) of the given cell array.

Implements vtkAbstractCellArray.

◆ ShallowCopy()

void vtkStructuredCellArray::ShallowCopy ( vtkAbstractCellArray * ca )

overridevirtual

Shallow copy ca into this cell array.

Implements vtkAbstractCellArray.

Member Data Documentation

◆ Connectivity

vtkSmartPointer<vtkImplicitArray<vtkStructuredCellBackend> > vtkStructuredCellArray::Connectivity

protected

Definition at line 172 of file vtkStructuredCellArray.h.

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

Common/DataModel/vtkStructuredCellArray.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkStructuredCellArray()

◆ ~vtkStructuredCellArray()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Initialize()

◆ GetNumberOfCells()

◆ GetNumberOfOffsets()

◆ GetOffset()

◆ GetNumberOfConnectivityIds()

◆ SetData()

◆ IsStorageShareable()

◆ IsHomogeneous()

◆ GetCellAtId() [1/5]

◆ GetCellAtId() [2/5]

◆ GetCellAtId() [3/5]

◆ GetCellAtId() [4/5]

◆ GetCellAtId() [5/5]

◆ GetCellSize()

◆ GetMaxCellSize()

◆ DeepCopy()

◆ ShallowCopy()

Member Data Documentation

◆ Connectivity