Documentation for vtkSampleFunction

vtkSampleFunction - sample an implicit function over a structured point set

Description:

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

Methods:

	void vtkSampleFunction ()
	void vtkSampleFunction ()
	const char *GetClassName ()
	void PrintSelf (unknown & ,vtkIndent )
	static vtkSampleFunction *New ()
	void SetImplicitFunction (vtkImplicitFunction *)
	vtkImplicitFunction *GetImplicitFunction ()
	void SetScalars (vtkScalars *)
	void SetSampleDimensions (int ,int ,int )
	void SetSampleDimensions (int )
	int *GetSampleDimensions ()
	void SetModelBounds (float ,float ,float ,float ,float ,float )
	void SetModelBounds (float *)
	float *GetModelBounds ()
	void SetCapping (int )
	int GetCapping ()
	void CappingOn ()
	void CappingOff ()
	void SetCapValue (float )
	float GetCapValue ()
	void SetComputeNormals (int )
	int GetComputeNormals ()
	void ComputeNormalsOn ()
	void ComputeNormalsOff ()
	unsigned long GetMTime ()
	void Execute ()
	void Cap (vtkScalars *)

Detailed Method Descriptions:

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

static vtkSampleFunction *New ()

Specify the implicit function to use to generate data.

	void SetImplicitFunction (vtkImplicitFunction *)
	vtkImplicitFunction *GetImplicitFunction ()

Control the type of the vtkScalars object by explicitly providing a scalar object. vtkSampleFunction() will allocate space (as necessary) in the scalar object.

void SetScalars (vtkScalars *)

Specify the dimensions of the data on which to sample.

	void SetSampleDimensions (int ,int ,int )
	void SetSampleDimensions (int )
	int *GetSampleDimensions ()

Specify the region in space over which the sampling occurs.

	void SetModelBounds (float ,float ,float ,float ,float ,float )
	void SetModelBounds (float *)
	float *GetModelBounds ()

Turn on/off capping. If capping is on, then the outer boundaries of the structured point set are set to cap value. This can be used to insure surfaces are closed.

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

Set the cap value.

	void SetCapValue (float )
	float GetCapValue ()

Turn on/off the computation of normals.

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

Return the MTime also considering the implicit function.

unsigned long GetMTime ()