VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCellTypes Class Reference

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

#include <vtkCellTypes.h>

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

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...
 
vtkCellTypesNewInstance () 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...
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkCellTypesNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellTypesSafeDownCast (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 vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkUnsignedCharArrayTypeArray
 
vtkIdTypeArrayLocationArray
 
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
 

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

Definition at line 47 of file vtkCellTypes.h.

Member Typedef Documentation

◆ Superclass

Definition at line 51 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 84 of file vtkCellTypes.h.

◆ DeleteCell()

void vtkCellTypes::DeleteCell ( vtkIdType  cellId)
inline

Delete cell by setting to nullptr cell type.

Definition at line 89 of file vtkCellTypes.h.

◆ GetNumberOfTypes()

vtkIdType vtkCellTypes::GetNumberOfTypes ( )
inline

Return the number of types in the list.

Definition at line 94 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 173 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 104 of file vtkCellTypes.h.

◆ GetCellType()

unsigned char vtkCellTypes::GetCellType ( vtkIdType  cellId)
inline

Return the type of cell.

Definition at line 109 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 188 of file vtkCellTypes.h.

Member Data Documentation

◆ TypeArray

vtkUnsignedCharArray* vtkCellTypes::TypeArray
protected

Definition at line 161 of file vtkCellTypes.h.

◆ LocationArray

vtkIdTypeArray* vtkCellTypes::LocationArray
protected

Definition at line 162 of file vtkCellTypes.h.

◆ Size

vtkIdType vtkCellTypes::Size
protected

Definition at line 163 of file vtkCellTypes.h.

◆ MaxId

vtkIdType vtkCellTypes::MaxId
protected

Definition at line 164 of file vtkCellTypes.h.

◆ Extend

vtkIdType vtkCellTypes::Extend
protected

Definition at line 165 of file vtkCellTypes.h.


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