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
vtkSampleFunction Class Reference

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

#include <vtkSampleFunction.h>

Inherits vtkImageAlgorithm.

Public Types

typedef vtkImageAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkSampleFunctionNewInstance () const
 
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])
 
void SetModelBounds (double bounds[6])
 
void SetModelBounds (double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)
 
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 vtkSampleFunctionSafeDownCast (vtkObjectBase *o)
 
static vtkSampleFunctionNew ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkSampleFunction ()
 
 ~vtkSampleFunction ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
void ExecuteDataWithInformation (vtkDataObject *, vtkInformation *)
 
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
 

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 44 of file vtkSampleFunction.h.

Member Typedef Documentation

typedef vtkImageAlgorithm vtkSampleFunction::Superclass

Definition at line 47 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

static int vtkSampleFunction::IsTypeOf ( const char *  type)
static
virtual int vtkSampleFunction::IsA ( const char *  type)
virtual
static vtkSampleFunction* vtkSampleFunction::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkSampleFunction::NewInstanceInternal ( ) const
protectedvirtual
vtkSampleFunction* vtkSampleFunction::NewInstance ( ) const
void vtkSampleFunction::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

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

Set what type of scalar data this source should generate.

virtual int vtkSampleFunction::GetOutputScalarType ( )
virtual

Set what type of scalar data this source should generate.

void vtkSampleFunction::SetOutputScalarTypeToDouble ( )
inline

Set what type of scalar data this source should generate.

Definition at line 65 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToFloat ( )
inline

Set what type of scalar data this source should generate.

Definition at line 67 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToLong ( )
inline

Set what type of scalar data this source should generate.

Definition at line 69 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToUnsignedLong ( )
inline

Set what type of scalar data this source should generate.

Definition at line 71 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToInt ( )
inline

Set what type of scalar data this source should generate.

Definition at line 73 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToUnsignedInt ( )
inline

Set what type of scalar data this source should generate.

Definition at line 75 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToShort ( )
inline

Set what type of scalar data this source should generate.

Definition at line 77 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToUnsignedShort ( )
inline

Set what type of scalar data this source should generate.

Definition at line 79 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToChar ( )
inline

Set what type of scalar data this source should generate.

Definition at line 81 of file vtkSampleFunction.h.

void vtkSampleFunction::SetOutputScalarTypeToUnsignedChar ( )
inline

Set what type of scalar data this source should generate.

Definition at line 83 of file vtkSampleFunction.h.

virtual void vtkSampleFunction::SetScalars ( vtkDataArray *  da)
virtual

Control the type of the scalars object by explicitly providing a scalar object. THIS IS DEPRECATED, although it still works!!! Please use SetOutputScalarType instead.

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

Specify the dimensions of the data on which to sample.

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

Specify the dimensions of the data on which to sample.

void vtkSampleFunction::SetModelBounds ( double  bounds[6])

Specify the region in space over which the sampling occurs. The bounds is specified as (xMin,xMax, yMin,yMax, zMin,zMax).

void vtkSampleFunction::SetModelBounds ( double  xMin,
double  xMax,
double  yMin,
double  yMax,
double  zMin,
double  zMax 
)

Specify the region in space over which the sampling occurs. The bounds is specified as (xMin,xMax, yMin,yMax, zMin,zMax).

virtual double* vtkSampleFunction::GetModelBounds ( )
virtual

Specify the region in space over which the sampling occurs. The bounds is specified as (xMin,xMax, yMin,yMax, zMin,zMax).

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

Specify the region in space over which the sampling occurs. The bounds is specified as (xMin,xMax, yMin,yMax, zMin,zMax).

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

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 void vtkSampleFunction::CappingOn ( )
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 void vtkSampleFunction::CappingOff ( )
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 void vtkSampleFunction::SetCapValue ( double  )
virtual

Set the cap value.

virtual double vtkSampleFunction::GetCapValue ( )
virtual

Set the cap value.

virtual void vtkSampleFunction::SetComputeNormals ( int  )
virtual

Turn on/off the computation of normals (normals are float values).

virtual int vtkSampleFunction::GetComputeNormals ( )
virtual

Turn on/off the computation of normals (normals are float values).

virtual void vtkSampleFunction::ComputeNormalsOn ( )
virtual

Turn on/off the computation of normals (normals are float values).

virtual void vtkSampleFunction::ComputeNormalsOff ( )
virtual

Turn on/off the computation of normals (normals are float values).

virtual void vtkSampleFunction::SetScalarArrayName ( const char *  )
virtual

Set/get the scalar array name for this data set. Initial value is "scalars".

virtual char* vtkSampleFunction::GetScalarArrayName ( )
virtual

Set/get the scalar array name for this data set. Initial value is "scalars".

virtual void vtkSampleFunction::SetNormalArrayName ( const char *  )
virtual

Set/get the normal array name for this data set. Initial value is "normals".

virtual char* vtkSampleFunction::GetNormalArrayName ( )
virtual

Set/get the normal array name for this data set. Initial value is "normals".

unsigned long vtkSampleFunction::GetMTime ( )

Return the MTime also considering the implicit function.

virtual void vtkSampleFunction::ReportReferences ( vtkGarbageCollector *  )
protectedvirtual
void vtkSampleFunction::ExecuteDataWithInformation ( vtkDataObject *  ,
vtkInformation *   
)
protected
virtual int vtkSampleFunction::RequestInformation ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
void vtkSampleFunction::Cap ( vtkDataArray *  s)
protected

Member Data Documentation

int vtkSampleFunction::OutputScalarType
protected

Definition at line 168 of file vtkSampleFunction.h.

int vtkSampleFunction::SampleDimensions[3]
protected

Definition at line 169 of file vtkSampleFunction.h.

double vtkSampleFunction::ModelBounds[6]
protected

Definition at line 170 of file vtkSampleFunction.h.

int vtkSampleFunction::Capping
protected

Definition at line 171 of file vtkSampleFunction.h.

double vtkSampleFunction::CapValue
protected

Definition at line 172 of file vtkSampleFunction.h.

vtkImplicitFunction* vtkSampleFunction::ImplicitFunction
protected

Definition at line 173 of file vtkSampleFunction.h.

int vtkSampleFunction::ComputeNormals
protected

Definition at line 174 of file vtkSampleFunction.h.

char* vtkSampleFunction::ScalarArrayName
protected

Definition at line 175 of file vtkSampleFunction.h.

char* vtkSampleFunction::NormalArrayName
protected

Definition at line 176 of file vtkSampleFunction.h.


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