ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkProgrammableAttributeDataFilter Class Reference

vtkProgrammableAttributeDataFilter - manipulate attribute (cell and point) data via a user-specified function More...

Inheritance diagram for Kitware.VTK.vtkProgrammableAttributeDataFilter:
[legend]
Collaboration diagram for Kitware.VTK.vtkProgrammableAttributeDataFilter:
[legend]

List of all members.

Public Member Functions

 vtkProgrammableAttributeDataFilter (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkProgrammableAttributeDataFilter ()
 Undocumented Block.
delegate void ProgrammableMethodCallbackType (IntPtr arg0)
 Signature definition for programmable method callbacks. Methods passed to SetExecuteMethod or SetExecuteMethodArgDelete must conform to this signature. The presence of this typedef is useful for reference and for external analysis tools, but it cannot be used in the method signatures in these header files themselves because it prevents the internal VTK wrapper generators from wrapping these methods.
new void AddInput (vtkDataSet arg0)
 Add a dataset to the list of data to process.
vtkDataSetCollection GetInputList ()
 Return the list of inputs.
override int IsA (string type)
 Undocumented Block.
new
vtkProgrammableAttributeDataFilter 
NewInstance ()
 Undocumented Block.
void RemoveInput (vtkDataSet arg0)
 Remove a dataset from the list of data to process.
void SetExecuteMethod (ProgrammableMethodCallbackType f, IntPtr arg)
 Specify the function to use to operate on the point attribute data. Note that the function takes a single (void *) argument.
void SetExecuteMethodArgDelete (ProgrammableMethodCallbackType f)
 Set the arg delete method. This is used to free user memory.
delegate void ExecuteMethodHandler (IntPtr arg)
 Managed/.NET signature for handlers of the SetExecuteMethod callback.
void SetExecuteMethod (ExecuteMethodHandler handler, IntPtr arg)
 Specify the function to use to operate on the point attribute data. Note that the function takes a single (void *) argument.
void SetExecuteMethod (ExecuteMethodHandler handler)
 Specify the function to use to operate on the point attribute data. Note that the function takes a single (void *) argument.

Static Public Member Functions

static new
vtkProgrammableAttributeDataFilter 
New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new
vtkProgrammableAttributeDataFilter 
SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkProgrammableAttributeDataFilter"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "34vtkProgrammableAttributeDataFilter"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkProgrammableAttributeDataFilter_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkProgrammableAttributeDataFilter_AddInput_01 (HandleRef pThis, HandleRef arg0)
static internal IntPtr vtkProgrammableAttributeDataFilter_GetInputList_02 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkProgrammableAttributeDataFilter_IsA_03 (HandleRef pThis, string type)
static internal int vtkProgrammableAttributeDataFilter_IsTypeOf_04 (string type)
static internal IntPtr vtkProgrammableAttributeDataFilter_NewInstance_06 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkProgrammableAttributeDataFilter_RemoveInput_07 (HandleRef pThis, HandleRef arg0)
static internal IntPtr vtkProgrammableAttributeDataFilter_SafeDownCast_08 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkProgrammableAttributeDataFilter_SetExecuteMethod_09 (HandleRef pThis, ProgrammableMethodCallbackType f, IntPtr arg)
static internal void vtkProgrammableAttributeDataFilter_SetExecuteMethodArgDelete_10 (HandleRef pThis, ProgrammableMethodCallbackType f)
static internal void vtkProgrammableAttributeDataFilter_SetExecuteMethod (HandleRef pThis, ExecuteMethodHandler handler, IntPtr arg)

Static Private Member Functions

static vtkProgrammableAttributeDataFilter ()
 Automatically generated type registration mechanics.

Detailed Description

vtkProgrammableAttributeDataFilter - manipulate attribute (cell and point) data via a user-specified function

Description vtkProgrammableAttributeDataFilter is a filter that allows you to write a custom procedure to manipulate attribute data - either point or cell data. For example, you could generate scalars based on a complex formula; convert vectors to normals; compute scalar values as a function of vectors, texture coords, and/or any other point data attribute; and so on. The filter takes multiple inputs (input plus an auxiliary input list), so you can write procedures that combine several dataset point attributes. Note that the output of the filter is the same type (topology/geometry) as the input.

The filter works as follows. It operates like any other filter (i.e., checking and managing modified and execution times, processing Update() and Execute() methods, managing release of data, etc.), but the difference is that the Execute() method simply invokes a user-specified function with an optional (void *) argument (typically the "this" pointer in C++). It is also possible to specify a function to delete the argument via ExecuteMethodArgDelete().

To use the filter, you write a procedure to process the input datasets, process the data, and generate output data. Typically, this means grabbing the input point or cell data (using GetInput() and maybe GetInputList()), operating on it (creating new point and cell attributes such as scalars, vectors, etc.), and then setting the point and/or cell attributes in the output dataset (you'll need to use GetOutput() to access the output). (Note: besides C++, it is possible to do the same thing in Tcl, Java, or other languages that wrap the C++ core.) Remember, proper filter protocol requires that you don't modify the input data - you create new output data from the input.

Caveats This filter operates on any combination of the filter input plus a list of additional inputs (at a minimum you must set the filter input via SetInput()). It is up to you check whether the input is valid, and to insure that the output is valid. Also, you have to write the control structure for the traversal and operation on the point and cell attribute data.

By default the output point and cell data will be copied through from the input point data (using reference counting). You can control this using the output's CopyAllOff() flag, or by using individual flags for each point data field (i.e., scalars, vectors, etc.)

The output of this filter is the abstract type vtkDataSet, even if your input is a concrete type like vtkPolyData. Thus you may need to use vtkCastToConcrete to obtain the output as a particular concrete type, or one of the special methods of the superclass (e.g., vtkDataSetAlgorithm::GetPolyDataOutput) to retrieve output of the correct type.

The filter correctly manages modified time and network execution in most cases. However, if you change the definition of the filter function, you'll want to send a manual Modified() method to the filter to force it to reexecute.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkProgrammableAttributeDataFilter.vtkProgrammableAttributeDataFilter ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

Add a dataset to the list of data to process.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

override void Kitware.VTK.vtkProgrammableAttributeDataFilter.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Managed/.NET signature for handlers of the SetExecuteMethod callback.

Return the list of inputs.

Here is the call graph for this function:

override int Kitware.VTK.vtkProgrammableAttributeDataFilter.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

static new int Kitware.VTK.vtkProgrammableAttributeDataFilter.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Signature definition for programmable method callbacks. Methods passed to SetExecuteMethod or SetExecuteMethodArgDelete must conform to this signature. The presence of this typedef is useful for reference and for external analysis tools, but it cannot be used in the method signatures in these header files themselves because it prevents the internal VTK wrapper generators from wrapping these methods.

Remove a dataset from the list of data to process.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

Here is the call graph for this function:

Specify the function to use to operate on the point attribute data. Note that the function takes a single (void *) argument.

Specify the function to use to operate on the point attribute data. Note that the function takes a single (void *) argument.

Specify the function to use to operate on the point attribute data. Note that the function takes a single (void *) argument.

Set the arg delete method. This is used to free user memory.

static internal void Kitware.VTK.vtkProgrammableAttributeDataFilter.vtkProgrammableAttributeDataFilter_AddInput_01 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkProgrammableAttributeDataFilter.vtkProgrammableAttributeDataFilter_GetInputList_02 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkProgrammableAttributeDataFilter.vtkProgrammableAttributeDataFilter_IsA_03 ( HandleRef  pThis,
string  type 
) [private]
static internal IntPtr Kitware.VTK.vtkProgrammableAttributeDataFilter.vtkProgrammableAttributeDataFilter_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkProgrammableAttributeDataFilter.vtkProgrammableAttributeDataFilter_NewInstance_06 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkProgrammableAttributeDataFilter.vtkProgrammableAttributeDataFilter_RemoveInput_07 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkProgrammableAttributeDataFilter.vtkProgrammableAttributeDataFilter_SafeDownCast_08 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkProgrammableAttributeDataFilter.vtkProgrammableAttributeDataFilter_SetExecuteMethod ( HandleRef  pThis,
ExecuteMethodHandler  handler,
IntPtr  arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkProgrammableAttributeDataFilter.MRClassNameKey = "34vtkProgrammableAttributeDataFilter" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.

new const string Kitware.VTK.vtkProgrammableAttributeDataFilter.MRFullTypeName = "Kitware.VTK.vtkProgrammableAttributeDataFilter"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkDataSetAlgorithm.


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