VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
vtkDataSetAttributes Class Reference

represent and manipulate attribute data in a dataset More...

#include <vtkDataSetAttributes.h>

Inheritance diagram for vtkDataSetAttributes:
[legend]
Collaboration diagram for vtkDataSetAttributes:
[legend]

Classes

class  FieldList
 

Public Types

enum  AttributeTypes {
  SCALARS =0, VECTORS =1, NORMALS =2, TCOORDS =3,
  TENSORS =4, GLOBALIDS =5, PEDIGREEIDS =6, EDGEFLAG =7,
  NUM_ATTRIBUTES
}
 
enum  AttributeLimitTypes { MAX, EXACT, NOLIMIT }
 
enum  CellGhostTypes {
  DUPLICATECELL = 1, HIGHCONNECTIVITYCELL = 2, LOWCONNECTIVITYCELL = 4, REFINEDCELL = 8,
  EXTERIORCELL = 16, HIDDENCELL = 32
}
 
enum  PointGhostTypes { DUPLICATEPOINT =1, HIDDENPOINT =2 }
 
enum  AttributeCopyOperations { COPYTUPLE =0, INTERPOLATE =1, PASSDATA =2, ALLCOPY }
 
typedef vtkFieldData Superclass
 
- Public Types inherited from vtkFieldData
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkDataSetAttributes * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Initialize ()
 
virtual void Update ()
 
virtual void DeepCopy (vtkFieldData *pd)
 
virtual void ShallowCopy (vtkFieldData *pd)
 
int SetActiveAttribute (const char *name, int attributeType)
 
int SetActiveAttribute (int index, int attributeType)
 
void GetAttributeIndices (int *indexArray)
 
int IsArrayAnAttribute (int idx)
 
int SetAttribute (vtkAbstractArray *aa, int attributeType)
 
vtkDataArray * GetAttribute (int attributeType)
 
vtkAbstractArray * GetAbstractAttribute (int attributeType)
 
void SetCopyAttribute (int index, int value, int ctype=ALLCOPY)
 
virtual void CopyAllOn (int ctype=ALLCOPY)
 
virtual void CopyAllOff (int ctype=ALLCOPY)
 
virtual void PassData (vtkFieldData *fd)
 
int SetScalars (vtkDataArray *da)
 
int SetActiveScalars (const char *name)
 
vtkDataArray * GetScalars ()
 
int SetVectors (vtkDataArray *da)
 
int SetActiveVectors (const char *name)
 
vtkDataArray * GetVectors ()
 
int SetNormals (vtkDataArray *da)
 
int SetActiveNormals (const char *name)
 
vtkDataArray * GetNormals ()
 
int SetTCoords (vtkDataArray *da)
 
int SetActiveTCoords (const char *name)
 
vtkDataArray * GetTCoords ()
 
int SetTensors (vtkDataArray *da)
 
int SetActiveTensors (const char *name)
 
vtkDataArray * GetTensors ()
 
int SetGlobalIds (vtkDataArray *da)
 
int SetActiveGlobalIds (const char *name)
 
vtkDataArray * GetGlobalIds ()
 
int SetPedigreeIds (vtkAbstractArray *da)
 
int SetActivePedigreeIds (const char *name)
 
vtkAbstractArray * GetPedigreeIds ()
 
vtkDataArray * GetScalars (const char *name)
 
vtkDataArray * GetVectors (const char *name)
 
vtkDataArray * GetNormals (const char *name)
 
vtkDataArray * GetTCoords (const char *name)
 
vtkDataArray * GetTensors (const char *name)
 
vtkDataArray * GetGlobalIds (const char *name)
 
vtkAbstractArray * GetPedigreeIds (const char *name)
 
virtual void RemoveArray (const char *name)
 
virtual void RemoveArray (int index)
 
void SetCopyScalars (int i, int ctype=ALLCOPY)
 
int GetCopyScalars (int ctype=ALLCOPY)
 
virtual void CopyScalarsOn ()
 
virtual void CopyScalarsOff ()
 
void SetCopyVectors (int i, int ctype=ALLCOPY)
 
int GetCopyVectors (int ctype=ALLCOPY)
 
virtual void CopyVectorsOn ()
 
virtual void CopyVectorsOff ()
 
void SetCopyNormals (int i, int ctype=ALLCOPY)
 
int GetCopyNormals (int ctype=ALLCOPY)
 
virtual void CopyNormalsOn ()
 
virtual void CopyNormalsOff ()
 
void SetCopyTCoords (int i, int ctype=ALLCOPY)
 
int GetCopyTCoords (int ctype=ALLCOPY)
 
virtual void CopyTCoordsOn ()
 
virtual void CopyTCoordsOff ()
 
void SetCopyTensors (int i, int ctype=ALLCOPY)
 
int GetCopyTensors (int ctype=ALLCOPY)
 
virtual void CopyTensorsOn ()
 
virtual void CopyTensorsOff ()
 
void SetCopyGlobalIds (int i, int ctype=ALLCOPY)
 
int GetCopyGlobalIds (int ctype=ALLCOPY)
 
virtual void CopyGlobalIdsOn ()
 
virtual void CopyGlobalIdsOff ()
 
void SetCopyPedigreeIds (int i, int ctype=ALLCOPY)
 
int GetCopyPedigreeIds (int ctype=ALLCOPY)
 
virtual void CopyPedigreeIdsOn ()
 
virtual void CopyPedigreeIdsOff ()
 
void CopyAllocate (vtkDataSetAttributes *pd, vtkIdType sze=0, vtkIdType ext=1000)
 
void CopyAllocate (vtkDataSetAttributes *pd, vtkIdType sze, vtkIdType ext, int shallowCopyArrays)
 
void CopyStructuredData (vtkDataSetAttributes *inDsa, const int *inExt, const int *outExt)
 
void CopyData (vtkDataSetAttributes *fromPd, vtkIdType fromId, vtkIdType toId)
 
void CopyData (vtkDataSetAttributes *fromPd, vtkIdList *fromIds, vtkIdList *toIds)
 
void CopyData (vtkDataSetAttributes *fromPd, vtkIdType dstStart, vtkIdType n, vtkIdType srcStart)
 
void CopyTuple (vtkAbstractArray *fromData, vtkAbstractArray *toData, vtkIdType fromId, vtkIdType toId)
 
void CopyTuples (vtkAbstractArray *fromData, vtkAbstractArray *toData, vtkIdList *fromIds, vtkIdList *toIds)
 
void CopyTuples (vtkAbstractArray *fromData, vtkAbstractArray *toData, vtkIdType dstStart, vtkIdType n, vtkIdType srcStart)
 
void InterpolateAllocate (vtkDataSetAttributes *pd, vtkIdType sze=0, vtkIdType ext=1000)
 
void InterpolateAllocate (vtkDataSetAttributes *pd, vtkIdType sze, vtkIdType ext, int shallowCopyArrays)
 
void InterpolatePoint (vtkDataSetAttributes *fromPd, vtkIdType toId, vtkIdList *ids, double *weights)
 
void InterpolateEdge (vtkDataSetAttributes *fromPd, vtkIdType toId, vtkIdType p1, vtkIdType p2, double t)
 
void InterpolateTime (vtkDataSetAttributes *from1, vtkDataSetAttributes *from2, vtkIdType id, double t)
 
void CopyAllocate (vtkDataSetAttributes::FieldList &list, vtkIdType sze=0, vtkIdType ext=1000)
 
void CopyData (vtkDataSetAttributes::FieldList &list, vtkDataSetAttributes *dsa, int idx, vtkIdType fromId, vtkIdType toId)
 
void InterpolateAllocate (vtkDataSetAttributes::FieldList &list, vtkIdType sze=0, vtkIdType ext=1000)
 
void InterpolatePoint (vtkDataSetAttributes::FieldList &list, vtkDataSetAttributes *fromPd, int idx, vtkIdType toId, vtkIdList *ids, double *weights)
 
- Public Member Functions inherited from vtkFieldData
vtkFieldData * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int Allocate (const vtkIdType sz, const vtkIdType ext=1000)
 
void CopyStructure (vtkFieldData *)
 
void AllocateArrays (int num)
 
int AddArray (vtkAbstractArray *array)
 
vtkDataArray * GetArray (int i)
 
vtkDataArray * GetArray (const char *arrayName, int &index)
 
vtkAbstractArray * GetAbstractArray (int i)
 
vtkAbstractArray * GetAbstractArray (const char *arrayName, int &index)
 
void Squeeze ()
 
void Reset ()
 
virtual unsigned long GetActualMemorySize ()
 
unsigned long int GetMTime ()
 
void GetField (vtkIdList *ptId, vtkFieldData *f)
 
int GetArrayContainingComponent (int i, int &arrayComp)
 
int GetNumberOfComponents ()
 
vtkIdType GetNumberOfTuples ()
 
void SetNumberOfTuples (const vtkIdType number)
 
void SetTuple (const vtkIdType i, const vtkIdType j, vtkFieldData *source)
 
void InsertTuple (const vtkIdType i, const vtkIdType j, vtkFieldData *source)
 
vtkIdType InsertNextTuple (const vtkIdType j, vtkFieldData *source)
 
int GetNumberOfArrays ()
 
vtkDataArray * GetArray (const char *arrayName)
 
vtkAbstractArray * GetAbstractArray (const char *arrayName)
 
int HasArray (const char *name)
 
const char * GetArrayName (int i)
 
void CopyFieldOn (const char *name)
 
void CopyFieldOff (const char *name)
 
- Public Member Functions inherited from vtkObject
vtkObject * NewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommand * GetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkDataSetAttributes * New ()
 
static int IsTypeOf (const char *type)
 
static vtkDataSetAttributes * SafeDownCast (vtkObjectBase *o)
 
static const char * GhostArrayName ()
 
static const char * GetAttributeTypeAsString (int attributeType)
 
static const char * GetLongAttributeTypeAsString (int attributeType)
 
- Static Public Member Functions inherited from vtkFieldData
static vtkFieldData * New ()
 
static int IsTypeOf (const char *type)
 
static vtkFieldData * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObject * SafeDownCast (vtkObjectBase *o)
 
static vtkObject * New ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBase * New ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkDataSetAttributes ()
 
 ~vtkDataSetAttributes ()
 
void InternalCopyAllocate (vtkDataSetAttributes *pd, int ctype, vtkIdType sze=0, vtkIdType ext=1000, int shallowCopyArrays=0)
 
void InternalCopyAllocate (vtkDataSetAttributes::FieldList &list, int ctype, vtkIdType sze, vtkIdType ext)
 
virtual void InitializeFields ()
 
- Protected Member Functions inherited from vtkFieldData
 vtkFieldData ()
 
 ~vtkFieldData ()
 
void SetArray (int i, vtkAbstractArray *array)
 
void CopyFieldOnOff (const char *name, int onOff)
 
void ClearFieldFlags ()
 
int FindFlag (const char *field)
 
int GetFlag (const char *field)
 
void CopyFlags (const vtkFieldData *source)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int AttributeIndices [NUM_ATTRIBUTES]
 
int CopyAttributeFlags [ALLCOPY][NUM_ATTRIBUTES]
 
vtkFieldData::BasicIterator RequiredArrays
 
int * TargetIndices
 
- Protected Attributes inherited from vtkFieldData
int NumberOfArrays
 
int NumberOfActiveArrays
 
vtkAbstractArray ** Data
 
CopyFieldFlag * CopyFieldFlags
 
int NumberOfFieldFlags
 
int DoCopyAllOn
 
int DoCopyAllOff
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Static Protected Attributes

static const int NumberOfAttributeComponents [NUM_ATTRIBUTES]
 
static const int AttributeLimits [NUM_ATTRIBUTES]
 
static const char AttributeNames [NUM_ATTRIBUTES][12]
 
static const char LongAttributeNames [NUM_ATTRIBUTES][35]
 

Friends

class vtkDataSetAttributes::FieldList
 

Detailed Description

represent and manipulate attribute data in a dataset

vtkDataSetAttributes is a class that is used to represent and manipulate attribute data (e.g., scalars, vectors, normals, texture coordinates, tensors, global ids, pedigree ids, and field data).

This adds to vtkFieldData the ability to pick one of the arrays from the field as the currently active array for each attribute type. In other words, you pick one array to be called "THE" Scalars, and then filters down the pipeline will treat that array specially. For example vtkContourFilter will contour "THE" Scalar array unless a different array is asked for.

Additionally vtkDataSetAttributes provides methods that filters call to pass data through, copy data into, and interpolate from Fields. PassData passes entire arrays from the source to the destination. Copy passes through some subset of the tuples from the source to the destination. Interpolate interpolates from the chosen tuple(s) in the source data, using the provided weights, to produce new tuples in the destination. Each attribute type has pass, copy and interpolate "copy" flags that can be set in the destination to choose which attribute arrays will be transferred from the source to the destination.

Finally this class provides a mechanism to determine which attributes a group of sources have in common, and to copy tuples from a source into the destination, for only those attributes that are held by all.

Examples:
vtkDataSetAttributes (Examples)
Tests:
vtkDataSetAttributes (Tests)

Definition at line 57 of file vtkDataSetAttributes.h.

Member Typedef Documentation

typedef vtkFieldData vtkDataSetAttributes::Superclass

Definition at line 63 of file vtkDataSetAttributes.h.

Member Enumeration Documentation

enum vtkDataSetAttributes::AttributeTypes
Enumerator
SCALARS 
VECTORS 
NORMALS 
TCOORDS 
TENSORS 
GLOBALIDS 
PEDIGREEIDS 
EDGEFLAG 
NUM_ATTRIBUTES 

Definition at line 87 of file vtkDataSetAttributes.h.

enum vtkDataSetAttributes::AttributeLimitTypes
Enumerator
MAX 
EXACT 
NOLIMIT 

Definition at line 100 of file vtkDataSetAttributes.h.

enum vtkDataSetAttributes::CellGhostTypes
Enumerator
DUPLICATECELL 
HIGHCONNECTIVITYCELL 
LOWCONNECTIVITYCELL 
REFINEDCELL 
EXTERIORCELL 
HIDDENCELL 

Definition at line 112 of file vtkDataSetAttributes.h.

enum vtkDataSetAttributes::PointGhostTypes
Enumerator
DUPLICATEPOINT 
HIDDENPOINT 

Definition at line 122 of file vtkDataSetAttributes.h.

enum vtkDataSetAttributes::AttributeCopyOperations
Enumerator
COPYTUPLE 
INTERPOLATE 
PASSDATA 
ALLCOPY 

Definition at line 265 of file vtkDataSetAttributes.h.

Constructor & Destructor Documentation

vtkDataSetAttributes::vtkDataSetAttributes ( )
protected
vtkDataSetAttributes::~vtkDataSetAttributes ( )
protected

Member Function Documentation

static vtkDataSetAttributes* vtkDataSetAttributes::New ( )
static

Construct object with copying turned on for all data.

static int vtkDataSetAttributes::IsTypeOf ( const char *  type)
static
virtual int vtkDataSetAttributes::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkFieldData.

Reimplemented in vtkCellData, and vtkPointData.

static vtkDataSetAttributes* vtkDataSetAttributes::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkDataSetAttributes::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkFieldData.

Reimplemented in vtkCellData, and vtkPointData.

vtkDataSetAttributes* vtkDataSetAttributes::NewInstance ( ) const
void vtkDataSetAttributes::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkPointData.

virtual void vtkDataSetAttributes::Initialize ( )
virtual

Initialize all of the object's data to NULL Also, clear the copy flags.

Reimplemented from vtkFieldData.

virtual void vtkDataSetAttributes::Update ( )
inlinevirtual

Attributes have a chance to bring themselves up to date; right now this is ignored.

Definition at line 72 of file vtkDataSetAttributes.h.

virtual void vtkDataSetAttributes::DeepCopy ( vtkFieldData *  pd)
virtual

Deep copy of data (i.e., create new data arrays and copy from input data). Ignores the copy flags but preserves them in the output.

Reimplemented from vtkFieldData.

virtual void vtkDataSetAttributes::ShallowCopy ( vtkFieldData *  pd)
virtual

Shallow copy of data (i.e., use reference counting). Ignores the copy flags but preserves them in the output.

Reimplemented from vtkFieldData.

static const char* vtkDataSetAttributes::GhostArrayName ( )
inlinestatic

Definition at line 131 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::SetScalars ( vtkDataArray *  da)

Set/Get the scalar data.

int vtkDataSetAttributes::SetActiveScalars ( const char *  name)

Set/Get the scalar data.

vtkDataArray* vtkDataSetAttributes::GetScalars ( )

Set/Get the scalar data.

int vtkDataSetAttributes::SetVectors ( vtkDataArray *  da)

Set/Get the vector data.

int vtkDataSetAttributes::SetActiveVectors ( const char *  name)

Set/Get the vector data.

vtkDataArray* vtkDataSetAttributes::GetVectors ( )

Set/Get the vector data.

int vtkDataSetAttributes::SetNormals ( vtkDataArray *  da)

Set/get the normal data.

int vtkDataSetAttributes::SetActiveNormals ( const char *  name)

Set/get the normal data.

vtkDataArray* vtkDataSetAttributes::GetNormals ( )

Set/get the normal data.

int vtkDataSetAttributes::SetTCoords ( vtkDataArray *  da)

Set/Get the texture coordinate data.

int vtkDataSetAttributes::SetActiveTCoords ( const char *  name)

Set/Get the texture coordinate data.

vtkDataArray* vtkDataSetAttributes::GetTCoords ( )

Set/Get the texture coordinate data.

int vtkDataSetAttributes::SetTensors ( vtkDataArray *  da)

Set/Get the tensor data.

int vtkDataSetAttributes::SetActiveTensors ( const char *  name)

Set/Get the tensor data.

vtkDataArray* vtkDataSetAttributes::GetTensors ( )

Set/Get the tensor data.

int vtkDataSetAttributes::SetGlobalIds ( vtkDataArray *  da)

Set/Get the global id data.

int vtkDataSetAttributes::SetActiveGlobalIds ( const char *  name)

Set/Get the global id data.

vtkDataArray* vtkDataSetAttributes::GetGlobalIds ( )

Set/Get the global id data.

int vtkDataSetAttributes::SetPedigreeIds ( vtkAbstractArray *  da)

Set/Get the pedigree id data.

int vtkDataSetAttributes::SetActivePedigreeIds ( const char *  name)

Set/Get the pedigree id data.

vtkAbstractArray* vtkDataSetAttributes::GetPedigreeIds ( )

Set/Get the pedigree id data.

vtkDataArray* vtkDataSetAttributes::GetScalars ( const char *  name)

This will first look for an array with the correct name. If one exists, it is returned. Otherwise, the name argument is ignored, and the active attribute is returned.

vtkDataArray* vtkDataSetAttributes::GetVectors ( const char *  name)

This will first look for an array with the correct name. If one exists, it is returned. Otherwise, the name argument is ignored, and the active attribute is returned.

vtkDataArray* vtkDataSetAttributes::GetNormals ( const char *  name)

This will first look for an array with the correct name. If one exists, it is returned. Otherwise, the name argument is ignored, and the active attribute is returned.

vtkDataArray* vtkDataSetAttributes::GetTCoords ( const char *  name)

This will first look for an array with the correct name. If one exists, it is returned. Otherwise, the name argument is ignored, and the active attribute is returned.

vtkDataArray* vtkDataSetAttributes::GetTensors ( const char *  name)

This will first look for an array with the correct name. If one exists, it is returned. Otherwise, the name argument is ignored, and the active attribute is returned.

vtkDataArray* vtkDataSetAttributes::GetGlobalIds ( const char *  name)

This will first look for an array with the correct name. If one exists, it is returned. Otherwise, the name argument is ignored, and the active attribute is returned.

vtkAbstractArray* vtkDataSetAttributes::GetPedigreeIds ( const char *  name)

This will first look for an array with the correct name. If one exists, it is returned. Otherwise, the name argument is ignored, and the active attribute is returned.

int vtkDataSetAttributes::SetActiveAttribute ( const char *  name,
int  attributeType 
)

Make the array with the given name the active attribute. Attribute types are: vtkDataSetAttributes::SCALARS = 0 vtkDataSetAttributes::VECTORS = 1 vtkDataSetAttributes::NORMALS = 2 vtkDataSetAttributes::TCOORDS = 3 vtkDataSetAttributes::TENSORS = 4 vtkDataSetAttributes::GLOBALIDS = 5 vtkDataSetAttributes::PEDIGREEIDS = 6 vtkDataSetAttributes::EDGEFLAG = 7 Returns the index of the array if successful, -1 if the array is not in the list of arrays.

int vtkDataSetAttributes::SetActiveAttribute ( int  index,
int  attributeType 
)

Make the array with the given index the active attribute.

void vtkDataSetAttributes::GetAttributeIndices ( int *  indexArray)

Get the field data array indices corresponding to scalars, vectors, tensors, etc.

int vtkDataSetAttributes::IsArrayAnAttribute ( int  idx)

Determine whether a data array of index idx is considered a data set attribute (i.e., scalar, vector, tensor, etc). Return less-than zero if it is, otherwise an index 0<=idx<NUM_ATTRIBUTES to indicate which attribute.

int vtkDataSetAttributes::SetAttribute ( vtkAbstractArray *  aa,
int  attributeType 
)

Set an array to use as the given attribute type (i.e., vtkDataSetAttributes::SCALAR, vtkDataSetAttributes::VECTOR, vtkDataSetAttributes::TENSOR, etc.). If this attribute was previously set to another array, that array is removed from the vtkDataSetAttributes object and the array aa is used as the attribute. Returns the index of aa within the vtkDataSetAttributes object (i.e., the index to pass to the method GetArray(int) to obtain aa) if the attribute was set to aa successfully. If aa was already set as the given attributeType, returns the index of aa. Returns -1 in the following cases: - aa is NULL (used to unset an attribute; not an error indicator) - aa is not a subclass of vtkDataArray, unless the attributeType is vtkDataSetAttributes::PEDIGREEIDS (error indicator) - aa has a number of components incompatible with the attribute type (error indicator)

vtkDataArray* vtkDataSetAttributes::GetAttribute ( int  attributeType)

Return an attribute given the attribute type (see vtkDataSetAttributes::AttributeTypes). Some attributes (such as PEDIGREEIDS) may not be vtkDataArray subclass, so in that case use GetAbstractAttribute().

vtkAbstractArray* vtkDataSetAttributes::GetAbstractAttribute ( int  attributeType)

Return an attribute given the attribute type (see vtkDataSetAttributes::AttributeTypes). This is the same as GetAttribute(), except that the returned array is a vtkAbstractArray instead of vtkDataArray. Some attributes (such as PEDIGREEIDS) may not be vtkDataArray subclass.

virtual void vtkDataSetAttributes::RemoveArray ( const char *  name)
virtual

Remove an array (with the given name) from the list of arrays.

Reimplemented from vtkFieldData.

virtual void vtkDataSetAttributes::RemoveArray ( int  index)
virtual

Remove an array (with the given name) from the list of arrays.

Reimplemented from vtkFieldData.

static const char* vtkDataSetAttributes::GetAttributeTypeAsString ( int  attributeType)
static

Given an integer attribute type, this static method returns a string type for the attribute (i.e. type = 0: returns "Scalars").

static const char* vtkDataSetAttributes::GetLongAttributeTypeAsString ( int  attributeType)
static

Given an integer attribute type, this static method returns a string type for the attribute (i.e. type = 0: returns "Scalars").

void vtkDataSetAttributes::SetCopyAttribute ( int  index,
int  value,
int  ctype = ALLCOPY 
)

Specify whether to copy the data attribute referred to by index. ctype selects from the AttributeCopyOperations. If ctype is set to ALLCOPY, then COPYTUPLE, INTERPOLATE, and PASSDATA are set to value. If value is 0, copying is disallowed. otherwise it is allowed.

void vtkDataSetAttributes::SetCopyScalars ( int  i,
int  ctype = ALLCOPY 
)

Turn on/off the copying of scalar data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

int vtkDataSetAttributes::GetCopyScalars ( int  ctype = ALLCOPY)

Turn on/off the copying of scalar data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

virtual void vtkDataSetAttributes::CopyScalarsOn ( )
virtual

Turn on/off the copying of scalar data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

virtual void vtkDataSetAttributes::CopyScalarsOff ( )
virtual

Turn on/off the copying of scalar data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

void vtkDataSetAttributes::SetCopyVectors ( int  i,
int  ctype = ALLCOPY 
)

Turn on/off the copying of vector data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

int vtkDataSetAttributes::GetCopyVectors ( int  ctype = ALLCOPY)

Turn on/off the copying of vector data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

virtual void vtkDataSetAttributes::CopyVectorsOn ( )
virtual

Turn on/off the copying of vector data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

virtual void vtkDataSetAttributes::CopyVectorsOff ( )
virtual

Turn on/off the copying of vector data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

void vtkDataSetAttributes::SetCopyNormals ( int  i,
int  ctype = ALLCOPY 
)

Turn on/off the copying of normals data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

int vtkDataSetAttributes::GetCopyNormals ( int  ctype = ALLCOPY)

Turn on/off the copying of normals data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

virtual void vtkDataSetAttributes::CopyNormalsOn ( )
virtual

Turn on/off the copying of normals data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

virtual void vtkDataSetAttributes::CopyNormalsOff ( )
virtual

Turn on/off the copying of normals data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

void vtkDataSetAttributes::SetCopyTCoords ( int  i,
int  ctype = ALLCOPY 
)

Turn on/off the copying of texture coordinates data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

int vtkDataSetAttributes::GetCopyTCoords ( int  ctype = ALLCOPY)

Turn on/off the copying of texture coordinates data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

virtual void vtkDataSetAttributes::CopyTCoordsOn ( )
virtual

Turn on/off the copying of texture coordinates data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

virtual void vtkDataSetAttributes::CopyTCoordsOff ( )
virtual

Turn on/off the copying of texture coordinates data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

void vtkDataSetAttributes::SetCopyTensors ( int  i,
int  ctype = ALLCOPY 
)

Turn on/off the copying of tensor data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

int vtkDataSetAttributes::GetCopyTensors ( int  ctype = ALLCOPY)

Turn on/off the copying of tensor data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

virtual void vtkDataSetAttributes::CopyTensorsOn ( )
virtual

Turn on/off the copying of tensor data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

virtual void vtkDataSetAttributes::CopyTensorsOff ( )
virtual

Turn on/off the copying of tensor data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

void vtkDataSetAttributes::SetCopyGlobalIds ( int  i,
int  ctype = ALLCOPY 
)

Turn on/off the copying of global id data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

int vtkDataSetAttributes::GetCopyGlobalIds ( int  ctype = ALLCOPY)

Turn on/off the copying of global id data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

virtual void vtkDataSetAttributes::CopyGlobalIdsOn ( )
virtual

Turn on/off the copying of global id data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

virtual void vtkDataSetAttributes::CopyGlobalIdsOff ( )
virtual

Turn on/off the copying of global id data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

void vtkDataSetAttributes::SetCopyPedigreeIds ( int  i,
int  ctype = ALLCOPY 
)

Turn on/off the copying of pedigree id data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

int vtkDataSetAttributes::GetCopyPedigreeIds ( int  ctype = ALLCOPY)

Turn on/off the copying of pedigree id data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

virtual void vtkDataSetAttributes::CopyPedigreeIdsOn ( )
virtual

Turn on/off the copying of pedigree id data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

virtual void vtkDataSetAttributes::CopyPedigreeIdsOff ( )
virtual

Turn on/off the copying of pedigree id data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

virtual void vtkDataSetAttributes::CopyAllOn ( int  ctype = ALLCOPY)
virtual

Turn on copying of all data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

Reimplemented from vtkFieldData.

virtual void vtkDataSetAttributes::CopyAllOff ( int  ctype = ALLCOPY)
virtual

Turn off copying of all data. ctype is one of the AttributeCopyOperations, and controls copy, interpolate and passdata behavior. For set, ctype=ALLCOPY means set all three flags to the same value. For get, ctype=ALLCOPY returns true only if all three flags are true. During copying, interpolation and passdata, the following rules are followed for each array: 1. If the copy/interpolate/pass flag for an attribute is set (on or off), it is applied. This overrides rules 2 and 3. 2. If the copy flag for an array is set (on or off), it is applied This overrides rule 3. 3. If CopyAllOn is set, copy the array. If CopyAllOff is set, do not copy the array

Reimplemented from vtkFieldData.

virtual void vtkDataSetAttributes::PassData ( vtkFieldData *  fd)
virtual

Pass entire arrays of input data through to output. Obey the "copy" flags. When passing a field, the following copying rules are followed: 1) Check if a field is an attribute, if yes and if there is a PASSDATA copy flag for that attribute (on or off), obey the flag for that attribute, ignore (2) and (3), 2) if there is a copy field for that field (on or off), obey the flag, ignore (3) 3) obey CopyAllOn/Off

Reimplemented from vtkFieldData.

void vtkDataSetAttributes::CopyAllocate ( vtkDataSetAttributes *  pd,
vtkIdType  sze = 0,
vtkIdType  ext = 1000 
)
inline

Allocates point data for point-by-point (or cell-by-cell) copy operation. If sze=0, then use the input DataSetAttributes to create (i.e., find initial size of) new objects; otherwise use the sze variable. Note that pd HAS to be the vtkDataSetAttributes object which will later be used with CopyData. If this is not the case, consider using the alternative forms of CopyAllocate and CopyData. ext is no longer used. If shallowCopyArrays is true, input arrays are copied to the output instead of new ones being allocated.

Definition at line 447 of file vtkDataSetAttributes.h.

void vtkDataSetAttributes::CopyAllocate ( vtkDataSetAttributes *  pd,
vtkIdType  sze,
vtkIdType  ext,
int  shallowCopyArrays 
)

Allocates point data for point-by-point (or cell-by-cell) copy operation. If sze=0, then use the input DataSetAttributes to create (i.e., find initial size of) new objects; otherwise use the sze variable. Note that pd HAS to be the vtkDataSetAttributes object which will later be used with CopyData. If this is not the case, consider using the alternative forms of CopyAllocate and CopyData. ext is no longer used. If shallowCopyArrays is true, input arrays are copied to the output instead of new ones being allocated.

void vtkDataSetAttributes::CopyStructuredData ( vtkDataSetAttributes *  inDsa,
const int *  inExt,
const int *  outExt 
)

This method is used to copy data arrays in images. You should call "CopyAllocate" before calling this method.

void vtkDataSetAttributes::CopyData ( vtkDataSetAttributes *  fromPd,
vtkIdType  fromId,
vtkIdType  toId 
)

Copy the attribute data from one id to another. Make sure CopyAllocate() has been invoked before using this method. When copying a field, the following copying rules are followed: 1) Check if a field is an attribute, if yes and if there is a COPYTUPLE copy flag for that attribute (on or off), obey the flag for that attribute, ignore (2) and (3), 2) if there is a copy field for that field (on or off), obey the flag, ignore (3) 3) obey CopyAllOn/Off

void vtkDataSetAttributes::CopyData ( vtkDataSetAttributes *  fromPd,
vtkIdList *  fromIds,
vtkIdList *  toIds 
)

Copy the attribute data from one id to another. Make sure CopyAllocate() has been invoked before using this method. When copying a field, the following copying rules are followed: 1) Check if a field is an attribute, if yes and if there is a COPYTUPLE copy flag for that attribute (on or off), obey the flag for that attribute, ignore (2) and (3), 2) if there is a copy field for that field (on or off), obey the flag, ignore (3) 3) obey CopyAllOn/Off

void vtkDataSetAttributes::CopyData ( vtkDataSetAttributes *  fromPd,
vtkIdType  dstStart,
vtkIdType  n,
vtkIdType  srcStart 
)

Copy n consecutive attributes starting at srcStart from fromPd to this container, starting at the dstStart location. Note that memory allocation is performed as necessary to hold the data.

void vtkDataSetAttributes::CopyTuple ( vtkAbstractArray *  fromData,
vtkAbstractArray *  toData,
vtkIdType  fromId,
vtkIdType  toId 
)

Copy a tuple (or set of tuples) of data from one data array to another. This method assumes that the fromData and toData objects are of the same type, and have the same number of components. This is true if you invoke CopyAllocate() or InterpolateAllocate().

void vtkDataSetAttributes::CopyTuples ( vtkAbstractArray *  fromData,
vtkAbstractArray *  toData,
vtkIdList *  fromIds,
vtkIdList *  toIds 
)

Copy a tuple (or set of tuples) of data from one data array to another. This method assumes that the fromData and toData objects are of the same type, and have the same number of components. This is true if you invoke CopyAllocate() or InterpolateAllocate().

void vtkDataSetAttributes::CopyTuples ( vtkAbstractArray *  fromData,
vtkAbstractArray *  toData,
vtkIdType  dstStart,
vtkIdType  n,
vtkIdType  srcStart 
)

Copy a tuple (or set of tuples) of data from one data array to another. This method assumes that the fromData and toData objects are of the same type, and have the same number of components. This is true if you invoke CopyAllocate() or InterpolateAllocate().

void vtkDataSetAttributes::InterpolateAllocate ( vtkDataSetAttributes *  pd,
vtkIdType  sze = 0,
vtkIdType  ext = 1000 
)
inline

Initialize point interpolation method. Note that pd HAS to be the vtkDataSetAttributes object which will later be used with InterpolatePoint or InterpolateEdge. ext is no longer used. If shallowCopyArrays is true, input arrays are copied to the output instead of new ones being allocated.

Definition at line 506 of file vtkDataSetAttributes.h.

void vtkDataSetAttributes::InterpolateAllocate ( vtkDataSetAttributes *  pd,
vtkIdType  sze,
vtkIdType  ext,
int  shallowCopyArrays 
)

Initialize point interpolation method. Note that pd HAS to be the vtkDataSetAttributes object which will later be used with InterpolatePoint or InterpolateEdge. ext is no longer used. If shallowCopyArrays is true, input arrays are copied to the output instead of new ones being allocated.

void vtkDataSetAttributes::InterpolatePoint ( vtkDataSetAttributes *  fromPd,
vtkIdType  toId,
vtkIdList *  ids,
double *  weights 
)

Interpolate data set attributes from other data set attributes given cell or point ids and associated interpolation weights. If the INTERPOLATION copy flag is set to 0 for an array, interpolation is prevented. If the flag is set to 1, weighted interpolation occurs. If the flag is set to 2, nearest neighbor interpolation is used.

void vtkDataSetAttributes::InterpolateEdge ( vtkDataSetAttributes *  fromPd,
vtkIdType  toId,
vtkIdType  p1,
vtkIdType  p2,
double  t 
)

Interpolate data from the two points p1,p2 (forming an edge) and an interpolation factor, t, along the edge. The weight ranges from (0,1), with t=0 located at p1. Make sure that the method InterpolateAllocate() has been invoked before using this method. If the INTERPOLATION copy flag is set to 0 for an array, interpolation is prevented. If the flag is set to 1, weighted interpolation occurs. If the flag is set to 2, nearest neighbor interpolation is used.

void vtkDataSetAttributes::InterpolateTime ( vtkDataSetAttributes *  from1,
vtkDataSetAttributes *  from2,
vtkIdType  id,
double  t 
)

Interpolate data from the same id (point or cell) at different points in time (parameter t). Two input data set attributes objects are input. The parameter t lies between (0<=t<=1). IMPORTANT: it is assumed that the number of attributes and number of components is the same for both from1 and from2, and the type of data for from1 and from2 are the same. Make sure that the method InterpolateAllocate() has been invoked before using this method. If the INTERPOLATION copy flag is set to 0 for an array, interpolation is prevented. If the flag is set to 1, weighted interpolation occurs. If the flag is set to 2, nearest neighbor interpolation is used.

void vtkDataSetAttributes::CopyAllocate ( vtkDataSetAttributes::FieldList &  list,
vtkIdType  sze = 0,
vtkIdType  ext = 1000 
)

A special form of CopyAllocate() to be used with FieldLists. Use it when you are copying data from a set of vtkDataSetAttributes.

void vtkDataSetAttributes::CopyData ( vtkDataSetAttributes::FieldList &  list,
vtkDataSetAttributes *  dsa,
int  idx,
vtkIdType  fromId,
vtkIdType  toId 
)

A special form of CopyData() to be used with FieldLists. Use it when you are copying data from a set of vtkDataSetAttributes. Make sure that you have called the special form of CopyAllocate that accepts FieldLists.

void vtkDataSetAttributes::InterpolateAllocate ( vtkDataSetAttributes::FieldList &  list,
vtkIdType  sze = 0,
vtkIdType  ext = 1000 
)

A special form of InterpolateAllocate() to be used with FieldLists. Use it when you are interpolating data from a set of vtkDataSetAttributes. Warning: This does not copy the Information object associated with each data array. This behavior may change in the future.

void vtkDataSetAttributes::InterpolatePoint ( vtkDataSetAttributes::FieldList &  list,
vtkDataSetAttributes *  fromPd,
int  idx,
vtkIdType  toId,
vtkIdList *  ids,
double *  weights 
)

Interpolate data set attributes from other data set attributes given cell or point ids and associated interpolation weights. Make sure that special form of InterpolateAllocate() that accepts FieldList has been used.

void vtkDataSetAttributes::InternalCopyAllocate ( vtkDataSetAttributes *  pd,
int  ctype,
vtkIdType  sze = 0,
vtkIdType  ext = 1000,
int  shallowCopyArrays = 0 
)
protected
void vtkDataSetAttributes::InternalCopyAllocate ( vtkDataSetAttributes::FieldList &  list,
int  ctype,
vtkIdType  sze,
vtkIdType  ext 
)
protected
virtual void vtkDataSetAttributes::InitializeFields ( )
protectedvirtual

Initialize all of the object's data to NULL

Reimplemented from vtkFieldData.

Friends And Related Function Documentation

friend class vtkDataSetAttributes::FieldList
friend

Definition at line 597 of file vtkDataSetAttributes.h.

Member Data Documentation

int vtkDataSetAttributes::AttributeIndices[NUM_ATTRIBUTES]
protected

Definition at line 619 of file vtkDataSetAttributes.h.

int vtkDataSetAttributes::CopyAttributeFlags[ALLCOPY][NUM_ATTRIBUTES]
protected

Definition at line 620 of file vtkDataSetAttributes.h.

vtkFieldData::BasicIterator vtkDataSetAttributes::RequiredArrays
protected

Definition at line 622 of file vtkDataSetAttributes.h.

int* vtkDataSetAttributes::TargetIndices
protected

Definition at line 624 of file vtkDataSetAttributes.h.

const int vtkDataSetAttributes::NumberOfAttributeComponents[NUM_ATTRIBUTES]
staticprotected

Definition at line 626 of file vtkDataSetAttributes.h.

const int vtkDataSetAttributes::AttributeLimits[NUM_ATTRIBUTES]
staticprotected

Definition at line 627 of file vtkDataSetAttributes.h.

const char vtkDataSetAttributes::AttributeNames[NUM_ATTRIBUTES][12]
staticprotected

Definition at line 628 of file vtkDataSetAttributes.h.

const char vtkDataSetAttributes::LongAttributeNames[NUM_ATTRIBUTES][35]
staticprotected

Definition at line 629 of file vtkDataSetAttributes.h.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.9.1