vtkIdList Class Reference

list of point or cell ids More...

#include <vtkIdList.h>

Inheritance diagram for vtkIdList:

Collaboration diagram for vtkIdList:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
void	Initialize ()
int	Allocate (const vtkIdType sz, const int strategy=0)
virtual int	IsA (const char *type)
vtkIdList *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
vtkIdType	GetNumberOfIds ()
vtkIdType	GetId (const vtkIdType i)
void	SetNumberOfIds (const vtkIdType number)
void	SetId (const vtkIdType i, const vtkIdType vtkid)
void	InsertId (const vtkIdType i, const vtkIdType vtkid)
vtkIdType	InsertNextId (const vtkIdType vtkid)
vtkIdType	InsertUniqueId (const vtkIdType vtkid)
vtkIdType *	GetPointer (const vtkIdType i)
vtkIdType *	WritePointer (const vtkIdType i, const vtkIdType number)
void	Reset ()
void	Squeeze ()
void	DeepCopy (vtkIdList *ids)
void	DeleteId (vtkIdType vtkid)
vtkIdType	IsId (vtkIdType vtkid)
void	IntersectWith (vtkIdList *otherIds)
vtkIdType *	Resize (const vtkIdType sz)
void	IntersectWith (vtkIdList &otherIds)
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 vtkIdList *	New ()
static int	IsTypeOf (const char *type)
static vtkIdList *	SafeDownCast (vtkObjectBase *o)
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
	vtkIdList ()
	~vtkIdList ()
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
vtkIdType	NumberOfIds
vtkIdType	Size
vtkIdType *	Ids
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

list of point or cell ids

vtkIdList is used to represent and pass data id's between objects. vtkIdList may represent any type of integer id, but usually represents point and cell ids.

Examples:

vtkIdList (Examples)

Tests:

vtkIdList (Tests)

Definition at line 35 of file vtkIdList.h.

Member Typedef Documentation

typedef vtkObject vtkIdList::Superclass

Definition at line 46 of file vtkIdList.h.

Constructor & Destructor Documentation

vtkIdList::vtkIdList ( )

protected

vtkIdList::~vtkIdList ( )

protected

Member Function Documentation

static vtkIdList* vtkIdList::New ( )

static

void vtkIdList::Initialize

(

)

int vtkIdList::Allocate	(	const vtkIdType	sz,
		const int	strategy = 0
	)

Allocate a capacity for sz ids in the list and set the number of stored ids in the list to 0. strategy is not used.

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

static

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

static

virtual vtkObjectBase* vtkIdList::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkIdList* vtkIdList::NewInstance

(

)

const

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

vtkIdType vtkIdList::GetNumberOfIds ( )

inline

Return the number of id's in the list.

Definition at line 50 of file vtkIdList.h.

vtkIdType vtkIdList::GetId ( const vtkIdType  i )

inline

Return the id at location i.

Definition at line 53 of file vtkIdList.h.

void vtkIdList::SetNumberOfIds

(

const vtkIdType

number

)

Specify the number of ids for this object to hold. Does an allocation as well as setting the number of ids.

void vtkIdList::SetId ( const vtkIdType  i, const vtkIdType  vtkid  )

inline

Set the id at location i. Doesn't do range checking so it's a bit faster than InsertId. Make sure you use SetNumberOfIds() to allocate memory prior to using SetId().

Definition at line 62 of file vtkIdList.h.

void vtkIdList::InsertId ( const vtkIdType  i, const vtkIdType  vtkid  )

inline

Set the id at location i. Does range checking and allocates memory as necessary.

Definition at line 129 of file vtkIdList.h.

vtkIdType vtkIdList::InsertNextId ( const vtkIdType  vtkid )

inline

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

Definition at line 143 of file vtkIdList.h.

vtkIdType vtkIdList::InsertUniqueId

(

const vtkIdType

vtkid

)

If id is not already in list, insert it and return location in list. Otherwise return just location in list.

vtkIdType* vtkIdList::GetPointer ( const vtkIdType  i )

inline

Get a pointer to a particular data index.

Definition at line 77 of file vtkIdList.h.

vtkIdType* vtkIdList::WritePointer	(	const vtkIdType	i,
		const vtkIdType	number
	)

Get a pointer to a particular data index. Make sure data is allocated for the number of items requested. Set MaxId according to the number of data values requested.

void vtkIdList::Reset ( )

inline

Reset to an empty state.

Definition at line 85 of file vtkIdList.h.

void vtkIdList::Squeeze ( )

inline

Free any unused memory.

Definition at line 88 of file vtkIdList.h.

void vtkIdList::DeepCopy

(

vtkIdList *

ids

)

Copy an id list by explicitly copying the internal array.

void vtkIdList::DeleteId

(

vtkIdType

vtkid

)

Delete specified id from list. Will remove all occurrences of id in list.

vtkIdType vtkIdList::IsId ( vtkIdType  vtkid )

inline

Return -1 if id specified is not contained in the list; otherwise return the position in the list.

Definition at line 156 of file vtkIdList.h.

void vtkIdList::IntersectWith

(

vtkIdList *

otherIds

)

Intersect this list with another vtkIdList. Updates current list according to result of intersection operation.

vtkIdType* vtkIdList::Resize

(

const vtkIdType

sz

)

Adjust the size of the id list while maintaining its content (except when being truncated).

void vtkIdList::IntersectWith ( vtkIdList &  otherIds )

inline

Definition at line 111 of file vtkIdList.h.

Member Data Documentation

vtkIdType vtkIdList::NumberOfIds

protected

Definition at line 119 of file vtkIdList.h.

vtkIdType vtkIdList::Size

protected

Definition at line 120 of file vtkIdList.h.

vtkIdType* vtkIdList::Ids

protected

Definition at line 121 of file vtkIdList.h.

---

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

• dox/Common/Core/vtkIdList.h