vtkDataSetAttributesFieldList.h File Reference

#include "vtkCommonDataModelModule.h"
#include "vtkSmartPointer.h"
#include "vtkSystemIncludes.h"
#include <functional>
#include <memory>

Include dependency graph for vtkDataSetAttributesFieldList.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
	vtkDataSetAttributesFieldList (int number_of_inputs=0)
virtual	~vtkDataSetAttributesFieldList ()
void	PrintSelf (ostream &os, vtkIndent indent)
void	Reset ()
	Initializes the field list to empty.
void	InitializeFieldList (vtkDataSetAttributes *dsa)
	Initialize the field list.
void	IntersectFieldList (vtkDataSetAttributes *dsa)
	Update the field list for an intersection of arrays registered so far and those in dsa.
void	UnionFieldList (vtkDataSetAttributes *dsa)
	Update the field list for an union of arrays registered so far and those in dsa.
void	TransformData (int inputIndex, vtkFieldData *input, vtkFieldData *output, std::function< void(vtkAbstractArray *, vtkAbstractArray *)> op) const
	Use this method to provide a custom callback function to invoke for each array in the input and corresponding array in the output.
int	GetNumberOfArrays ()
	This method can be used to determine the number of arrays remaining after intersection or union operations.
void	BuildPrototype (vtkDataSetAttributes *protoDSA, vtkDataSetAttributes *ordering=nullptr)
	A convenience function that builds a prototype / template dataset attributes for initializing the process of attribute interpolation and copying.
virtual vtkSmartPointer< vtkAbstractArray >	CreateArray (int type) const
	Called to create an output array for the given type.
void	CopyAllocate (vtkDataSetAttributes *output, int ctype, vtkIdType sz, vtkIdType ext) const
	These methods can called to generate and update the output vtkDataSetAttributes.
void	CopyData (int inputIndex, vtkDataSetAttributes *input, vtkIdType fromId, vtkDataSetAttributes *output, vtkIdType toId) const
	These methods can called to generate and update the output vtkDataSetAttributes.
void	CopyData (int inputIndex, vtkDataSetAttributes *input, vtkIdType inputStart, vtkIdType numValues, vtkDataSetAttributes *output, vtkIdType outStart) const
	These methods can called to generate and update the output vtkDataSetAttributes.
void	InterpolatePoint (int inputIndex, vtkDataSetAttributes *input, vtkIdList *inputIds, double *weights, vtkDataSetAttributes *output, vtkIdType toId) const
	These methods can called to generate and update the output vtkDataSetAttributes.

Function Documentation

vtkDataSetAttributesFieldList()

vtkDataSetAttributesFieldList

(

int

number_of_inputs = 0

)

~vtkDataSetAttributesFieldList()

virtual ~vtkDataSetAttributesFieldList ( )

virtual

PrintSelf()

void PrintSelf	(	ostream &	os,
		vtkIndent	indent )

Reset()

void Reset

(

)

Initializes the field list to empty.

InitializeFieldList()

void InitializeFieldList

(

vtkDataSetAttributes *

dsa

)

Initialize the field list.

This also adds the first input. Calling this method is optional. The first call to IntersectFieldList or UnionFieldList on a new instance or after calling Reset() will have the same effect.

IntersectFieldList()

void IntersectFieldList

(

vtkDataSetAttributes *

dsa

)

Update the field list for an intersection of arrays registered so far and those in dsa.

UnionFieldList()

void UnionFieldList

(

vtkDataSetAttributes *

dsa

)

Update the field list for an union of arrays registered so far and those in dsa.

CopyAllocate()

void CopyAllocate	(	vtkDataSetAttributes *	output,
		int	ctype,
		vtkIdType	sz,
		vtkIdType	ext ) const

These methods can called to generate and update the output vtkDataSetAttributes.

These match corresponding API on vtkDataSetAttributes and can be called via the output vtkDataSetAttributes instance instead as well.

CopyData() [1/2]

void CopyData	(	int	inputIndex,
		vtkDataSetAttributes *	input,
		vtkIdType	fromId,
		vtkDataSetAttributes *	output,
		vtkIdType	toId ) const

These methods can called to generate and update the output vtkDataSetAttributes.

These match corresponding API on vtkDataSetAttributes and can be called via the output vtkDataSetAttributes instance instead as well.

CopyData() [2/2]

void CopyData	(	int	inputIndex,
		vtkDataSetAttributes *	input,
		vtkIdType	inputStart,
		vtkIdType	numValues,
		vtkDataSetAttributes *	output,
		vtkIdType	outStart ) const

These methods can called to generate and update the output vtkDataSetAttributes.

These match corresponding API on vtkDataSetAttributes and can be called via the output vtkDataSetAttributes instance instead as well.

InterpolatePoint()

void InterpolatePoint	(	int	inputIndex,
		vtkDataSetAttributes *	input,
		vtkIdList *	inputIds,
		double *	weights,
		vtkDataSetAttributes *	output,
		vtkIdType	toId ) const

These methods can called to generate and update the output vtkDataSetAttributes.

These match corresponding API on vtkDataSetAttributes and can be called via the output vtkDataSetAttributes instance instead as well.

TransformData()

void TransformData	(	int	inputIndex,
		vtkFieldData *	input,
		vtkFieldData *	output,
		std::function< void(vtkAbstractArray *, vtkAbstractArray *)>	op ) const

Use this method to provide a custom callback function to invoke for each array in the input and corresponding array in the output.

GetNumberOfArrays()

int GetNumberOfArrays

(

)

This method can be used to determine the number of arrays remaining after intersection or union operations.

See also vtkFieldData::GetNumberOfArrays().

BuildPrototype()

void BuildPrototype	(	vtkDataSetAttributes *	protoDSA,
		vtkDataSetAttributes *	ordering = nullptr )

A convenience function that builds a prototype / template dataset attributes for initializing the process of attribute interpolation and copying.

The supplied protoPD should be initialized (empty), and the arrays present in this field list are instantiated and added to the prototype attributes. The typical usage is to use field list intersection (or union) operations to build up the field list, then create the prototype. Note, to retain an order of the data arrays, an optional ordering dataset attributes may be provided. (This is necessary because the vtkDataSetAttributesFieldList does not necessarily retain the original order of data arrays.)

CreateArray()

virtual vtkSmartPointer< vtkAbstractArray > CreateArray ( int type ) const

protectedvirtual

Called to create an output array for the given type.

Default implementation calls vtkAbstractArray::CreateArray().