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:
[legend]
Collaboration diagram for vtkHyperOctreeSampleFunction:
[legend]

List of all members.

Public Types

typedef vtkHyperOctreeAlgorithm Superclass
- Public Types inherited from vtkHyperOctreeAlgorithm
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
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 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 ()
- Public Member Functions inherited from vtkHyperOctreeAlgorithm
vtkDataObjectGetInput ()
vtkDataObjectGetInput (int port)
vtkHyperOctreeGetHyperOctreeInput (int port)
vtkHyperOctreeGetOutput ()
vtkHyperOctreeGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
void AddInput (vtkDataObject *)
void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

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

Protected Member Functions

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 Member Functions inherited from vtkHyperOctreeAlgorithm
 vtkHyperOctreeAlgorithm ()
 ~vtkHyperOctreeAlgorithm ()
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

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 38 of file vtkHyperOctreeSampleFunction.h.


Member Typedef Documentation

Reimplemented from vtkHyperOctreeAlgorithm.

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

virtual const char* vtkHyperOctreeSampleFunction::GetClassName ( )
virtual

Reimplemented from vtkHyperOctreeAlgorithm.

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.

static vtkHyperOctreeSampleFunction* vtkHyperOctreeSampleFunction::SafeDownCast ( vtkObject o)
static

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.

static vtkHyperOctreeSampleFunction* vtkHyperOctreeSampleFunction::New ( )
static

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

Reimplemented from vtkAlgorithm.

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 136 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToFloat ( )
inline

Set what type of scalar data this source should generate.

Definition at line 138 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToLong ( )
inline

Set what type of scalar data this source should generate.

Definition at line 140 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToUnsignedLong ( )
inline

Set what type of scalar data this source should generate.

Definition at line 142 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToInt ( )
inline

Set what type of scalar data this source should generate.

Definition at line 144 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToUnsignedInt ( )
inline

Set what type of scalar data this source should generate.

Definition at line 146 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToShort ( )
inline

Set what type of scalar data this source should generate.

Definition at line 148 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToUnsignedShort ( )
inline

Set what type of scalar data this source should generate.

Definition at line 150 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToChar ( )
inline

Set what type of scalar data this source should generate.

Definition at line 152 of file vtkHyperOctreeSampleFunction.h.

void vtkHyperOctreeSampleFunction::SetOutputScalarTypeToUnsignedChar ( )
inline

Set what type of scalar data this source should generate.

Definition at line 154 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 
)
protectedvirtual

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

int vtkHyperOctreeSampleFunction::Dimension
protected

Definition at line 181 of file vtkHyperOctreeSampleFunction.h.

double vtkHyperOctreeSampleFunction::Size[3]
protected

Definition at line 182 of file vtkHyperOctreeSampleFunction.h.

double vtkHyperOctreeSampleFunction::Origin[3]
protected

Definition at line 183 of file vtkHyperOctreeSampleFunction.h.

int vtkHyperOctreeSampleFunction::Levels
protected

Definition at line 184 of file vtkHyperOctreeSampleFunction.h.

int vtkHyperOctreeSampleFunction::MinLevels
protected

Definition at line 185 of file vtkHyperOctreeSampleFunction.h.

int vtkHyperOctreeSampleFunction::OutputScalarType
protected

Definition at line 187 of file vtkHyperOctreeSampleFunction.h.

vtkImplicitFunction* vtkHyperOctreeSampleFunction::ImplicitFunction
protected

Definition at line 188 of file vtkHyperOctreeSampleFunction.h.

double vtkHyperOctreeSampleFunction::Threshold
protected

Definition at line 189 of file vtkHyperOctreeSampleFunction.h.


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