|
virtual vtkTypeBool | 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...
|
|
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) |
|
void | Resize (const CoordinateT i, const CoordinateT j, const CoordinateT k) |
|
void | Resize (const vtkArrayRange &i) |
|
void | Resize (const vtkArrayRange &i, const vtkArrayRange &j) |
|
void | Resize (const vtkArrayRange &i, const vtkArrayRange &j, const vtkArrayRange &k) |
|
void | Resize (const vtkArrayExtents &extents) |
|
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...
|
|
vtkVariant | GetVariantValue (CoordinateT i) |
| Returns the value stored in the array at the given coordinates. More...
|
|
vtkVariant | GetVariantValue (CoordinateT i, CoordinateT j) |
|
vtkVariant | GetVariantValue (CoordinateT i, CoordinateT j, CoordinateT k) |
|
virtual vtkVariant | GetVariantValue (const vtkArrayCoordinates &coordinates)=0 |
|
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...
|
|
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) |
|
void | SetVariantValue (CoordinateT i, CoordinateT j, CoordinateT k, const vtkVariant &value) |
|
virtual void | SetVariantValue (const vtkArrayCoordinates &coordinates, const vtkVariant &value)=0 |
|
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 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 |
|
virtual void | CopyValue (vtkArray *source, const vtkArrayCoordinates &source_coordinates, const SizeT target_index)=0 |
|
virtual vtkArray * | DeepCopy ()=0 |
| Returns a new array that is a deep copy of this array. More...
|
|
| 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 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...
|
|
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 vtkTypeBool | IsTypeOf (const char *type) |
|
static vtkArray * | SafeDownCast (vtkObjectBase *o) |
|
static 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 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...
|
|
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.
- See also
- vtkTypedArray, vtkDenseArray, vtkSparseArray
- Thanks:
- Developed by Timothy M. Shead (tshea.nosp@m.d@sa.nosp@m.ndia..nosp@m.gov) at Sandia National Laboratories.
Definition at line 64 of file vtkArray.h.