VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkProgrammableDataObjectSource Class Reference

generate source data object via a user-specified function More...

#include <vtkProgrammableDataObjectSource.h>

Inherits vtkDataObjectAlgorithm.

Public Types

typedef vtkDataObjectAlgorithm Superclass
 
typedef void(* ProgrammableMethodCallbackType )(void *arg)
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkProgrammableDataObjectSourceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetExecuteMethod (void(*f)(void *), void *arg)
 
void SetExecuteMethodArgDelete (void(*f)(void *))
 

Static Public Member Functions

static
vtkProgrammableDataObjectSource
New ()
 
static int IsTypeOf (const char *type)
 
static
vtkProgrammableDataObjectSource
SafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkProgrammableDataObjectSource ()
 
 ~vtkProgrammableDataObjectSource ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

ProgrammableMethodCallbackType ExecuteMethod
 
ProgrammableMethodCallbackType ExecuteMethodArgDelete
 
void * ExecuteMethodArg
 

Detailed Description

generate source data object via a user-specified function

vtkProgrammableDataObjectSource is a source object that is programmable by the user. The output of the filter is a data object (vtkDataObject) which represents data via an instance of field data. To use this object, you must specify a function that creates the output.

Example use of this filter includes reading tabular data and encoding it as vtkFieldData. You can then use filters like vtkDataObjectToDataSetFilter to convert the data object to a dataset and then visualize it. Another important use of this class is that it allows users of interpreters (e.g., Tcl or Java) the ability to write source objects without having to recompile C++ code or generate new libraries.

See Also
vtkProgrammableFilter vtkProgrammableAttributeDataFilter vtkProgrammableSource vtkDataObjectToDataSetFilter
Examples:
vtkProgrammableDataObjectSource (Examples)
Tests:
vtkProgrammableDataObjectSource (Tests)

Definition at line 47 of file vtkProgrammableDataObjectSource.h.

Member Typedef Documentation

typedef vtkDataObjectAlgorithm vtkProgrammableDataObjectSource::Superclass

Definition at line 51 of file vtkProgrammableDataObjectSource.h.

typedef void(* vtkProgrammableDataObjectSource::ProgrammableMethodCallbackType)(void *arg)

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.

Definition at line 61 of file vtkProgrammableDataObjectSource.h.

Constructor & Destructor Documentation

vtkProgrammableDataObjectSource::vtkProgrammableDataObjectSource ( )
protected
vtkProgrammableDataObjectSource::~vtkProgrammableDataObjectSource ( )
protected

Member Function Documentation

static vtkProgrammableDataObjectSource* vtkProgrammableDataObjectSource::New ( )
static
static int vtkProgrammableDataObjectSource::IsTypeOf ( const char *  type)
static
virtual int vtkProgrammableDataObjectSource::IsA ( const char *  type)
virtual
static vtkProgrammableDataObjectSource* vtkProgrammableDataObjectSource::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkProgrammableDataObjectSource::NewInstanceInternal ( ) const
protectedvirtual
vtkProgrammableDataObjectSource* vtkProgrammableDataObjectSource::NewInstance ( ) const
void vtkProgrammableDataObjectSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
void vtkProgrammableDataObjectSource::SetExecuteMethod ( void(*)(void *)  f,
void *  arg 
)

Specify the function to use to generate the output data object. Note that the function takes a single (void *) argument.

void vtkProgrammableDataObjectSource::SetExecuteMethodArgDelete ( void(*)(void *)  f)

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

virtual int vtkProgrammableDataObjectSource::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Member Data Documentation

ProgrammableMethodCallbackType vtkProgrammableDataObjectSource::ExecuteMethod
protected

Definition at line 77 of file vtkProgrammableDataObjectSource.h.

ProgrammableMethodCallbackType vtkProgrammableDataObjectSource::ExecuteMethodArgDelete
protected

Definition at line 78 of file vtkProgrammableDataObjectSource.h.

void* vtkProgrammableDataObjectSource::ExecuteMethodArg
protected

Definition at line 79 of file vtkProgrammableDataObjectSource.h.


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