vtkCellTypes Class Reference

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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkCellTypes *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
int	Allocate (int sz=512, int ext=1000)
void	InsertCell (int id, unsigned char type, int loc)
vtkIdType	InsertNextCell (unsigned char type, int loc)
void	SetCellTypes (int ncells, vtkUnsignedCharArray *cellTypes, vtkIntArray *cellLocations)
vtkIdType	GetCellLocation (int cellId)
void	DeleteCell (vtkIdType cellId)
vtkIdType	GetNumberOfTypes ()
int	IsType (unsigned char type)
vtkIdType	InsertNextType (unsigned char type)
unsigned char	GetCellType (int cellId)
void	Squeeze ()
void	Reset ()
unsigned long	GetActualMemorySize ()
void	DeepCopy (vtkCellTypes *src)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
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)
int	InvokeEvent (unsigned long event, void *callData)
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
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkCellTypes *	New ()
static int	IsTypeOf (const char *type)
static vtkCellTypes *	SafeDownCast (vtkObjectBase *o)
static const char *	GetClassNameFromTypeId (int typeId)
static int	GetTypeIdFromClassName (const char *classname)
static int	IsLinear (unsigned char type)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkCellTypes ()
	~vtkCellTypes ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
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
vtkUnsignedCharArray *	TypeArray
vtkIntArray *	LocationArray
vtkIdType	Size
vtkIdType	MaxId
vtkIdType	Extend
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	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

Examples:

vtkCellTypes (Examples)

Tests:

vtkCellTypes (Tests)

Definition at line 51 of file vtkCellTypes.h.

Member Typedef Documentation

typedef vtkObject vtkCellTypes::Superclass

Definition at line 55 of file vtkCellTypes.h.

Constructor & Destructor Documentation

vtkCellTypes::vtkCellTypes ( )

protected

vtkCellTypes::~vtkCellTypes ( )

protected

Member Function Documentation

static vtkCellTypes* vtkCellTypes::New ( )

static

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

static

virtual int 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 vtkObject.

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

static

virtual vtkObjectBase* vtkCellTypes::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkCellTypes* vtkCellTypes::NewInstance

(

)

const

void vtkCellTypes::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

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.

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

Allocate memory for this array. Delete old storage only if necessary.

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

Add a cell at specified id.

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

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

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

Specify a group of cell types.

vtkIdType vtkCellTypes::GetCellLocation ( int  cellId )

inline

Return the location of the cell in the associated vtkCellArray.

Definition at line 71 of file vtkCellTypes.h.

void vtkCellTypes::DeleteCell ( vtkIdType  cellId )

inline

Delete cell by setting to NULL cell type.

Definition at line 74 of file vtkCellTypes.h.

vtkIdType vtkCellTypes::GetNumberOfTypes ( )

inline

Return the number of types in the list.

Definition at line 77 of file vtkCellTypes.h.

int vtkCellTypes::IsType ( unsigned char  type )

inline

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

Definition at line 138 of file vtkCellTypes.h.

vtkIdType vtkCellTypes::InsertNextType ( unsigned char  type )

inline

Add the type specified to the end of the list. Range checking is performed.

Definition at line 84 of file vtkCellTypes.h.

unsigned char vtkCellTypes::GetCellType ( int  cellId )

inline

Return the type of cell.

Definition at line 87 of file vtkCellTypes.h.

void vtkCellTypes::Squeeze

(

)

Reclaim any extra memory.

void vtkCellTypes::Reset

(

)

Initialize object without releasing memory.

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.

void vtkCellTypes::DeepCopy

(

vtkCellTypes *

src

)

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

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

static

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

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

static

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

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 153 of file vtkCellTypes.h.

Member Data Documentation

vtkUnsignedCharArray* vtkCellTypes::TypeArray

protected

Definition at line 125 of file vtkCellTypes.h.

vtkIntArray* vtkCellTypes::LocationArray

protected

Definition at line 126 of file vtkCellTypes.h.

vtkIdType vtkCellTypes::Size

protected

Definition at line 127 of file vtkCellTypes.h.

vtkIdType vtkCellTypes::MaxId

protected

Definition at line 128 of file vtkCellTypes.h.

vtkIdType vtkCellTypes::Extend

protected

Definition at line 129 of file vtkCellTypes.h.

---

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

• dox/Common/DataModel/vtkCellTypes.h