object provides direct access to cells in vtkCellArray and type information More...

#include <vtkCellTypes.h>

Inheritance diagram for vtkCellTypes:

Collaboration diagram for vtkCellTypes:

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. More...

vtkCellTypes *	NewInstance () const

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

int	Allocate (vtkIdType sz=512, vtkIdType ext=1000)
	Allocate memory for this array. More...

void	InsertCell (vtkIdType id, unsigned char type, vtkIdType loc)
	Add a cell at specified id. More...

vtkIdType	InsertNextCell (unsigned char type, vtkIdType loc)
	Add a cell to the object in the next available slot. More...

void	SetCellTypes (vtkIdType ncells, vtkUnsignedCharArray cellTypes, vtkIdTypeArray cellLocations)
	Specify a group of cell types. More...

void	SetCellTypes (vtkIdType ncells, vtkUnsignedCharArray cellTypes, vtkIntArray cellLocations)
	Specify a group of cell types. More...

vtkIdType	GetCellLocation (vtkIdType cellId)
	Return the location of the cell in the associated vtkCellArray. More...

void	DeleteCell (vtkIdType cellId)
	Delete cell by setting to nullptr cell type. More...

vtkIdType	GetNumberOfTypes ()
	Return the number of types in the list. More...

int	IsType (unsigned char type)
	Return 1 if type specified is contained in list; 0 otherwise. More...

vtkIdType	InsertNextType (unsigned char type)
	Add the type specified to the end of the list. More...

unsigned char	GetCellType (vtkIdType cellId)
	Return the type of cell. More...

void	Squeeze ()
	Reclaim any extra memory. More...

void	Reset ()
	Initialize object without releasing memory. More...

unsigned long	GetActualMemorySize ()
	Return the memory in kibibytes (1024 bytes) consumed by this cell type array. More...

void	DeepCopy (vtkCellTypes *src)
	Standard DeepCopy method. More...


vtkUnsignedCharArray *	GetCellTypesArray ()
	Methods for obtaining the arrays representing types and locations. More...

vtkIdTypeArray *	GetCellLocationsArray ()
	Methods for obtaining the arrays representing types and locations. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

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

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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. More...

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. More...

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. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

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). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

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

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

Static Public Member Functions
static vtkCellTypes *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkCellTypes *	SafeDownCast (vtkObjectBase *o)

static const char *	GetClassNameFromTypeId (int typeId)
	Given an int (as defined in vtkCellType.h) identifier for a class return it's classname. More...

static int	GetTypeIdFromClassName (const char *classname)
	Given a data object classname, return it's int identified (as defined in vtkCellType.h) More...

static int	IsLinear (unsigned char type)
	This convenience method is a fast check to determine if a cell type represents a linear or nonlinear cell. More...

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. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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. More...

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). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

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. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCellTypes ()

	~vtkCellTypes () 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. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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 *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkUnsignedCharArray *	TypeArray

vtkIdTypeArray *	LocationArray

vtkIdType	Size

vtkIdType	MaxId

vtkIdType	Extend

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

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

object provides direct access to cells in vtkCellArray and type information

This class is a supplemental object to vtkCellArray to allow random access into cells as well as representing cell type information. The "location" field is the location in the vtkCellArray list in terms of an integer offset. An integer offset was used instead of a pointer for easy storage and inter-process communication. The type information is defined in the file vtkCellType.h.

Warning: Sometimes this class is used to pass type information independent of the random access (i.e., location) information. For example, see vtkDataSet::GetCellTypes(). If you use the class in this way, you can use a location value of -1.

See also: vtkCellArray vtkCellLinks

Online Examples:

CellTypeSource

DumpXMLFile

ReadLegacyUnstructuredGrid

ClipDataSetWithPolyData

TableBasedClipDataSetWithPolyData

ClipUnstructuredGridWithPlane

ClipUnstructuredGridWithPlane2

ExtractFaces

Definition at line 136 of file vtkCellTypes.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkCellTypes::Superclass

Definition at line 140 of file vtkCellTypes.h.

Constructor & Destructor Documentation

◆ vtkCellTypes()

vtkCellTypes::vtkCellTypes ( )

protected

◆ ~vtkCellTypes()

vtkCellTypes::~vtkCellTypes ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkCellTypes * vtkCellTypes::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkCellTypes::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 vtkCellTypes * vtkCellTypes::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCellTypes::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkCellTypes * vtkCellTypes::NewInstance ( ) const

◆ PrintSelf()

void vtkCellTypes::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 vtkObject.

◆ Allocate()

int vtkCellTypes::Allocate	(	vtkIdType	sz = `512`,
		vtkIdType	ext = `1000`
	)

Allocate memory for this array.

Delete old storage only if necessary.

◆ InsertCell()

void vtkCellTypes::InsertCell	(	vtkIdType	id,
		unsigned char	type,
		vtkIdType	loc
	)

Add a cell at specified id.

◆ InsertNextCell()

vtkIdType vtkCellTypes::InsertNextCell	(	unsigned char	type,
		vtkIdType	loc
	)

Add a cell to the object in the next available slot.

◆ SetCellTypes() [1/2]

void vtkCellTypes::SetCellTypes	(	vtkIdType	ncells,
		vtkUnsignedCharArray *	cellTypes,
		vtkIdTypeArray *	cellLocations
	)

Specify a group of cell types.

◆ SetCellTypes() [2/2]

void vtkCellTypes::SetCellTypes	(	vtkIdType	ncells,
		vtkUnsignedCharArray *	cellTypes,
		vtkIntArray *	cellLocations
	)

Specify a group of cell types.

This version is provided to maintain backwards compatibility and does a copy of the cellLocations

◆ GetCellLocation()

vtkIdType vtkCellTypes::GetCellLocation ( vtkIdType cellId )

inline

Return the location of the cell in the associated vtkCellArray.

Definition at line 173 of file vtkCellTypes.h.

◆ DeleteCell()

void vtkCellTypes::DeleteCell ( vtkIdType cellId )

inline

Delete cell by setting to nullptr cell type.

Definition at line 178 of file vtkCellTypes.h.

◆ GetNumberOfTypes()

vtkIdType vtkCellTypes::GetNumberOfTypes ( )

inline

Return the number of types in the list.

Definition at line 183 of file vtkCellTypes.h.

◆ IsType()

int vtkCellTypes::IsType ( unsigned char type )

inline

Return 1 if type specified is contained in list; 0 otherwise.

Definition at line 270 of file vtkCellTypes.h.

◆ InsertNextType()

vtkIdType vtkCellTypes::InsertNextType ( unsigned char type )

inline

Add the type specified to the end of the list.

Range checking is performed.

Definition at line 193 of file vtkCellTypes.h.

◆ GetCellType()

unsigned char vtkCellTypes::GetCellType ( vtkIdType cellId )

inline

Return the type of cell.

Definition at line 198 of file vtkCellTypes.h.

◆ Squeeze()

void vtkCellTypes::Squeeze ( )

Reclaim any extra memory.

◆ Reset()

void vtkCellTypes::Reset ( )

Initialize object without releasing memory.

◆ GetActualMemorySize()

unsigned long vtkCellTypes::GetActualMemorySize ( )

Return the memory in kibibytes (1024 bytes) consumed by this cell type array.

Used to support streaming and reading/writing data. The value returned is guaranteed to be greater than or equal to the memory required to actually represent the data represented by this object. The information returned is valid only after the pipeline has been updated.

◆ DeepCopy()

void vtkCellTypes::DeepCopy ( vtkCellTypes * src )

Standard DeepCopy method.

Since this object contains no reference to other objects, there is no ShallowCopy.

◆ GetClassNameFromTypeId()

static const char * vtkCellTypes::GetClassNameFromTypeId ( int typeId )

static

Given an int (as defined in vtkCellType.h) identifier for a class return it's classname.

◆ GetTypeIdFromClassName()

static int vtkCellTypes::GetTypeIdFromClassName ( const char * classname )

static

Given a data object classname, return it's int identified (as defined in vtkCellType.h)

◆ IsLinear()

int vtkCellTypes::IsLinear ( unsigned char type )

inlinestatic

This convenience method is a fast check to determine if a cell type represents a linear or nonlinear cell.

This is generally much more efficient than getting the appropriate vtkCell and checking its IsLinear method.

Definition at line 285 of file vtkCellTypes.h.

◆ GetCellTypesArray()

vtkUnsignedCharArray * vtkCellTypes::GetCellTypesArray ( )

inline

Methods for obtaining the arrays representing types and locations.

Definition at line 250 of file vtkCellTypes.h.

◆ GetCellLocationsArray()

vtkIdTypeArray * vtkCellTypes::GetCellLocationsArray ( )

inline

Methods for obtaining the arrays representing types and locations.

Definition at line 251 of file vtkCellTypes.h.

Member Data Documentation

◆ TypeArray

vtkUnsignedCharArray* vtkCellTypes::TypeArray

protected

Definition at line 258 of file vtkCellTypes.h.

◆ LocationArray

vtkIdTypeArray* vtkCellTypes::LocationArray

protected

Definition at line 259 of file vtkCellTypes.h.

◆ Size

vtkIdType vtkCellTypes::Size

protected

Definition at line 260 of file vtkCellTypes.h.

◆ MaxId

vtkIdType vtkCellTypes::MaxId

protected

Definition at line 261 of file vtkCellTypes.h.

◆ Extend

vtkIdType vtkCellTypes::Extend

protected

Definition at line 262 of file vtkCellTypes.h.

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

Common/DataModel/vtkCellTypes.h

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

◆ vtkCellTypes()

◆ ~vtkCellTypes()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Allocate()

◆ InsertCell()

◆ InsertNextCell()

◆ SetCellTypes() [1/2]

◆ SetCellTypes() [2/2]

◆ GetCellLocation()

◆ DeleteCell()

◆ GetNumberOfTypes()

◆ IsType()

◆ InsertNextType()

◆ GetCellType()

◆ Squeeze()

◆ Reset()

◆ GetActualMemorySize()

◆ DeepCopy()

◆ GetClassNameFromTypeId()

◆ GetTypeIdFromClassName()

◆ IsLinear()

◆ GetCellTypesArray()

◆ GetCellLocationsArray()

Member Data Documentation

◆ TypeArray

◆ LocationArray

◆ Size

◆ MaxId

◆ Extend