VTK
9.0.20210117
|
list of point or cell ids More...
#include <vtkIdList.h>
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... | |
vtkIdList * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
void | Initialize () |
Release memory and restore to unallocated state. More... | |
int | 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. More... | |
vtkIdType | GetNumberOfIds () |
Return the number of id's in the list. More... | |
vtkIdType | GetId (const vtkIdType i) |
Return the id at location i. More... | |
vtkIdType | FindIdLocation (const vtkIdType id) |
Find the location i of the provided id. More... | |
void | SetNumberOfIds (const vtkIdType number) |
Specify the number of ids for this object to hold. More... | |
void | SetId (const vtkIdType i, const vtkIdType vtkid) |
Set the id at location i. More... | |
void | InsertId (const vtkIdType i, const vtkIdType vtkid) |
Set the id at location i. More... | |
vtkIdType | InsertNextId (const vtkIdType vtkid) |
Add the id specified to the end of the list. More... | |
vtkIdType | InsertUniqueId (const vtkIdType vtkid) |
If id is not already in list, insert it and return location in list. More... | |
void | Sort () |
Sort the ids in the list in ascending id order. More... | |
vtkIdType * | GetPointer (const vtkIdType i) |
Get a pointer to a particular data index. More... | |
vtkIdType * | WritePointer (const vtkIdType i, const vtkIdType number) |
Get a pointer to a particular data index. More... | |
void | SetArray (vtkIdType *array, vtkIdType size) |
Specify an array of vtkIdType to use as the id list. More... | |
void | Reset () |
Reset to an empty state but retain previously allocated memory. More... | |
void | Squeeze () |
Free any unused memory. More... | |
void | DeepCopy (vtkIdList *ids) |
Copy an id list by explicitly copying the internal array. More... | |
void | DeleteId (vtkIdType vtkid) |
Delete specified id from list. More... | |
vtkIdType | IsId (vtkIdType vtkid) |
Return -1 if id specified is not contained in the list; otherwise return the position in the list. More... | |
void | IntersectWith (vtkIdList *otherIds) |
Intersect this list with another vtkIdList. More... | |
vtkIdType * | Resize (const vtkIdType sz) |
Adjust the size of the id list while maintaining its content (except when being truncated). More... | |
void | IntersectWith (vtkIdList &otherIds) |
Intersect one id list with another. More... | |
vtkIdType * | Release () |
This releases the ownership of the internal vtkIdType array and returns the pointer to it. More... | |
vtkIdType * | begin () |
To support range-based for loops. More... | |
vtkIdType * | end () |
const vtkIdType * | begin () const |
const vtkIdType * | end () const |
![]() | |
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... | |
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) |
vtkCommand * | GetCommand (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) |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. 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 | 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... | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. More... | |
Static Public Member Functions | |
static vtkIdList * | New () |
Standard methods for instantiation, type information, and printing. More... | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkIdList * | SafeDownCast (vtkObjectBase *o) |
![]() | |
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 () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
![]() | |
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 |
vtkIdList () | |
~vtkIdList () override | |
![]() | |
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 () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkIdType | NumberOfIds |
vtkIdType | Size |
vtkIdType * | Ids |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Additional Inherited Members | |
![]() | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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.
Definition at line 30 of file vtkIdList.h.
typedef vtkObject vtkIdList::Superclass |
Definition at line 38 of file vtkIdList.h.
|
protected |
|
overrideprotected |
|
static |
Standard methods for instantiation, type information, and printing.
|
static |
|
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.
|
static |
|
protectedvirtual |
vtkIdList* vtkIdList::NewInstance | ( | ) | const |
|
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 vtkObjectBase.
void vtkIdList::Initialize | ( | ) |
Release memory and restore to unallocated state.
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.
|
inline |
Return the number of id's in the list.
Definition at line 57 of file vtkIdList.h.
Return the id at location i.
Definition at line 62 of file vtkIdList.h.
Find the location i of the provided id.
Definition at line 70 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.
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 89 of file vtkIdList.h.
Set the id at location i.
Does range checking and allocates memory as necessary.
Definition at line 212 of file vtkIdList.h.
Add the id specified to the end of the list.
Range checking is performed.
Definition at line 226 of file vtkIdList.h.
If id is not already in list, insert it and return location in list.
Otherwise return just location in list.
void vtkIdList::Sort | ( | ) |
Sort the ids in the list in ascending id order.
This method uses vtkSMPTools::Sort() so it can be sped up if built properly.
Get a pointer to a particular data index.
Definition at line 120 of file vtkIdList.h.
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.
Specify an array of vtkIdType to use as the id list.
This replaces the underlying array. This instance of vtkIdList takes ownership of the array, meaning that it deletes it on destruction (using delete[]).
|
inline |
Reset to an empty state but retain previously allocated memory.
Definition at line 139 of file vtkIdList.h.
|
inline |
Free any unused memory.
Definition at line 144 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.
Return -1 if id specified is not contained in the list; otherwise return the position in the list.
Definition at line 239 of file vtkIdList.h.
void vtkIdList::IntersectWith | ( | vtkIdList * | otherIds | ) |
Intersect this list with another vtkIdList.
Updates current list according to result of intersection operation.
Adjust the size of the id list while maintaining its content (except when being truncated).
|
inline |
Intersect one id list with another.
This method should become legacy.
Definition at line 177 of file vtkIdList.h.
vtkIdType* vtkIdList::Release | ( | ) |
This releases the ownership of the internal vtkIdType array and returns the pointer to it.
The caller is responsible of calling delete []
on the returned value. This vtkIdList will be set to initialized state after this call.
|
inline |
To support range-based for
loops.
Definition at line 193 of file vtkIdList.h.
|
inline |
Definition at line 194 of file vtkIdList.h.
|
inline |
Definition at line 195 of file vtkIdList.h.
|
inline |
Definition at line 196 of file vtkIdList.h.
|
protected |
Definition at line 202 of file vtkIdList.h.
|
protected |
Definition at line 203 of file vtkIdList.h.
|
protected |
Definition at line 204 of file vtkIdList.h.