---

vtkSampleFunction Class Reference

sample an implicit function over a structured point set. More...

#include <vtkSampleFunction.h>

Inheritance diagram for vtkSampleFunction:

[legend]Collaboration diagram for vtkSampleFunction:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetImplicitFunction (vtkImplicitFunction *)
virtual vtkImplicitFunction *	GetImplicitFunction ()
virtual void	SetScalars (vtkScalars *)
void	SetSampleDimensions (int i, int j, int k)
void	SetSampleDimensions (int dim[3])
virtual int *	GetSampleDimensions ()
virtual void	GetSampleDimensions (int data[3])
virtual void	SetModelBounds (float, float, float, float, float, float)
virtual void	SetModelBounds (float[6])
virtual float *	GetModelBounds ()
virtual void	GetModelBounds (float data[6])
virtual void	SetCapping (int)
virtual int	GetCapping ()
virtual void	CappingOn ()
virtual void	CappingOff ()
virtual void	SetCapValue (float)
virtual float	GetCapValue ()
virtual void	SetComputeNormals (int)
virtual int	GetComputeNormals ()
virtual void	ComputeNormalsOn ()
virtual void	ComputeNormalsOff ()
unsigned long	GetMTime ()
Static Public Methods
int	IsTypeOf (const char *type)
vtkSampleFunction *	SafeDownCast (vtkObject *o)
vtkSampleFunction *	New ()
Protected Methods
	vtkSampleFunction ()
	~vtkSampleFunction ()
	vtkSampleFunction (const vtkSampleFunction &)
void	operator= (const vtkSampleFunction &)
void	Execute ()
void	ExecuteInformation ()
void	Cap (vtkScalars *s)
Protected Attributes
int	SampleDimensions [3]
float	ModelBounds [6]
vtkScalars *	Scalars
int	Capping
float	CapValue
vtkImplicitFunction *	ImplicitFunction
int	ComputeNormals

---

Detailed Description

sample an implicit function over a structured point set.

Date:

2000/12/10 20:08:51

Revision:

1.36

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)

Definition at line 65 of file vtkSampleFunction.h.

---

Constructor & Destructor Documentation

vtkSampleFunction::vtkSampleFunction (    )  [protected]

vtkSampleFunction::~vtkSampleFunction (    )  [protected]

vtkSampleFunction::vtkSampleFunction (  const vtkSampleFunction &    )  [inline, protected]

Definition at line 118 of file vtkSampleFunction.h.

---

Member Function Documentation

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkStructuredPointsSource.

int vtkSampleFunction::IsTypeOf (  const char *    type )  [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 vtkStructuredPointsSource.

virtual int vtkSampleFunction::IsA (  const char *    type )  [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 vtkStructuredPointsSource.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkStructuredPointsSource.

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 vtkSource.

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 vtkStructuredPointsSource.

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

Specify the implicit function to use to generate data.

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

virtual void vtkSampleFunction::SetScalars (  vtkScalars *    )  [virtual]

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

void vtkSampleFunction::SetSampleDimensions (  int    i, int    j, int    k )

Specify the dimensions of the data on which to sample.

void vtkSampleFunction::SetSampleDimensions (  int    dim[3] )

Specify the dimensions of the data on which to sample.

virtual int* vtkSampleFunction::GetSampleDimensions (    )  [virtual]

virtual void vtkSampleFunction::GetSampleDimensions (  int    data[3] )  [virtual]

virtual void vtkSampleFunction::SetModelBounds (  float   , float   , float   , float   , float   , float    )  [virtual]

Specify the region in space over which the sampling occurs.

virtual void vtkSampleFunction::SetModelBounds (  float   [6] )  [virtual]

virtual float* vtkSampleFunction::GetModelBounds (    )  [virtual]

virtual void vtkSampleFunction::GetModelBounds (  float    data[6] )  [virtual]

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

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.

virtual int vtkSampleFunction::GetCapping (    )  [virtual]

virtual void vtkSampleFunction::CappingOn (    )  [virtual]

virtual void vtkSampleFunction::CappingOff (    )  [virtual]

virtual void vtkSampleFunction::SetCapValue (  float    )  [virtual]

Set the cap value.

virtual float vtkSampleFunction::GetCapValue (    )  [virtual]

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

Turn on/off the computation of normals.

virtual int vtkSampleFunction::GetComputeNormals (    )  [virtual]

virtual void vtkSampleFunction::ComputeNormalsOn (    )  [virtual]

virtual void vtkSampleFunction::ComputeNormalsOff (    )  [virtual]

unsigned long vtkSampleFunction::GetMTime (    )  [virtual]

Return the MTime also considering the implicit function. Reimplemented from vtkObject.

void vtkSampleFunction::operator= (  const vtkSampleFunction &    )  [inline, protected]

Definition at line 119 of file vtkSampleFunction.h.

void vtkSampleFunction::Execute (    )  [protected, virtual]

Reimplemented from vtkSource.

void vtkSampleFunction::ExecuteInformation (    )  [protected, virtual]

Reimplemented from vtkStructuredPointsSource.

void vtkSampleFunction::Cap (  vtkScalars *    s )  [protected]

---

Member Data Documentation

int vtkSampleFunction::SampleDimensions[3] [protected]

Definition at line 125 of file vtkSampleFunction.h.

float vtkSampleFunction::ModelBounds[6] [protected]

Definition at line 126 of file vtkSampleFunction.h.

vtkScalars* vtkSampleFunction::Scalars [protected]

Definition at line 127 of file vtkSampleFunction.h.

int vtkSampleFunction::Capping [protected]

Definition at line 128 of file vtkSampleFunction.h.

float vtkSampleFunction::CapValue [protected]

Definition at line 129 of file vtkSampleFunction.h.

vtkImplicitFunction* vtkSampleFunction::ImplicitFunction [protected]

Definition at line 130 of file vtkSampleFunction.h.

int vtkSampleFunction::ComputeNormals [protected]

Definition at line 131 of file vtkSampleFunction.h.

---

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

• graphics/vtkSampleFunction.h

---