VTK
|
Abstract interface for N-dimensional arrays. More...
#include <vtkArray.h>
Public Types | |
enum | { DENSE = 0, SPARSE = 1 } |
typedef vtkObject | Superclass |
typedef vtkArrayExtents::CoordinateT | CoordinateT |
typedef vtkArrayExtents::DimensionT | DimensionT |
typedef vtkArrayExtents::SizeT | SizeT |
Public Member Functions | |
virtual int | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkArray * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual bool | IsDense ()=0 |
Returns true iff the underlying array storage is "dense", i.e. More... | |
const vtkArrayRange | GetExtent (DimensionT dimension) |
Returns the extent (valid coordinate range) along the given dimension. More... | |
virtual const vtkArrayExtents & | GetExtents ()=0 |
Returns the extents (the number of dimensions and size along each dimension) of the array. More... | |
DimensionT | GetDimensions () |
Returns the number of dimensions stored in the array. More... | |
SizeT | GetSize () |
Returns the number of values stored in the array. More... | |
virtual SizeT | GetNonNullSize ()=0 |
Returns the number of non-null values stored in the array. More... | |
void | SetName (const vtkStdString &name) |
Sets the array name. More... | |
vtkStdString | GetName () |
Returns the array name. More... | |
void | SetDimensionLabel (DimensionT i, const vtkStdString &label) |
Sets the label for the i-th array dimension. More... | |
vtkStdString | GetDimensionLabel (DimensionT i) |
Returns the label for the i-th array dimension. More... | |
virtual void | GetCoordinatesN (const SizeT n, vtkArrayCoordinates &coordinates)=0 |
Returns the coordinates of the n-th value in the array, where n is in the range [0, GetNonNullSize()). More... | |
virtual vtkVariant | GetVariantValueN (const SizeT n)=0 |
Returns the n-th value stored in the array, where n is in the range [0, GetNonNullSize()). More... | |
virtual void | SetVariantValueN (const SizeT n, const vtkVariant &value)=0 |
Overwrites the n-th value stored in the array, where n is in the range [0, GetNonNullSize()). More... | |
virtual vtkArray * | DeepCopy ()=0 |
Returns a new array that is a deep copy of this array. More... | |
void | Resize (const CoordinateT i) |
Resizes the array to the given extents (number of dimensions and size of each dimension). More... | |
void | Resize (const CoordinateT i, const CoordinateT j) |
Resizes the array to the given extents (number of dimensions and size of each dimension). More... | |
void | Resize (const CoordinateT i, const CoordinateT j, const CoordinateT k) |
Resizes the array to the given extents (number of dimensions and size of each dimension). More... | |
void | Resize (const vtkArrayRange &i) |
Resizes the array to the given extents (number of dimensions and size of each dimension). More... | |
void | Resize (const vtkArrayRange &i, const vtkArrayRange &j) |
Resizes the array to the given extents (number of dimensions and size of each dimension). More... | |
void | Resize (const vtkArrayRange &i, const vtkArrayRange &j, const vtkArrayRange &k) |
Resizes the array to the given extents (number of dimensions and size of each dimension). More... | |
void | Resize (const vtkArrayExtents &extents) |
Resizes the array to the given extents (number of dimensions and size of each dimension). More... | |
vtkVariant | GetVariantValue (CoordinateT i) |
Returns the value stored in the array at the given coordinates. More... | |
vtkVariant | GetVariantValue (CoordinateT i, CoordinateT j) |
Returns the value stored in the array at the given coordinates. More... | |
vtkVariant | GetVariantValue (CoordinateT i, CoordinateT j, CoordinateT k) |
Returns the value stored in the array at the given coordinates. More... | |
virtual vtkVariant | GetVariantValue (const vtkArrayCoordinates &coordinates)=0 |
Returns the value stored in the array at the given coordinates. More... | |
void | SetVariantValue (CoordinateT i, const vtkVariant &value) |
Overwrites the value stored in the array at the given coordinates. More... | |
void | SetVariantValue (CoordinateT i, CoordinateT j, const vtkVariant &value) |
Overwrites the value stored in the array at the given coordinates. More... | |
void | SetVariantValue (CoordinateT i, CoordinateT j, CoordinateT k, const vtkVariant &value) |
Overwrites the value stored in the array at the given coordinates. More... | |
virtual void | SetVariantValue (const vtkArrayCoordinates &coordinates, const vtkVariant &value)=0 |
Overwrites the value stored in the array at the given coordinates. More... | |
virtual void | CopyValue (vtkArray *source, const vtkArrayCoordinates &source_coordinates, const vtkArrayCoordinates &target_coordinates)=0 |
Overwrites a value with a value retrieved from another array. More... | |
virtual void | CopyValue (vtkArray *source, const SizeT source_index, const vtkArrayCoordinates &target_coordinates)=0 |
Overwrites a value with a value retrieved from another array. More... | |
virtual void | CopyValue (vtkArray *source, const vtkArrayCoordinates &source_coordinates, const SizeT target_index)=0 |
Overwrites a value with a value retrieved from another array. 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 () |
int | HasObserver (unsigned long event) |
int | 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... | |
int | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
int | 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 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... | |
void | PrintRevisions (ostream &) |
Legacy. 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 int | IsTypeOf (const char *type) |
static vtkArray * | SafeDownCast (vtkObjectBase *o) |
static VTK_NEWINSTANCE vtkArray * | CreateArray (int StorageType, int ValueType) |
Creates a new array where StorageType is one of vtkArray::DENSE or vtkArray::SPARSE, and ValueType is one of VTK_CHAR, VTK_UNSIGNED_CHAR, VTK_SHORT, VTK_UNSIGNED_SHORT, VTK_INT, VTK_UNSIGNED_INT, VTK_LONG, VTK_UNSIGNED_LONG, VTK_DOUBLE, VTK_ID_TYPE, or VTK_STRING. 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 vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkArray () | |
~vtkArray () 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=NULL) |
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 | CollectRevisions (ostream &) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Additional Inherited Members | |
Protected Attributes inherited from vtkObject | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
Protected Attributes inherited from vtkObjectBase | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Abstract interface for N-dimensional arrays.
vtkArray is the root of a hierarchy of arrays that can be used to store data with any number of dimensions. It provides an abstract interface for retrieving and setting array attributes that are independent of the type of values stored in the array - such as the number of dimensions, extents along each dimension, and number of values stored in the array.
To get and set array values, the vtkTypedArray template class derives from vtkArray and provides type-specific methods for retrieval and update.
Two concrete derivatives of vtkTypedArray are provided at the moment: vtkDenseArray and vtkSparseArray, which provide dense and sparse storage for arbitrary-dimension data, respectively. Toolkit users can create their own concrete derivatives that implement alternative storage strategies, such as compressed-sparse-row, etc. You could also create an array that provided read-only access to 'virtual' data, such as an array that returned a Fibonacci sequence, etc.
Definition at line 70 of file vtkArray.h.
typedef vtkObject vtkArray::Superclass |
Definition at line 73 of file vtkArray.h.
Definition at line 76 of file vtkArray.h.
Definition at line 77 of file vtkArray.h.
Definition at line 78 of file vtkArray.h.
anonymous enum |
Enumerator | |
---|---|
DENSE |
Used with CreateArray() to create dense arrays. |
SPARSE |
Used with CreateArray() to create sparse arrays. |
Definition at line 80 of file vtkArray.h.
|
protected |
|
overrideprotected |
|
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 |
vtkArray* vtkArray::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.
Reimplemented in vtkSparseArray< T >, and vtkTypedArray< T >.
|
static |
Creates a new array where StorageType is one of vtkArray::DENSE or vtkArray::SPARSE, and ValueType is one of VTK_CHAR, VTK_UNSIGNED_CHAR, VTK_SHORT, VTK_UNSIGNED_SHORT, VTK_INT, VTK_UNSIGNED_INT, VTK_LONG, VTK_UNSIGNED_LONG, VTK_DOUBLE, VTK_ID_TYPE, or VTK_STRING.
The caller is responsible for the lifetime of the returned object.
|
pure virtual |
Returns true iff the underlying array storage is "dense", i.e.
that GetSize() and GetNonNullSize() will always return the same value. If not, the array is "sparse".
Implemented in vtkSparseArray< T >, and vtkDenseArray< T >.
void vtkArray::Resize | ( | const CoordinateT | i | ) |
Resizes the array to the given extents (number of dimensions and size of each dimension).
Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize().
The contents of the array are undefined after calling Resize() - you should initialize its contents accordingly. In particular, dimension-labels will be undefined, dense array values will be undefined, and sparse arrays will be empty.
void vtkArray::Resize | ( | const CoordinateT | i, |
const CoordinateT | j | ||
) |
Resizes the array to the given extents (number of dimensions and size of each dimension).
Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize().
The contents of the array are undefined after calling Resize() - you should initialize its contents accordingly. In particular, dimension-labels will be undefined, dense array values will be undefined, and sparse arrays will be empty.
void vtkArray::Resize | ( | const CoordinateT | i, |
const CoordinateT | j, | ||
const CoordinateT | k | ||
) |
Resizes the array to the given extents (number of dimensions and size of each dimension).
Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize().
The contents of the array are undefined after calling Resize() - you should initialize its contents accordingly. In particular, dimension-labels will be undefined, dense array values will be undefined, and sparse arrays will be empty.
void vtkArray::Resize | ( | const vtkArrayRange & | i | ) |
Resizes the array to the given extents (number of dimensions and size of each dimension).
Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize().
The contents of the array are undefined after calling Resize() - you should initialize its contents accordingly. In particular, dimension-labels will be undefined, dense array values will be undefined, and sparse arrays will be empty.
void vtkArray::Resize | ( | const vtkArrayRange & | i, |
const vtkArrayRange & | j | ||
) |
Resizes the array to the given extents (number of dimensions and size of each dimension).
Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize().
The contents of the array are undefined after calling Resize() - you should initialize its contents accordingly. In particular, dimension-labels will be undefined, dense array values will be undefined, and sparse arrays will be empty.
void vtkArray::Resize | ( | const vtkArrayRange & | i, |
const vtkArrayRange & | j, | ||
const vtkArrayRange & | k | ||
) |
Resizes the array to the given extents (number of dimensions and size of each dimension).
Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize().
The contents of the array are undefined after calling Resize() - you should initialize its contents accordingly. In particular, dimension-labels will be undefined, dense array values will be undefined, and sparse arrays will be empty.
void vtkArray::Resize | ( | const vtkArrayExtents & | extents | ) |
Resizes the array to the given extents (number of dimensions and size of each dimension).
Note that concrete implementations of vtkArray may place constraints on the the extents that they will store, so you cannot assume that GetExtents() will always return the same value passed to Resize().
The contents of the array are undefined after calling Resize() - you should initialize its contents accordingly. In particular, dimension-labels will be undefined, dense array values will be undefined, and sparse arrays will be empty.
const vtkArrayRange vtkArray::GetExtent | ( | DimensionT | dimension | ) |
Returns the extent (valid coordinate range) along the given dimension.
|
pure virtual |
Returns the extents (the number of dimensions and size along each dimension) of the array.
Implemented in vtkSparseArray< T >, and vtkDenseArray< T >.
DimensionT vtkArray::GetDimensions | ( | ) |
Returns the number of dimensions stored in the array.
Note that this is the same as calling GetExtents().GetDimensions().
SizeT vtkArray::GetSize | ( | ) |
Returns the number of values stored in the array.
Note that this is the same as calling GetExtents().GetSize(), and represents the maximum number of values that could ever be stored using the current extents. This is equal to the number of values stored in a dense array, but may be larger than the number of values stored in a sparse array.
|
pure virtual |
Returns the number of non-null values stored in the array.
Note that this value will equal GetSize() for dense arrays, and will be less-than-or-equal to GetSize() for sparse arrays.
Implemented in vtkSparseArray< T >, and vtkDenseArray< T >.
void vtkArray::SetName | ( | const vtkStdString & | name | ) |
Sets the array name.
vtkStdString vtkArray::GetName | ( | ) |
Returns the array name.
void vtkArray::SetDimensionLabel | ( | DimensionT | i, |
const vtkStdString & | label | ||
) |
Sets the label for the i-th array dimension.
vtkStdString vtkArray::GetDimensionLabel | ( | DimensionT | i | ) |
Returns the label for the i-th array dimension.
|
pure virtual |
Returns the coordinates of the n-th value in the array, where n is in the range [0, GetNonNullSize()).
Note that the order in which coordinates are visited is undefined, but is guaranteed to match the order in which values are visited using vtkTypedArray::GetValueN() and vtkTypedArray::SetValueN().
Implemented in vtkSparseArray< T >, and vtkDenseArray< T >.
|
inline |
Returns the value stored in the array at the given coordinates.
Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.
Definition at line 279 of file vtkArray.h.
|
inline |
Returns the value stored in the array at the given coordinates.
Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.
Definition at line 284 of file vtkArray.h.
|
inline |
Returns the value stored in the array at the given coordinates.
Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.
Definition at line 289 of file vtkArray.h.
|
pure virtual |
Returns the value stored in the array at the given coordinates.
Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.
Implemented in vtkTypedArray< T >.
|
pure virtual |
Returns the n-th value stored in the array, where n is in the range [0, GetNonNullSize()).
This is useful for efficiently visiting every value in the array. Note that the order in which values are visited is undefined, but is guaranteed to match the order used by vtkArray::GetCoordinatesN().
Implemented in vtkTypedArray< T >.
|
inline |
Overwrites the value stored in the array at the given coordinates.
Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.
Definition at line 294 of file vtkArray.h.
|
inline |
Overwrites the value stored in the array at the given coordinates.
Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.
Definition at line 299 of file vtkArray.h.
|
inline |
Overwrites the value stored in the array at the given coordinates.
Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.
Definition at line 304 of file vtkArray.h.
|
pure virtual |
Overwrites the value stored in the array at the given coordinates.
Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.
Implemented in vtkTypedArray< T >.
|
pure virtual |
Overwrites the n-th value stored in the array, where n is in the range [0, GetNonNullSize()).
This is useful for efficiently visiting every value in the array. Note that the order in which values are visited is undefined, but is guaranteed to match the order used by vtkArray::GetCoordinatesN().
Implemented in vtkTypedArray< T >.
|
pure virtual |
Overwrites a value with a value retrieved from another array.
Both arrays must store the same data types.
Implemented in vtkTypedArray< T >.
|
pure virtual |
Overwrites a value with a value retrieved from another array.
Both arrays must store the same data types.
Implemented in vtkTypedArray< T >.
|
pure virtual |
Overwrites a value with a value retrieved from another array.
Both arrays must store the same data types.
Implemented in vtkTypedArray< T >.
|
pure virtual |
Returns a new array that is a deep copy of this array.
Implemented in vtkSparseArray< T >, and vtkDenseArray< T >.