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

sample an implicit function over an hyperoctree More...

#include <vtkHyperOctreeSampleFunction.h>

Inherits vtkHyperOctreeAlgorithm.

Public Types

typedef vtkHyperOctreeAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkHyperOctreeSampleFunctionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int GetLevels ()
 
void SetLevels (int levels)
 
int GetMinLevels ()
 
void SetMinLevels (int minLevels)
 
double GetThreshold ()
 
void SetThreshold (double threshold)
 
int GetDimension ()
 
void SetDimension (int dim)
 
double GetWidth ()
 
void SetWidth (double width)
 
double GetHeight ()
 
void SetHeight (double height)
 
double GetDepth ()
 
void SetDepth (double depth)
 
unsigned long GetMTime ()
 
virtual void SetSize (double, double, double)
 
virtual void SetSize (double[3])
 
virtual double * GetSize ()
 
virtual void GetSize (double &, double &, double &)
 
virtual void GetSize (double[3])
 
virtual void SetOrigin (double, double, double)
 
virtual void SetOrigin (double[3])
 
virtual double * GetOrigin ()
 
virtual void GetOrigin (double &, double &, double &)
 
virtual void GetOrigin (double[3])
 
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 ()
 

Static Public Member Functions

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

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
int RequestInformation (vtkInformation *vtkNotUsed(request), vtkInformationVector **vtkNotUsed(inputVector), vtkInformationVector *outputVector)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void Subdivide (vtkHyperOctreeCursor *cursor, int level, vtkHyperOctree *output)
 
 vtkHyperOctreeSampleFunction ()
 
 ~vtkHyperOctreeSampleFunction ()
 

Protected Attributes

int Dimension
 
double Size [3]
 
double Origin [3]
 
int Levels
 
int MinLevels
 
int OutputScalarType
 
vtkImplicitFunction * ImplicitFunction
 
double Threshold
 

Detailed Description

sample an implicit function over an hyperoctree

vtkHyperOctreeSampleFunction is a source object that evaluates an implicit function to drive the subdivision process. The user can specify the threshold over which a subdivision occurs, the maximum and minimum level of subdivisions and the dimension of the hyperoctree.

See Also
vtkSampleFunction
Tests:
vtkHyperOctreeSampleFunction (Tests)

Definition at line 39 of file vtkHyperOctreeSampleFunction.h.

Member Typedef Documentation

typedef vtkHyperOctreeAlgorithm vtkHyperOctreeSampleFunction::Superclass

Definition at line 42 of file vtkHyperOctreeSampleFunction.h.

Constructor & Destructor Documentation

vtkHyperOctreeSampleFunction::vtkHyperOctreeSampleFunction ( )
protected

Default constructor. Set dimension to 3, width, height and depth to 1, levels to 5, minLevels to 1, implicitFunction to 0, OutputScalarType to VTK_DOUBLE, Threshold is 0.1.

vtkHyperOctreeSampleFunction::~vtkHyperOctreeSampleFunction ( )
protected

Default constructor. Set dimension to 3, width, height and depth to 1, levels to 5, minLevels to 1, implicitFunction to 0, OutputScalarType to VTK_DOUBLE, Threshold is 0.1.

Member Function Documentation

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

Return the maximum number of levels of the hyperoctree.

Postcondition
positive_result: result>=1
void vtkHyperOctreeSampleFunction::SetLevels ( int  levels)

Set the maximum number of levels of the hyperoctree. If GetMinLevels()>=levels, GetMinLevels() is changed to levels-1.

Precondition
positive_levels: levels>=1
Postcondition
is_set: this->GetLevels()==levels
min_is_valid: this->GetMinLevels()<this->GetLevels()
int vtkHyperOctreeSampleFunction::GetMinLevels ( )

Return the minimal number of levels of systematic subdivision.

Postcondition
positive_result: result>=0
void vtkHyperOctreeSampleFunction::SetMinLevels ( int  minLevels)

Set the minimal number of levels of systematic subdivision.

Precondition
positive_minLevels: minLevels>=0
Postcondition
is_set: this->GetMinLevels()==minLevels
double vtkHyperOctreeSampleFunction::GetThreshold ( )

Return the threshold over which a subdivision is required.

Postcondition
positive_result: result>0
void vtkHyperOctreeSampleFunction::SetThreshold ( double  threshold)

Set the threshold over which a subdivision is required.

Precondition
positive_threshold: threshold>=0
Postcondition
is_set: this->GetThreshold()==threshold
int vtkHyperOctreeSampleFunction::GetDimension ( )

Return the dimension of the tree (1D:binary tree(2 children), 2D:quadtree(4 children), 3D:octree (8 children))

Postcondition
valid_result: result>=1 && result<=3
void vtkHyperOctreeSampleFunction::SetDimension ( int  dim)
virtual void vtkHyperOctreeSampleFunction::SetSize ( double  ,
double  ,
double   
)
virtual

Set the size on each axis.

virtual void vtkHyperOctreeSampleFunction::SetSize ( double  [3])
virtual

Set the size on each axis.

virtual double* vtkHyperOctreeSampleFunction::GetSize ( )
virtual

Return the size on each axis.

virtual void vtkHyperOctreeSampleFunction::GetSize ( double &  ,
double &  ,
double &   
)
virtual

Return the size on each axis.

virtual void vtkHyperOctreeSampleFunction::GetSize ( double  [3])
virtual

Return the size on each axis.

virtual void vtkHyperOctreeSampleFunction::SetOrigin ( double  ,
double  ,
double   
)
virtual

Set the origin (position of corner (0,0,0) of the root.

virtual void vtkHyperOctreeSampleFunction::SetOrigin ( double  [3])
virtual

Set the origin (position of corner (0,0,0) of the root.

virtual double* vtkHyperOctreeSampleFunction::GetOrigin ( )
virtual

Set the origin (position of corner (0,0,0) of the root.

virtual void vtkHyperOctreeSampleFunction::GetOrigin ( double &  ,
double &  ,
double &   
)
virtual

Set the origin (position of corner (0,0,0) of the root.

virtual void vtkHyperOctreeSampleFunction::GetOrigin ( double  [3])
virtual

Set the origin (position of corner (0,0,0) of the root.

double vtkHyperOctreeSampleFunction::GetWidth ( )

Return the length along the x-axis.

Postcondition
positive_result: result>0
void vtkHyperOctreeSampleFunction::SetWidth ( double  width)

Set the length along the x-axis.

Precondition
positive_width: width>0
Postcondition
width_is_set: GetWidth()==width
double vtkHyperOctreeSampleFunction::GetHeight ( )

Return the length along the y-axis. Relevant only if GetDimension()>=2

Postcondition
positive_result: result>0
void vtkHyperOctreeSampleFunction::SetHeight ( double  height)

Set the length along the y-axis. Relevant only if GetDimension()>=2

Precondition
positive_height: height>0
Postcondition
height_is_set: GetHeight()==height
double vtkHyperOctreeSampleFunction::GetDepth ( )

Return the length along the z-axis. Relevant only if GetDimension()>=3

Postcondition
positive_result: result>0
void vtkHyperOctreeSampleFunction::SetDepth ( double  depth)

Return the length along the z-axis. Relevant only if GetDimension()>=3

Precondition
positive_depth: depth>0
Postcondition
depth_is_set: GetDepth()==depth
virtual void vtkHyperOctreeSampleFunction::SetImplicitFunction ( vtkImplicitFunction *  )
virtual

Specify the implicit function to use to generate data.

virtual vtkImplicitFunction* vtkHyperOctreeSampleFunction::GetImplicitFunction ( )
virtual

Specify the implicit function to use to generate data.

virtual void vtkHyperOctreeSampleFunction::SetOutputScalarType ( int  )
virtual

Set what type of scalar data this source should generate.

virtual int vtkHyperOctreeSampleFunction::GetOutputScalarType ( )
virtual

Set what type of scalar data this source should generate.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToDouble ( )
inline

Set what type of scalar data this source should generate.

Definition at line 137 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToFloat ( )
inline

Set what type of scalar data this source should generate.

Definition at line 139 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToLong ( )
inline

Set what type of scalar data this source should generate.

Definition at line 141 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToUnsignedLong ( )
inline

Set what type of scalar data this source should generate.

Definition at line 143 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToInt ( )
inline

Set what type of scalar data this source should generate.

Definition at line 145 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToUnsignedInt ( )
inline

Set what type of scalar data this source should generate.

Definition at line 147 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToShort ( )
inline

Set what type of scalar data this source should generate.

Definition at line 149 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToUnsignedShort ( )
inline

Set what type of scalar data this source should generate.

Definition at line 151 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToChar ( )
inline

Set what type of scalar data this source should generate.

Definition at line 153 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToUnsignedChar ( )
inline

Set what type of scalar data this source should generate.

Definition at line 155 of file vtkHyperOctreeSampleFunction.h.

unsigned long vtkHyperOctreeSampleFunction::GetMTime ( )

Return the MTime also considering the implicit function.

int vtkHyperOctreeSampleFunction::RequestInformation ( vtkInformation *  vtkNotUsedrequest,
vtkInformationVector **  vtkNotUsedinputVector,
vtkInformationVector *  outputVector 
)
protected
virtual int vtkHyperOctreeSampleFunction::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
void vtkHyperOctreeSampleFunction::Subdivide ( vtkHyperOctreeCursor *  cursor,
int  level,
vtkHyperOctree *  output 
)
protected

Member Data Documentation

int vtkHyperOctreeSampleFunction::Dimension
protected

Definition at line 182 of file vtkHyperOctreeSampleFunction.h.

double vtkHyperOctreeSampleFunction::Size[3]
protected

Definition at line 183 of file vtkHyperOctreeSampleFunction.h.

double vtkHyperOctreeSampleFunction::Origin[3]
protected

Definition at line 184 of file vtkHyperOctreeSampleFunction.h.

int vtkHyperOctreeSampleFunction::Levels
protected

Definition at line 185 of file vtkHyperOctreeSampleFunction.h.

int vtkHyperOctreeSampleFunction::MinLevels
protected

Definition at line 186 of file vtkHyperOctreeSampleFunction.h.

int vtkHyperOctreeSampleFunction::OutputScalarType
protected

Definition at line 188 of file vtkHyperOctreeSampleFunction.h.

vtkImplicitFunction* vtkHyperOctreeSampleFunction::ImplicitFunction
protected

Definition at line 189 of file vtkHyperOctreeSampleFunction.h.

double vtkHyperOctreeSampleFunction::Threshold
protected

Definition at line 190 of file vtkHyperOctreeSampleFunction.h.


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