VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkAOSDataArrayTemplate< ValueTypeT > Class Template Reference

Array-Of-Structs implementation of vtkGenericDataArray. More...

#include <vtkAOSDataArrayTemplate.h>

Inheritance diagram for vtkAOSDataArrayTemplate< ValueTypeT >:
[legend]
Collaboration diagram for vtkAOSDataArrayTemplate< ValueTypeT >:
[legend]

Public Types

enum  DeleteMethod { VTK_DATA_ARRAY_FREE = vtkAbstractArray::VTK_DATA_ARRAY_FREE, VTK_DATA_ARRAY_DELETE = vtkAbstractArray::VTK_DATA_ARRAY_DELETE, VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE, VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED }
 
typedef vtkAOSDataArrayTemplate< ValueTypeT > SelfType
 
typedef Superclass::ValueType ValueType
 
typedef ValueTypeIterator
 Legacy support for array-of-structs value iteration. More...
 
- Public Types inherited from vtkGenericDataArray< vtkAOSDataArrayTemplate< ValueTypeT >, ValueTypeT >
enum  
 Compile time access to the VTK type identifier. More...
 
typedef ValueTypeT ValueType
 
- Public Types inherited from vtkDataArray
typedef vtkAbstractArray Superclass
 
- Public Types inherited from vtkAbstractArray
enum  DeleteMethod { VTK_DATA_ARRAY_FREE, VTK_DATA_ARRAY_DELETE, VTK_DATA_ARRAY_ALIGNED_FREE, VTK_DATA_ARRAY_USER_DEFINED }
 
enum  { MAX_DISCRETE_VALUES = 32 }
 
enum  {
  AbstractArray = 0, DataArray, AoSDataArrayTemplate, SoADataArrayTemplate,
  TypedDataArray, MappedDataArray, ScaleSoADataArrayTemplate, DataArrayTemplate = AoSDataArrayTemplate
}
 
typedef vtkObject Superclass
 

Public Member Functions

 vtkTemplateTypeMacro (SelfType, GenericDataArrayType)
 
ValueType GetValue (vtkIdType valueIdx) const
 Get the value at valueIdx. More...
 
void SetValue (vtkIdType valueIdx, ValueType value)
 Set the value at valueIdx to value. More...
 
void GetTypedTuple (vtkIdType tupleIdx, ValueType *tuple) const
 Copy the tuple at tupleIdx into tuple. More...
 
void SetTypedTuple (vtkIdType tupleIdx, const ValueType *tuple)
 Set this array's tuple at tupleIdx to the values in tuple. More...
 
ValueType GetTypedComponent (vtkIdType tupleIdx, int comp) const
 Get component comp of the tuple at tupleIdx. More...
 
void SetTypedComponent (vtkIdType tupleIdx, int comp, ValueType value)
 Set component comp of the tuple at tupleIdx to value. More...
 
void FillTypedComponent (int compIdx, ValueType value) override
 Set component comp of all tuples to value. More...
 
void FillValue (ValueType value) override
 Set all the values in array to value. More...
 
void Fill (double value) override
 Fill all values of a data array with a specified value. More...
 
ValueTypeWritePointer (vtkIdType valueIdx, vtkIdType numValues)
 Get the address of a particular data index. More...
 
void * WriteVoidPointer (vtkIdType valueIdx, vtkIdType numValues) override
 Get the address of a particular data index. More...
 
ValueTypeGetPointer (vtkIdType valueIdx)
 Get the address of a particular data index. More...
 
void * GetVoidPointer (vtkIdType valueIdx) override
 Return a void pointer. More...
 
void SetArray (ValueType *array, vtkIdType size, int save, int deleteMethod)
 This method lets the user specify data to be held by the array. More...
 
void SetArray (ValueType *array, vtkIdType size, int save)
 
void SetVoidArray (void *array, vtkIdType size, int save) override
 
void SetVoidArray (void *array, vtkIdType size, int save, int deleteMethod) override
 
void SetArrayFreeFunction (void(*callback)(void *)) override
 This method allows the user to specify a custom free function to be called when the array is deallocated. More...
 
void SetTuple (vtkIdType tupleIdx, const float *tuple) override
 Set the data tuple at tupleIdx. More...
 
void SetTuple (vtkIdType tupleIdx, const double *tuple) override
 
void SetTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
 Set the tuple at dstTupleIdx in this array to the tuple at srcTupleIdx in the source array. More...
 
void InsertTuple (vtkIdType tupleIdx, const float *source) override
 Insert the data tuple at tupleIdx. More...
 
void InsertTuple (vtkIdType tupleIdx, const double *source) override
 
void InsertTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
 Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx. More...
 
void InsertComponent (vtkIdType tupleIdx, int compIdx, double value) override
 Insert value at the location specified by tupleIdx and compIdx. More...
 
vtkIdType InsertNextTuple (const float *tuple) override
 Insert the data tuple at the end of the array and return the tuple index at which the data was inserted. More...
 
vtkIdType InsertNextTuple (const double *tuple) override
 
vtkIdType InsertNextTuple (vtkIdType srcTupleIdx, vtkAbstractArray *source) override
 Insert the tuple from srcTupleIdx in the source array at the end of this array. More...
 
void GetTuple (vtkIdType tupleIdx, double *tuple) override
 Get the data tuple at tupleIdx by filling in a user-provided array, Make sure that your array is large enough to hold the NumberOfComponents amount of data being returned. More...
 
double * GetTuple (vtkIdType tupleIdx) override
 Get the data tuple at tupleIdx. More...
 
void DataElementChanged (vtkIdType)
 Tell the array explicitly that a single data element has changed. More...
 
Iterator Begin ()
 
Iterator End ()
 
int GetArrayType () override
 Method for type-checking in FastDownCast implementations. More...
 
vtkArrayIteratorNewIterator () override
 Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate. More...
 
bool HasStandardMemoryLayout () override
 Returns true if this array uses the standard memory layout defined in the VTK user guide, e.g. More...
 
void ShallowCopy (vtkDataArray *other) override
 Create a shallow copy of other into this, if possible. More...
 
void InsertTuples (vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray *source) override
 Copy n consecutive tuples starting at srcStart from the source array to this array, starting at the dstStart location. More...
 
void InsertTuples (vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source) override
 Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in this array. More...
 
- Public Member Functions inherited from vtkGenericDataArray< vtkAOSDataArrayTemplate< ValueTypeT >, ValueTypeT >
 vtkTemplateTypeMacro (SelfType, vtkDataArray)
 
ValueType GetValue (vtkIdType valueIdx) const
 Get the value at valueIdx. More...
 
void SetValue (vtkIdType valueIdx, ValueType value)
 Set the value at valueIdx to value. More...
 
void GetTypedTuple (vtkIdType tupleIdx, ValueType *tuple) const
 Copy the tuple at tupleIdx into tuple. More...
 
void SetTypedTuple (vtkIdType tupleIdx, const ValueType *tuple)
 Set this array's tuple at tupleIdx to the values in tuple. More...
 
ValueType GetTypedComponent (vtkIdType tupleIdx, int compIdx) const
 Get component compIdx of the tuple at tupleIdx. More...
 
void SetTypedComponent (vtkIdType tupleIdx, int compIdx, ValueType value)
 Set component compIdx of the tuple at tupleIdx to value. More...
 
void * GetVoidPointer (vtkIdType valueIdx) override
 Default implementation raises a runtime error. More...
 
ValueTypeGetPointer (vtkIdType valueIdx)
 
void SetVoidArray (void *, vtkIdType, int) override
 
void SetVoidArray (void *, vtkIdType, int, int) override
 
void SetArrayFreeFunction (void(*callback)(void *)) override
 This method allows the user to specify a custom free function to be called when the array is deallocated. More...
 
void * WriteVoidPointer (vtkIdType valueIdx, vtkIdType numValues) override
 Get the address of a particular data index. More...
 
ValueTypeWritePointer (vtkIdType valueIdx, vtkIdType numValues)
 
void RemoveTuple (vtkIdType tupleIdx) override
 Removes a tuple at the given index. More...
 
vtkIdType InsertNextValue (ValueType value)
 Insert data at the end of the array. More...
 
void InsertValue (vtkIdType valueIdx, ValueType value)
 Insert data at a specified position in the array. More...
 
void InsertTypedTuple (vtkIdType tupleIdx, const ValueType *t)
 Insert (memory allocation performed) the tuple t at tupleIdx. More...
 
vtkIdType InsertNextTypedTuple (const ValueType *t)
 Insert (memory allocation performed) the tuple onto the end of the array. More...
 
void InsertTypedComponent (vtkIdType tupleIdx, int compIdx, ValueType val)
 Insert (memory allocation performed) the value at the specified tuple and component location. More...
 
void GetValueRange (ValueType range[2], int comp)
 Get the range of array values for the given component in the native data type. More...
 
ValueTypeGetValueRange (int comp)
 
ValueTypeGetValueRange ()
 Get the range of array values for the 0th component in the native data type. More...
 
void GetValueRange (ValueType range[2])
 
vtkIdType Capacity ()
 Return the capacity in typeof T units of the current array. More...
 
virtual void FillTypedComponent (int compIdx, ValueType value)
 Set component comp of all tuples to value. More...
 
virtual void FillValue (ValueType value)
 Set all the values in array to value. More...
 
int GetDataType () override
 Return the underlying data type. More...
 
int GetDataTypeSize () override
 Return the size of the underlying data type. More...
 
bool HasStandardMemoryLayout () override
 Returns true if this array uses the standard memory layout defined in the VTK user guide, e.g. More...
 
vtkTypeBool Allocate (vtkIdType size, vtkIdType ext=1000) override
 Allocate memory for this array. More...
 
vtkTypeBool Resize (vtkIdType numTuples) override
 Resize the array to the requested number of tuples and preserve data. More...
 
void SetNumberOfComponents (int num) override
 Set/Get the dimension (n) of the components. More...
 
void SetNumberOfTuples (vtkIdType number) override
 Set the number of tuples (a component group) in the array. More...
 
void Initialize () override
 Release storage and reset array to initial state. More...
 
void Squeeze () override
 Free any unnecessary memory. More...
 
void SetTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
 Set the tuple at dstTupleIdx in this array to the tuple at srcTupleIdx in the source array. More...
 
void SetTuple (vtkIdType tupleIdx, const float *tuple) override
 Set the data tuple at tupleIdx. More...
 
void SetTuple (vtkIdType tupleIdx, const double *tuple) override
 
void InsertTuples (vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source) override
 Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in this array. More...
 
void InsertTuples (vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray *source) override
 Copy n consecutive tuples starting at srcStart from the source array to this array, starting at the dstStart location. More...
 
void InsertTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
 Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx. More...
 
void InsertTuple (vtkIdType tupleIdx, const float *source) override
 Insert the data tuple at tupleIdx. More...
 
void InsertTuple (vtkIdType tupleIdx, const double *source) override
 
void InsertComponent (vtkIdType tupleIdx, int compIdx, double value) override
 Insert value at the location specified by tupleIdx and compIdx. More...
 
vtkIdType InsertNextTuple (vtkIdType srcTupleIdx, vtkAbstractArray *source) override
 Insert the tuple from srcTupleIdx in the source array at the end of this array. More...
 
vtkIdType InsertNextTuple (const float *tuple) override
 Insert the data tuple at the end of the array and return the tuple index at which the data was inserted. More...
 
vtkIdType InsertNextTuple (const double *tuple) override
 
void GetTuples (vtkIdList *tupleIds, vtkAbstractArray *output) override
 Given a list of tuple ids, return an array of tuples. More...
 
void GetTuples (vtkIdType p1, vtkIdType p2, vtkAbstractArray *output) override
 Get the tuples for the range of tuple ids specified (i.e., p1->p2 inclusive). More...
 
double * GetTuple (vtkIdType tupleIdx) override
 Get the data tuple at tupleIdx. More...
 
void GetTuple (vtkIdType tupleIdx, double *tuple) override
 Get the data tuple at tupleIdx by filling in a user-provided array, Make sure that your array is large enough to hold the NumberOfComponents amount of data being returned. More...
 
void InterpolateTuple (vtkIdType dstTupleIdx, vtkIdList *ptIndices, vtkAbstractArray *source, double *weights) override
 Set the tuple at dstTupleIdx in this array to the interpolated tuple value, given the ptIndices in the source array and associated interpolation weights. More...
 
void InterpolateTuple (vtkIdType dstTupleIdx, vtkIdType srcTupleIdx1, vtkAbstractArray *source1, vtkIdType srcTupleIdx2, vtkAbstractArray *source2, double t) override
 Insert the tuple at dstTupleIdx in this array to the tuple interpolated from the two tuple indices, srcTupleIdx1 and srcTupleIdx2, and an interpolation factor, t. More...
 
void SetComponent (vtkIdType tupleIdx, int compIdx, double value) override
 Set the data component at the location specified by tupleIdx and compIdx to value. More...
 
double GetComponent (vtkIdType tupleIdx, int compIdx) override
 Return the data component at the location specified by tupleIdx and compIdx. More...
 
void SetVariantValue (vtkIdType valueIdx, vtkVariant value) override
 Set a value in the array from a variant. More...
 
vtkVariant GetVariantValue (vtkIdType valueIdx) override
 Retrieve value from the array as a variant. More...
 
void InsertVariantValue (vtkIdType valueIdx, vtkVariant value) override
 Insert a value into the array from a variant. More...
 
vtkIdType LookupValue (vtkVariant value) override
 Return the value indices where a specific value appears. More...
 
void LookupValue (vtkVariant value, vtkIdList *valueIds) override
 
virtual vtkIdType LookupTypedValue (ValueType value)
 
virtual void LookupTypedValue (ValueType value, vtkIdList *valueIds)
 
void ClearLookup () override
 Delete the associated fast lookup data structure on this array, if it exists. More...
 
void DataChanged () override
 Tell the array explicitly that the data has changed. More...
 
void FillComponent (int compIdx, double value) override
 Fill a component of a data array with a specified value. More...
 
vtkArrayIteratorNewIterator () override
 Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate. More...
 
void GetFiniteValueRange (ValueType range[2], int comp)
 These methods are analogous to the GetValueRange methods, except that the only consider finite values. More...
 
ValueTypeGetFiniteValueRange (int comp)
 These methods are analogous to the GetValueRange methods, except that the only consider finite values. More...
 
ValueTypeGetFiniteValueRange ()
 These methods are analogous to the GetValueRange methods, except that the only consider finite values. More...
 
void GetFiniteValueRange (ValueType range[2])
 These methods are analogous to the GetValueRange methods, except that the only consider finite values. More...
 
- Public Member Functions inherited from vtkDataArray
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkDataArrayNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int IsNumeric () override
 This method is here to make backward compatibility easier. More...
 
int GetElementComponentSize () override
 Return the size, in bytes, of the lowest-level element of an array. More...
 
double GetTuple1 (vtkIdType tupleIdx)
 These methods are included as convenience for the wrappers. More...
 
double * GetTuple2 (vtkIdType tupleIdx)
 
double * GetTuple3 (vtkIdType tupleIdx)
 
double * GetTuple4 (vtkIdType tupleIdx)
 
double * GetTuple6 (vtkIdType tupleIdx)
 
double * GetTuple9 (vtkIdType tupleIdx)
 
void SetTuple1 (vtkIdType tupleIdx, double value)
 These methods are included as convenience for the wrappers. More...
 
void SetTuple2 (vtkIdType tupleIdx, double val0, double val1)
 
void SetTuple3 (vtkIdType tupleIdx, double val0, double val1, double val2)
 
void SetTuple4 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3)
 
void SetTuple6 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3, double val4, double val5)
 
void SetTuple9 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3, double val4, double val5, double val6, double val7, double val8)
 
void InsertTuple1 (vtkIdType tupleIdx, double value)
 These methods are included as convenience for the wrappers. More...
 
void InsertTuple2 (vtkIdType tupleIdx, double val0, double val1)
 
void InsertTuple3 (vtkIdType tupleIdx, double val0, double val1, double val2)
 
void InsertTuple4 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3)
 
void InsertTuple6 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3, double val4, double val5)
 
void InsertTuple9 (vtkIdType tupleIdx, double val0, double val1, double val2, double val3, double val4, double val5, double val6, double val7, double val8)
 
void InsertNextTuple1 (double value)
 These methods are included as convenience for the wrappers. More...
 
void InsertNextTuple2 (double val0, double val1)
 
void InsertNextTuple3 (double val0, double val1, double val2)
 
void InsertNextTuple4 (double val0, double val1, double val2, double val3)
 
void InsertNextTuple6 (double val0, double val1, double val2, double val3, double val4, double val5)
 
void InsertNextTuple9 (double val0, double val1, double val2, double val3, double val4, double val5, double val6, double val7, double val8)
 
virtual void RemoveFirstTuple ()
 
virtual void RemoveLastTuple ()
 
virtual void GetData (vtkIdType tupleMin, vtkIdType tupleMax, int compMin, int compMax, vtkDoubleArray *data)
 Get the data as a double array in the range (tupleMin,tupleMax) and (compMin, compMax). More...
 
void DeepCopy (vtkAbstractArray *aa) override
 Deep copy of data. More...
 
virtual void DeepCopy (vtkDataArray *da)
 
virtual void CopyComponent (int dstComponent, vtkDataArray *src, int srcComponent)
 Copy a component from one data array into a component on this data array. More...
 
unsigned long GetActualMemorySize () override
 Return the memory in kibibytes (1024 bytes) consumed by this data array. More...
 
void CreateDefaultLookupTable ()
 Create default lookup table. More...
 
void SetLookupTable (vtkLookupTable *lut)
 Set/get the lookup table associated with this scalar data, if any. More...
 
virtual vtkLookupTableGetLookupTable ()
 
void GetRange (double range[2], int comp)
 The range of the data array values for the given component will be returned in the provided range array argument. More...
 
double * GetRange (int comp)
 Return the range of the data array values for the given component. More...
 
double * GetRange ()
 Return the range of the data array. More...
 
void GetRange (double range[2])
 The range of the data array values will be returned in the provided range array argument. More...
 
void GetFiniteRange (double range[2], int comp)
 The range of the data array values for the given component will be returned in the provided range array argument. More...
 
double * GetFiniteRange (int comp)
 Return the range of the data array values for the given component. More...
 
double * GetFiniteRange ()
 Return the range of the data array. More...
 
void GetFiniteRange (double range[2])
 The range of the data array values will be returned in the provided range array argument. More...
 
void GetDataTypeRange (double range[2])
 These methods return the Min and Max possible range of the native data type. More...
 
double GetDataTypeMin ()
 
double GetDataTypeMax ()
 
virtual double GetMaxNorm ()
 Return the maximum norm for the tuples. More...
 
void Modified () override
 Removes out-of-date L2_NORM_RANGE() and L2_NORM_FINITE_RANGE() values. More...
 
int CopyInformation (vtkInformation *infoFrom, int deep=1) override
 Copy information instance. More...
 
int GetArrayType () override
 Method for type-checking in FastDownCast implementations. More...
 
- Public Member Functions inherited from vtkAbstractArray
vtkAbstractArrayNewInstance () const
 
int GetNumberOfComponents ()
 
void SetComponentName (vtkIdType component, const char *name)
 Set the name for a component. More...
 
const char * GetComponentName (vtkIdType component)
 Get the component name for a given component. More...
 
bool HasAComponentName ()
 Returns if any component has had a name assigned. More...
 
int CopyComponentNames (vtkAbstractArray *da)
 Copies the component names from the inputed array to the current array make sure that the current array has the same number of components as the input array. More...
 
virtual bool SetNumberOfValues (vtkIdType numValues)
 Specify the number of values (tuples * components) for this object to hold. More...
 
vtkIdType GetNumberOfTuples ()
 Get the number of complete tuples (a component group) in the array. More...
 
vtkIdType GetNumberOfValues () const
 Get the total number of values in the array. More...
 
void Reset ()
 Reset to an empty state, without freeing any memory. More...
 
vtkIdType GetSize () const
 Return the size of the data. More...
 
vtkIdType GetMaxId () const
 What is the maximum id currently in the array. More...
 
virtual void SetVoidArray (void *vtkNotUsed(array), vtkIdType vtkNotUsed(size), int vtkNotUsed(save))=0
 This method lets the user specify data to be held by the array. More...
 
virtual void SetVoidArray (void *array, vtkIdType size, int save, int vtkNotUsed(deleteMethod))
 
virtual void ExportToVoidPointer (void *out_ptr)
 This method copies the array data to the void pointer specified by the user. More...
 
virtual void SetName (const char *)
 Set/get array's name. More...
 
virtual char * GetName ()
 
virtual const char * GetDataTypeAsString (void)
 Get the name of a data type as a string. More...
 
virtual vtkIdType GetDataSize ()
 Returns the size of the data in DataTypeSize units. More...
 
virtual void GetProminentComponentValues (int comp, vtkVariantArray *values, double uncertainty=1.e-6, double minimumProminence=1.e-3)
 Populate the given vtkVariantArray with a set of distinct values taken on by the requested component (or, when passed -1, by the tuples as a whole). More...
 
vtkInformationGetInformation ()
 Get an information object that can be used to annotate the array. More...
 
bool HasInformation ()
 Inquire if this array has an instance of vtkInformation already associated with it. More...
 
virtual unsigned int GetMaxDiscreteValues ()
 Get/Set the maximum number of prominent values this array may contain before it is considered continuous. More...
 
virtual void SetMaxDiscreteValues (unsigned int)
 
- 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 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)
 
vtkCommandGetCommand (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)
 
- 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 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 Public Member Functions

static vtkAOSDataArrayTemplateNew ()
 
static vtkAOSDataArrayTemplate< ValueType > * FastDownCast (vtkAbstractArray *source)
 Perform a fast, safe cast from a vtkAbstractArray to a vtkAOSDataArrayTemplate. More...
 
- Static Public Member Functions inherited from vtkDataArray
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataArraySafeDownCast (vtkObjectBase *o)
 
static vtkDataArrayFastDownCast (vtkAbstractArray *source)
 Perform a fast, safe cast from a vtkAbstractArray to a vtkDataArray. More...
 
static void GetDataTypeRange (int type, double range[2])
 
static double GetDataTypeMin (int type)
 
static double GetDataTypeMax (int type)
 
static vtkDataArrayCreateDataArray (int dataType)
 Creates an array for dataType where dataType is one of VTK_BIT, VTK_CHAR, VTK_SIGNED_CHAR, VTK_UNSIGNED_CHAR, VTK_SHORT, VTK_UNSIGNED_SHORT, VTK_INT, VTK_UNSIGNED_INT, VTK_LONG, VTK_UNSIGNED_LONG, VTK_DOUBLE, VTK_DOUBLE, VTK_ID_TYPE. More...
 
static vtkInformationDoubleVectorKeyCOMPONENT_RANGE ()
 This key is used to hold tight bounds on the range of one component over all tuples of the array. More...
 
static vtkInformationDoubleVectorKeyL2_NORM_RANGE ()
 This key is used to hold tight bounds on the $L_2$ norm of tuples in the array. More...
 
static vtkInformationDoubleVectorKeyL2_NORM_FINITE_RANGE ()
 This key is used to hold tight bounds on the $L_2$ norm of tuples in the array. More...
 
static vtkInformationStringKeyUNITS_LABEL ()
 A human-readable string indicating the units for the array data. More...
 
- Static Public Member Functions inherited from vtkAbstractArray
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractArraySafeDownCast (vtkObjectBase *o)
 
static int GetDataTypeSize (int type)
 
static vtkAbstractArrayCreateArray (int dataType)
 Creates an array for dataType where dataType is one of VTK_BIT, VTK_CHAR, VTK_UNSIGNED_CHAR, VTK_SHORT, VTK_UNSIGNED_SHORT, VTK_INT, VTK_UNSIGNED_INT, VTK_LONG, VTK_UNSIGNED_LONG, VTK_DOUBLE, VTK_DOUBLE, VTK_ID_TYPE, VTK_STRING. More...
 
static vtkInformationIntegerKeyGUI_HIDE ()
 This key is a hint to end user interface that this array is internal and should not be shown to the end user. More...
 
static vtkInformationInformationVectorKeyPER_COMPONENT ()
 This key is used to hold a vector of COMPONENT_VALUES (and, for vtkDataArray subclasses, COMPONENT_RANGE) keys – one for each component of the array. More...
 
static vtkInformationInformationVectorKeyPER_FINITE_COMPONENT ()
 This key is used to hold a vector of COMPONENT_VALUES (and, for vtkDataArray subclasses, COMPONENT_RANGE) keys – one for each component of the array. More...
 
static vtkInformationVariantVectorKeyDISCRETE_VALUES ()
 A key used to hold discrete values taken on either by the tuples of the array (when present in this->GetInformation()) or individual components (when present in one entry of the PER_COMPONENT() information vector). More...
 
static vtkInformationDoubleVectorKeyDISCRETE_VALUE_SAMPLE_PARAMETERS ()
 A key used to hold conditions under which cached discrete values were generated; the value is a 2-vector of doubles. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

 vtkAOSDataArrayTemplate ()
 
 ~vtkAOSDataArrayTemplate () override
 
bool AllocateTuples (vtkIdType numTuples)
 Allocate space for numTuples. More...
 
bool ReallocateTuples (vtkIdType numTuples)
 Allocate space for numTuples. More...
 
- Protected Member Functions inherited from vtkGenericDataArray< vtkAOSDataArrayTemplate< ValueTypeT >, ValueTypeT >
 vtkGenericDataArray ()
 
 ~vtkGenericDataArray () override
 
bool AllocateTuples (vtkIdType numTuples)
 Allocate space for numTuples. More...
 
bool ReallocateTuples (vtkIdType numTuples)
 Allocate space for numTuples. More...
 
bool EnsureAccessToTuple (vtkIdType tupleIdx)
 
void ComputeValueRange (ValueType range[2], int comp)
 Compute the range for a specific component. More...
 
void ComputeFiniteValueRange (ValueType range[2], int comp)
 Compute the range for a specific component. More...
 
bool ComputeScalarValueRange (ValueType *ranges)
 Computes the range for each component of an array, the length of ranges must be two times the number of components. More...
 
bool ComputeVectorValueRange (ValueType range[2])
 Returns true if the range was computed. More...
 
bool ComputeFiniteScalarValueRange (ValueType *ranges)
 Computes the range for each component of an array, the length of ranges must be two times the number of components. More...
 
bool ComputeFiniteVectorValueRange (ValueType range[2])
 Returns true if the range was computed. More...
 
- Protected Member Functions inherited from vtkDataArray
virtual vtkObjectBaseNewInstanceInternal () const
 
virtual void ComputeRange (double range[2], int comp)
 Compute the range for a specific component. More...
 
virtual void ComputeFiniteRange (double range[2], int comp)
 Compute the range for a specific component. More...
 
virtual bool ComputeScalarRange (double *ranges)
 Computes the range for each component of an array, the length of ranges must be two times the number of components. More...
 
virtual bool ComputeVectorRange (double range[2])
 Returns true if the range was computed. More...
 
virtual bool ComputeFiniteScalarRange (double *ranges)
 Computes the range for each component of an array, the length of ranges must be two times the number of components. More...
 
virtual bool ComputeFiniteVectorRange (double range[2])
 Returns true if the range was computed. More...
 
 vtkDataArray ()
 
 ~vtkDataArray () override
 
- Protected Member Functions inherited from vtkAbstractArray
 vtkAbstractArray ()
 
 ~vtkAbstractArray () override
 
virtual void SetInformation (vtkInformation *)
 Set an information object that can be used to annotate the array. More...
 
virtual void UpdateDiscreteValueSet (double uncertainty, double minProminence)
 Obtain the set of unique values taken on by each component of the array, as well as by the tuples of the array. More...
 
- 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=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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

vtkBuffer< ValueType > * Buffer
 
- Protected Attributes inherited from vtkGenericDataArray< vtkAOSDataArrayTemplate< ValueTypeT >, ValueTypeT >
std::vector< double > LegacyTuple
 
std::vector< ValueTypeLegacyValueRange
 
std::vector< ValueTypeLegacyValueRangeFull
 
vtkGenericDataArrayLookupHelper< SelfTypeLookup
 
- Protected Attributes inherited from vtkDataArray
vtkLookupTableLookupTable
 
double Range [2]
 
double FiniteRange [2]
 
- Protected Attributes inherited from vtkAbstractArray
vtkIdType Size
 
vtkIdType MaxId
 
int NumberOfComponents
 
unsigned int MaxDiscreteValues
 
char * Name
 
bool RebuildArray
 
vtkInformationInformation
 
vtkInternalComponentNames * ComponentNames
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkGenericDataArray< vtkAOSDataArrayTemplate< ValueTypeT >, ValueTypeT >
 

Detailed Description

template<class ValueTypeT>
class vtkAOSDataArrayTemplate< ValueTypeT >

Array-Of-Structs implementation of vtkGenericDataArray.

vtkGenericDataArray specialization that stores data array in the traditional VTK memory layout where a 3 component is stored in contiguous memory as A1A2A3B1B2B3C1C2C3 ... where A,B,C,... are tuples.

This replaces vtkDataArrayTemplate.

See also
vtkGenericDataArray vtkSOADataArrayTemplate

Definition at line 41 of file vtkAOSDataArrayTemplate.h.

Member Typedef Documentation

◆ SelfType

template<class ValueTypeT>
typedef vtkAOSDataArrayTemplate<ValueTypeT> vtkAOSDataArrayTemplate< ValueTypeT >::SelfType

Definition at line 47 of file vtkAOSDataArrayTemplate.h.

◆ ValueType

template<class ValueTypeT>
typedef Superclass::ValueType vtkAOSDataArrayTemplate< ValueTypeT >::ValueType

Definition at line 49 of file vtkAOSDataArrayTemplate.h.

◆ Iterator

template<class ValueTypeT>
typedef ValueType* vtkAOSDataArrayTemplate< ValueTypeT >::Iterator

Legacy support for array-of-structs value iteration.

TODO Deprecate?

Definition at line 236 of file vtkAOSDataArrayTemplate.h.

Member Enumeration Documentation

◆ DeleteMethod

template<class ValueTypeT>
enum vtkAOSDataArrayTemplate::DeleteMethod
Enumerator
VTK_DATA_ARRAY_FREE 
VTK_DATA_ARRAY_DELETE 
VTK_DATA_ARRAY_ALIGNED_FREE 
VTK_DATA_ARRAY_USER_DEFINED 

Definition at line 51 of file vtkAOSDataArrayTemplate.h.

Constructor & Destructor Documentation

◆ vtkAOSDataArrayTemplate()

template<class ValueTypeT>
vtkAOSDataArrayTemplate< ValueTypeT >::vtkAOSDataArrayTemplate ( )
protected

◆ ~vtkAOSDataArrayTemplate()

template<class ValueTypeT>
vtkAOSDataArrayTemplate< ValueTypeT >::~vtkAOSDataArrayTemplate ( )
overrideprotected

Member Function Documentation

◆ vtkTemplateTypeMacro()

template<class ValueTypeT>
vtkAOSDataArrayTemplate< ValueTypeT >::vtkTemplateTypeMacro ( SelfType  ,
GenericDataArrayType   
)

◆ New()

template<class ValueTypeT>
static vtkAOSDataArrayTemplate* vtkAOSDataArrayTemplate< ValueTypeT >::New ( )
static

◆ GetValue()

template<class ValueTypeT>
ValueType vtkAOSDataArrayTemplate< ValueTypeT >::GetValue ( vtkIdType  valueIdx) const
inline

Get the value at valueIdx.

valueIdx assumes AOS ordering.

Definition at line 64 of file vtkAOSDataArrayTemplate.h.

◆ SetValue()

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::SetValue ( vtkIdType  valueIdx,
ValueType  value 
)
inline

Set the value at valueIdx to value.

valueIdx assumes AOS ordering.

Definition at line 73 of file vtkAOSDataArrayTemplate.h.

◆ GetTypedTuple()

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::GetTypedTuple ( vtkIdType  tupleIdx,
ValueType tuple 
) const
inline

Copy the tuple at tupleIdx into tuple.

Definition at line 83 of file vtkAOSDataArrayTemplate.h.

◆ SetTypedTuple()

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::SetTypedTuple ( vtkIdType  tupleIdx,
const ValueType tuple 
)
inline

Set this array's tuple at tupleIdx to the values in tuple.

Definition at line 96 of file vtkAOSDataArrayTemplate.h.

◆ GetTypedComponent()

template<class ValueTypeT>
ValueType vtkAOSDataArrayTemplate< ValueTypeT >::GetTypedComponent ( vtkIdType  tupleIdx,
int  comp 
) const
inline

Get component comp of the tuple at tupleIdx.

Definition at line 107 of file vtkAOSDataArrayTemplate.h.

◆ SetTypedComponent()

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::SetTypedComponent ( vtkIdType  tupleIdx,
int  comp,
ValueType  value 
)
inline

Set component comp of the tuple at tupleIdx to value.

Definition at line 117 of file vtkAOSDataArrayTemplate.h.

◆ FillTypedComponent()

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::FillTypedComponent ( int  compIdx,
ValueType  value 
)
override

Set component comp of all tuples to value.

◆ FillValue()

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::FillValue ( ValueType  value)
override

Set all the values in array to value.

◆ Fill()

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::Fill ( double  value)
overridevirtual

Fill all values of a data array with a specified value.

Reimplemented from vtkDataArray.

◆ WritePointer()

template<class ValueTypeT>
ValueType* vtkAOSDataArrayTemplate< ValueTypeT >::WritePointer ( vtkIdType  valueIdx,
vtkIdType  numValues 
)

Get the address of 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.

◆ WriteVoidPointer()

template<class ValueTypeT>
void* vtkAOSDataArrayTemplate< ValueTypeT >::WriteVoidPointer ( vtkIdType  valueIdx,
vtkIdType  numValues 
)
overridevirtual

Get the address of a particular data index.

Make sure data is allocated for the number of items requested. If needed, increase MaxId to mark any new value ranges as in-use.

Implements vtkDataArray.

◆ GetPointer()

template<class ValueTypeT>
ValueType* vtkAOSDataArrayTemplate< ValueTypeT >::GetPointer ( vtkIdType  valueIdx)

Get the address of a particular data index.

Performs no checks to verify that the memory has been allocated etc. Use of this method is discouraged, as newer arrays require a deep-copy of the array data in order to return a suitable pointer. See vtkArrayDispatch for a safer alternative for fast data access.

◆ GetVoidPointer()

template<class ValueTypeT>
void* vtkAOSDataArrayTemplate< ValueTypeT >::GetVoidPointer ( vtkIdType  valueIdx)
overridevirtual

Return a void pointer.

For image pipeline interface and other special pointer manipulation. Use of this method is discouraged, as newer arrays require a deep-copy of the array data in order to return a suitable pointer. See vtkArrayDispatch for a safer alternative for fast data access.

Implements vtkAbstractArray.

◆ SetArray() [1/2]

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::SetArray ( ValueType array,
vtkIdType  size,
int  save,
int  deleteMethod 
)

This method lets the user specify data to be held by the array.

The array argument is a pointer to the data. size is the size of the array supplied by the user (as number of values, not in bytes). Set save to 1 to prevent the class from deleting the array when it cleans up or reallocates memory. The class uses the actual array provided; it does not copy the data from the suppled array. If specified, the delete method determines how the data array will be deallocated. If the delete method is VTK_DATA_ARRAY_FREE, free() will be used. If the delete method is VTK_DATA_ARRAY_DELETE, delete[] will be used. If the delete method is VTK_DATA_ARRAY_ALIGNED_FREE _aligned_free() will be used on Windows, while free() will be used everywhere else. The default is FREE.

◆ SetArray() [2/2]

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::SetArray ( ValueType array,
vtkIdType  size,
int  save 
)

◆ SetVoidArray() [1/2]

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::SetVoidArray ( void *  array,
vtkIdType  size,
int  save 
)
override

◆ SetVoidArray() [2/2]

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::SetVoidArray ( void *  array,
vtkIdType  size,
int  save,
int  deleteMethod 
)
override

◆ SetArrayFreeFunction()

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::SetArrayFreeFunction ( void(*)(void *)  callback)
overridevirtual

This method allows the user to specify a custom free function to be called when the array is deallocated.

Calling this method will implicitly mean that the given free function will be called when the class cleans up or reallocates memory.

Implements vtkAbstractArray.

◆ SetTuple() [1/3]

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::SetTuple ( vtkIdType  tupleIdx,
const float *  tuple 
)
overridevirtual

Set the data tuple at tupleIdx.

Note that range checking or memory allocation is not performed; use this method in conjunction with SetNumberOfTuples() to allocate space.

Reimplemented from vtkDataArray.

◆ SetTuple() [2/3]

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::SetTuple ( vtkIdType  tupleIdx,
const double *  tuple 
)
overridevirtual

Reimplemented from vtkDataArray.

◆ SetTuple() [3/3]

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::SetTuple ( vtkIdType  dstTupleIdx,
vtkIdType  srcTupleIdx,
vtkAbstractArray source 
)
inlineoverridevirtual

Set the tuple at dstTupleIdx in this array to the tuple at srcTupleIdx in the source array.

This method assumes that the two arrays have the same type and structure. Note that range checking and memory allocation is not performed; use in conjunction with SetNumberOfTuples() to allocate space.

Implements vtkAbstractArray.

Definition at line 196 of file vtkAOSDataArrayTemplate.h.

◆ InsertTuple() [1/3]

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::InsertTuple ( vtkIdType  tupleIdx,
const float *  tuple 
)
overridevirtual

Insert the data tuple at tupleIdx.

Note that memory allocation is performed as necessary to hold the data.

Implements vtkDataArray.

◆ InsertTuple() [2/3]

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::InsertTuple ( vtkIdType  tupleIdx,
const double *  source 
)
overridevirtual

Implements vtkDataArray.

◆ InsertTuple() [3/3]

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::InsertTuple ( vtkIdType  dstTupleIdx,
vtkIdType  srcTupleIdx,
vtkAbstractArray source 
)
inlineoverridevirtual

Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx.

Note that memory allocation is performed as necessary to hold the data.

Implements vtkAbstractArray.

Definition at line 204 of file vtkAOSDataArrayTemplate.h.

◆ InsertComponent()

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::InsertComponent ( vtkIdType  tupleIdx,
int  compIdx,
double  value 
)
overridevirtual

Insert value at the location specified by tupleIdx and compIdx.

Note that memory allocation is performed as necessary to hold the data.

Reimplemented from vtkDataArray.

◆ InsertNextTuple() [1/3]

template<class ValueTypeT>
vtkIdType vtkAOSDataArrayTemplate< ValueTypeT >::InsertNextTuple ( const float *  tuple)
overridevirtual

Insert the data tuple at the end of the array and return the tuple index at which the data was inserted.

Memory is allocated as necessary to hold the data.

Implements vtkDataArray.

◆ InsertNextTuple() [2/3]

template<class ValueTypeT>
vtkIdType vtkAOSDataArrayTemplate< ValueTypeT >::InsertNextTuple ( const double *  tuple)
overridevirtual

Implements vtkDataArray.

◆ InsertNextTuple() [3/3]

template<class ValueTypeT>
vtkIdType vtkAOSDataArrayTemplate< ValueTypeT >::InsertNextTuple ( vtkIdType  srcTupleIdx,
vtkAbstractArray source 
)
inlineoverridevirtual

Insert the tuple from srcTupleIdx in the source array at the end of this array.

Note that memory allocation is performed as necessary to hold the data. Returns the tuple index at which the data was inserted.

Implements vtkAbstractArray.

Definition at line 213 of file vtkAOSDataArrayTemplate.h.

◆ GetTuple() [1/2]

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::GetTuple ( vtkIdType  tupleIdx,
double *  tuple 
)
overridevirtual

Get the data tuple at tupleIdx by filling in a user-provided array, Make sure that your array is large enough to hold the NumberOfComponents amount of data being returned.

Implements vtkDataArray.

◆ GetTuple() [2/2]

template<class ValueTypeT>
double* vtkAOSDataArrayTemplate< ValueTypeT >::GetTuple ( vtkIdType  tupleIdx)
overridevirtual

Get the data tuple at tupleIdx.

Return it as a pointer to an array. Note: this method is not thread-safe, and the pointer is only valid as long as another method invocation to a vtk object is not performed.

Implements vtkDataArray.

◆ DataElementChanged()

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::DataElementChanged ( vtkIdType  )
inline

Tell the array explicitly that a single data element has changed.

Like DataChanged(), then is only necessary when you modify the array contents without using the array's API.

Note
This is a legacy method from vtkDataArrayTemplate, and is only implemented for array-of-struct arrays. It currently just calls DataChanged() and does nothing clever. TODO this is only defined for AOS (vtkDataArrayTemplate leftover). Deprecate to favor DataChanged?

Definition at line 230 of file vtkAOSDataArrayTemplate.h.

◆ Begin()

template<class ValueTypeT>
Iterator vtkAOSDataArrayTemplate< ValueTypeT >::Begin ( )
inline

Definition at line 237 of file vtkAOSDataArrayTemplate.h.

◆ End()

template<class ValueTypeT>
Iterator vtkAOSDataArrayTemplate< ValueTypeT >::End ( )
inline

Definition at line 238 of file vtkAOSDataArrayTemplate.h.

◆ FastDownCast()

template<class ValueTypeT>
static vtkAOSDataArrayTemplate<ValueType>* vtkAOSDataArrayTemplate< ValueTypeT >::FastDownCast ( vtkAbstractArray source)
inlinestatic

Perform a fast, safe cast from a vtkAbstractArray to a vtkAOSDataArrayTemplate.

This method checks if source->GetArrayType() returns AOSDataArrayTemplate or a more derived type, checks the data types, and performs a static_cast to return source as a vtkDataArray pointer. Otherwise, nullptr is returned.

Definition at line 248 of file vtkAOSDataArrayTemplate.h.

◆ GetArrayType()

template<class ValueTypeT>
int vtkAOSDataArrayTemplate< ValueTypeT >::GetArrayType ( )
inlineoverridevirtual

Method for type-checking in FastDownCast implementations.

See also vtkArrayDownCast.

Reimplemented from vtkAbstractArray.

Definition at line 266 of file vtkAOSDataArrayTemplate.h.

◆ NewIterator()

template<class ValueTypeT>
vtkArrayIterator* vtkAOSDataArrayTemplate< ValueTypeT >::NewIterator ( )
overridevirtual

Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate.

Implements vtkAbstractArray.

◆ HasStandardMemoryLayout()

template<class ValueTypeT>
bool vtkAOSDataArrayTemplate< ValueTypeT >::HasStandardMemoryLayout ( )
inlineoverridevirtual

Returns true if this array uses the standard memory layout defined in the VTK user guide, e.g.

a contiguous array: {t1c1, t1c2, t1c3, ... t1cM, t2c1, ... tNcM} where t1c2 is the second component of the first tuple.

Reimplemented from vtkAbstractArray.

Definition at line 268 of file vtkAOSDataArrayTemplate.h.

◆ ShallowCopy()

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::ShallowCopy ( vtkDataArray other)
overridevirtual

Create a shallow copy of other into this, if possible.

Shallow copies are only possible: (a) if both arrays are the same data type (b) if both arrays are the same array type (e.g. AOS vs. SOA) (c) if both arrays support shallow copies (e.g. vtkBitArray currently does not.) If a shallow copy is not possible, a deep copy will be performed instead.

Reimplemented from vtkDataArray.

◆ InsertTuples() [1/2]

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::InsertTuples ( vtkIdType  dstStart,
vtkIdType  n,
vtkIdType  srcStart,
vtkAbstractArray source 
)
overridevirtual

Copy n consecutive tuples starting at srcStart from the source array to this array, starting at the dstStart location.

Note that memory allocation is performed as necessary to hold the data.

Implements vtkAbstractArray.

◆ InsertTuples() [2/2]

template<class ValueTypeT>
void vtkAOSDataArrayTemplate< ValueTypeT >::InsertTuples ( vtkIdList dstIds,
vtkIdList srcIds,
vtkAbstractArray source 
)
inlineoverridevirtual

Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in this array.

Note that memory allocation is performed as necessary to hold the data.

Implements vtkAbstractArray.

Definition at line 276 of file vtkAOSDataArrayTemplate.h.

◆ AllocateTuples()

template<class ValueTypeT>
bool vtkAOSDataArrayTemplate< ValueTypeT >::AllocateTuples ( vtkIdType  numTuples)
protected

Allocate space for numTuples.

Old data is not preserved. If numTuples == 0, all data is freed.

◆ ReallocateTuples()

template<class ValueTypeT>
bool vtkAOSDataArrayTemplate< ValueTypeT >::ReallocateTuples ( vtkIdType  numTuples)
protected

Allocate space for numTuples.

Old data is preserved. If numTuples == 0, all data is freed.

Friends And Related Function Documentation

◆ vtkGenericDataArray< vtkAOSDataArrayTemplate< ValueTypeT >, ValueTypeT >

template<class ValueTypeT>
friend class vtkGenericDataArray< vtkAOSDataArrayTemplate< ValueTypeT >, ValueTypeT >
friend

Definition at line 303 of file vtkAOSDataArrayTemplate.h.

Member Data Documentation

◆ Buffer

template<class ValueTypeT>
vtkBuffer<ValueType>* vtkAOSDataArrayTemplate< ValueTypeT >::Buffer
protected

Definition at line 297 of file vtkAOSDataArrayTemplate.h.


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