vtkSampleFunction Class Reference

#include <vtkSampleFunction.h>

Inheritance diagram for vtkSampleFunction:

[legend]

Collaboration diagram for vtkSampleFunction:

[legend]

List of all members.

Detailed Description

sample an implicit function over a structured point set

vtkSampleFunction is a source object that evaluates an implicit function and normals at each point in a vtkStructuredPoints. The user can specify the sample dimensions and location in space to perform the sampling. To create closed surfaces (in conjunction with the vtkContourFilter), capping can be turned on to set a particular value on the boundaries of the sample space.

See also:: vtkImplicitModeller

Examples:: vtkSampleFunction (Examples)

Tests:: vtkSampleFunction (Tests)

Definition at line 43 of file vtkSampleFunction.h.


Public Types
typedef vtkImageAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetScalars (vtkDataArray *da)
void	SetSampleDimensions (int i, int j, int k)
unsigned long	GetMTime ()

virtual void	SetImplicitFunction (vtkImplicitFunction *)
virtual vtkImplicitFunction *	GetImplicitFunction ()

virtual void	SetOutputScalarType (int)
virtual int	GetOutputScalarType ()
void	SetOutputScalarTypeToDouble ()
void	SetOutputScalarTypeToFloat ()
void	SetOutputScalarTypeToLong ()
void	SetOutputScalarTypeToUnsignedLong ()
void	SetOutputScalarTypeToInt ()
void	SetOutputScalarTypeToUnsignedInt ()
void	SetOutputScalarTypeToShort ()
void	SetOutputScalarTypeToUnsignedShort ()
void	SetOutputScalarTypeToChar ()
void	SetOutputScalarTypeToUnsignedChar ()

void	SetSampleDimensions (int dim[3])
virtual int *	GetSampleDimensions ()
virtual void	GetSampleDimensions (int data[3])

virtual void	SetModelBounds (double, double, double, double, double, double)
virtual void	SetModelBounds (double[6])
virtual double *	GetModelBounds ()
virtual void	GetModelBounds (double data[6])

virtual void	SetCapping (int)
virtual int	GetCapping ()
virtual void	CappingOn ()
virtual void	CappingOff ()

virtual void	SetCapValue (double)
virtual double	GetCapValue ()

virtual void	SetComputeNormals (int)
virtual int	GetComputeNormals ()
virtual void	ComputeNormalsOn ()
virtual void	ComputeNormalsOff ()

virtual void	SetScalarArrayName (const char *)
virtual char *	GetScalarArrayName ()

virtual void	SetNormalArrayName (const char *)
virtual char *	GetNormalArrayName ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkSampleFunction *	SafeDownCast (vtkObject *o)
static vtkSampleFunction *	New ()
Protected Member Functions
	vtkSampleFunction ()
	~vtkSampleFunction ()
virtual void	ReportReferences (vtkGarbageCollector *)
void	ExecuteData (vtkDataObject *)
virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
void	Cap (vtkDataArray *s)
Protected Attributes
int	OutputScalarType
int	SampleDimensions [3]
double	ModelBounds [6]
int	Capping
double	CapValue
vtkImplicitFunction *	ImplicitFunction
int	ComputeNormals
char *	ScalarArrayName
char *	NormalArrayName

Member Typedef Documentation

typedef vtkImageAlgorithm vtkSampleFunction::Superclass

Reimplemented from vtkImageAlgorithm.

Definition at line 46 of file vtkSampleFunction.h.

Constructor & Destructor Documentation

vtkSampleFunction::vtkSampleFunction ( ) [protected]

Default constructor. Construct with ModelBounds=(-1,1,-1,1,-1,1), SampleDimensions=(50,50,50), Capping turned off, CapValue=VTK_DOUBLE_MAX, normal generation on, OutputScalarType set to VTK_DOUBLE, ImplicitFunction set to NULL, ScalarArrayName is "" and NormalArrayName is "".

vtkSampleFunction::~vtkSampleFunction ( ) [protected]

Member Function Documentation

virtual const char* vtkSampleFunction::GetClassName ( ) [virtual]

Reimplemented from vtkImageAlgorithm.

static int vtkSampleFunction::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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 vtkImageAlgorithm.

virtual int vtkSampleFunction::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 vtkImageAlgorithm.

static vtkSampleFunction* vtkSampleFunction::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkImageAlgorithm.

void vtkSampleFunction::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 vtkImageAlgorithm.

static vtkSampleFunction* vtkSampleFunction::New ( ) [static]

Construct with ModelBounds=(-1,1,-1,1,-1,1), SampleDimensions=(50,50,50), Capping turned off, and normal generation on.

Reimplemented from vtkAlgorithm.

virtual void vtkSampleFunction::SetImplicitFunction ( vtkImplicitFunction * ) [virtual]

Specify the implicit function to use to generate data.

virtual vtkImplicitFunction* vtkSampleFunction::GetImplicitFunction ( ) [virtual]

Specify the implicit function to use to generate data.

virtual void vtkSampleFunction::SetOutputScalarType ( int ) [virtual]