sample an implicit function over an hyperoctree More...

#include <vtkHyperOctreeSampleFunction.h>

Inheritance diagram for vtkHyperOctreeSampleFunction:

Collaboration diagram for vtkHyperOctreeSampleFunction:

Public Types
typedef vtkHyperOctreeAlgorithm	Superclass

Public Types inherited from vtkHyperOctreeAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkHyperOctreeSampleFunction *	NewInstance () 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 ()

Public Member Functions inherited from vtkHyperOctreeAlgorithm
vtkHyperOctreeAlgorithm *	NewInstance () const

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

vtkHyperOctree *	GetHyperOctreeInput (int port)

vtkHyperOctree *	GetOutput ()

vtkHyperOctree *	GetOutput (int)

virtual void	SetOutput (vtkDataObject *d)

virtual int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

void	AddInputData (vtkDataObject *)

void	AddInputData (int, vtkDataObject *)

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, unsigned long *mtime)

virtual vtkInformation *	GetInformation ()

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)

vtkDataObject *	GetInputDataObject (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)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int extent[6])

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool 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)

vtkCommand *	GetCommand (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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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 &)

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 (vtkObjectBase *o)

static vtkHyperOctreeSampleFunction *	New ()

Static Public Member Functions inherited from vtkHyperOctreeAlgorithm
static int	IsTypeOf (const char *type)

static vtkHyperOctreeAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	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 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 )

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 vtkExecutive *	CreateDefaultExecutive ()

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)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *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 &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	Dimension

double	Size [3]

double	Origin [3]

int	Levels

int	MinLevels

int	OutputScalarType

vtkImplicitFunction *	ImplicitFunction

double	Threshold

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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 * 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 ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkHyperOctreeSampleFunction::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkHyperOctreeAlgorithm.

vtkHyperOctreeSampleFunction* vtkHyperOctreeSampleFunction::NewInstance ( ) const

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

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