VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkHyperOctreeSampleFunction Class Reference

sample an implicit function over an hyperoctree More...

#include <vtkHyperOctreeSampleFunction.h>

Inheritance diagram for vtkHyperOctreeSampleFunction:
Inheritance graph
[legend]
Collaboration diagram for vtkHyperOctreeSampleFunction:
Collaboration graph
[legend]

List of all members.

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 doubleGetSize ()
virtual void GetSize (double &, double &, double &)
virtual void GetSize (double[3])
virtual void SetOrigin (double, double, double)
virtual void SetOrigin (double[3])
virtual doubleGetOrigin ()
virtual void GetOrigin (double &, double &, double &)
virtual void GetOrigin (double[3])
virtual void SetImplicitFunction (vtkImplicitFunction *)
virtual vtkImplicitFunctionGetImplicitFunction ()
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 vtkObjectBaseNewInstanceInternal () 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
vtkImplicitFunctionImplicitFunction
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

Reimplemented from vtkHyperOctreeAlgorithm.

Definition at line 42 of file vtkHyperOctreeSampleFunction.h.


Constructor & Destructor Documentation

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.

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 *  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 vtkHyperOctreeAlgorithm.

virtual int vtkHyperOctreeSampleFunction::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 vtkHyperOctreeAlgorithm.

Reimplemented from vtkHyperOctreeAlgorithm.

virtual vtkObjectBase* vtkHyperOctreeSampleFunction::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkHyperOctreeAlgorithm.

Reimplemented from vtkHyperOctreeAlgorithm.

void vtkHyperOctreeSampleFunction::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 vtkHyperOctreeAlgorithm.

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

Return the maximum number of levels of the hyperoctree.

Postcondition:
positive_result: result>=1

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()

Return the minimal number of levels of systematic subdivision.

Postcondition:
positive_result: result>=0

Set the minimal number of levels of systematic subdivision.

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

Return the threshold over which a subdivision is required.

Postcondition:
positive_result: result>0

Set the threshold over which a subdivision is required.

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

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

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.

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.

Return the length along the x-axis.

Postcondition:
positive_result: result>0

Set the length along the x-axis.

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

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

Postcondition:
positive_result: result>0

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

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

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

Postcondition:
positive_result: result>0

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

Precondition:
positive_depth: depth>0
Postcondition:
depth_is_set: GetDepth()==depth

Specify the implicit function to use to generate data.

Specify the implicit function to use to generate data.

Set what type of scalar data this source should generate.

Set what type of scalar data this source should generate.

Set what type of scalar data this source should generate.

Definition at line 137 of file vtkHyperOctreeSampleFunction.h.

Set what type of scalar data this source should generate.

Definition at line 139 of file vtkHyperOctreeSampleFunction.h.

Set what type of scalar data this source should generate.

Definition at line 141 of file vtkHyperOctreeSampleFunction.h.

Set what type of scalar data this source should generate.

Definition at line 143 of file vtkHyperOctreeSampleFunction.h.

Set what type of scalar data this source should generate.

Definition at line 145 of file vtkHyperOctreeSampleFunction.h.

Set what type of scalar data this source should generate.

Definition at line 147 of file vtkHyperOctreeSampleFunction.h.

Set what type of scalar data this source should generate.

Definition at line 149 of file vtkHyperOctreeSampleFunction.h.

Set what type of scalar data this source should generate.

Definition at line 151 of file vtkHyperOctreeSampleFunction.h.

Set what type of scalar data this source should generate.

Definition at line 153 of file vtkHyperOctreeSampleFunction.h.

Set what type of scalar data this source should generate.

Definition at line 155 of file vtkHyperOctreeSampleFunction.h.

unsigned long vtkHyperOctreeSampleFunction::GetMTime ( ) [virtual]

Return the MTime also considering the implicit function.

Reimplemented from vtkObject.

int vtkHyperOctreeSampleFunction::RequestInformation ( vtkInformation vtkNotUsedrequest,
vtkInformationVector **  vtkNotUsedinputVector,
vtkInformationVector outputVector 
) [protected]
virtual int vtkHyperOctreeSampleFunction::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkHyperOctreeAlgorithm.

void vtkHyperOctreeSampleFunction::Subdivide ( vtkHyperOctreeCursor cursor,
int  level,
vtkHyperOctree output 
) [protected]

Member Data Documentation

Definition at line 182 of file vtkHyperOctreeSampleFunction.h.

Definition at line 183 of file vtkHyperOctreeSampleFunction.h.

Definition at line 184 of file vtkHyperOctreeSampleFunction.h.

Definition at line 185 of file vtkHyperOctreeSampleFunction.h.

Definition at line 186 of file vtkHyperOctreeSampleFunction.h.

Definition at line 188 of file vtkHyperOctreeSampleFunction.h.

Definition at line 189 of file vtkHyperOctreeSampleFunction.h.

Definition at line 190 of file vtkHyperOctreeSampleFunction.h.


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