vtkClipHyperOctree Class Reference

#include <vtkClipHyperOctree.h>

Inheritance diagram for vtkClipHyperOctree:

[legend]

Collaboration diagram for vtkClipHyperOctree:

[legend]

List of all members.

Detailed Description

clip an hyperoctree with user-specified implicit function or input scalar data

vtkClipHyperOctree is a filter that clips an hyperoctree using either any subclass of vtkImplicitFunction, or the input scalar data. Clipping means that it actually "cuts" through the leaves (cells) of the hyperoctree, returning everything inside of the specified implicit function (or greater than the scalar value) including "pieces" of a cell. (Compare this with vtkExtractGeometry, which pulls out entire, uncut cells.) The output of this filter is an unstructured grid.

To use this filter, you must decide if you will be clipping with an implicit function, or whether you will be using the input scalar data. If you want to clip with an implicit function, you must: 1) define an implicit function 2) set it with the SetClipFunction method 3) apply the GenerateClipScalarsOn method If a ClipFunction is not specified, or GenerateClipScalars is off (the default), then the input's scalar data will be used to clip the polydata.

You can also specify a scalar value, which is used to decide what is inside and outside of the implicit function. You can also reverse the sense of what inside/outside is by setting the InsideOut instance variable. (The clipping algorithm proceeds by computing an implicit function value or using the input scalar data for each point in the dataset. This is compared to the scalar value to determine inside/outside.)

This filter can be configured to compute a second output. The second output is the part of the cell that is clipped away. Set the GenerateClippedData boolean on if you wish to access this output data.

Warning:: vtkClipHyperOctree will triangulate all types of 3D cells (i.e., create tetrahedra). This is true even if the cell is not actually cut. This is necessary to preserve compatibility across face neighbors. 2D cells will only be triangulated if the cutting function passes through them.

See also:: vtkImplicitFunction vtkCutter vtkClipVolume vtkClipPolyData

Tests:: vtkClipHyperOctree (Tests)

Definition at line 83 of file vtkClipHyperOctree.h.


Public Types
typedef vtkUnstructuredGridAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
vtkUnstructuredGrid *	GetClippedOutput ()
void	CreateDefaultLocator ()
unsigned long	GetMTime ()

virtual void	SetValue (double)
virtual double	GetValue ()

virtual void	SetInsideOut (int)
virtual int	GetInsideOut ()
virtual void	InsideOutOn ()
virtual void	InsideOutOff ()

virtual void	SetClipFunction (vtkImplicitFunction *)
virtual vtkImplicitFunction *	GetClipFunction ()

virtual void	SetGenerateClipScalars (int)
virtual int	GetGenerateClipScalars ()
virtual void	GenerateClipScalarsOn ()
virtual void	GenerateClipScalarsOff ()

virtual void	SetGenerateClippedOutput (int)
virtual int	GetGenerateClippedOutput ()
virtual void	GenerateClippedOutputOn ()
virtual void	GenerateClippedOutputOff ()

void	SetLocator (vtkPointLocator *locator)
virtual vtkPointLocator *	GetLocator ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkClipHyperOctree *	SafeDownCast (vtkObject *o)
static vtkClipHyperOctree *	New ()
Protected Member Functions
	vtkClipHyperOctree (vtkImplicitFunction *cf=NULL)
	~vtkClipHyperOctree ()
virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	FillInputPortInformation (int port, vtkInformation *info)

void	ClipNode (vtkHyperOctreeCursor *cursor, int level, double bounds[6])
Protected Attributes
vtkImplicitFunction *	ClipFunction
vtkPointLocator *	Locator
vtkPointLocator *	Locator2
int	InsideOut
double	Value
int	GenerateClipScalars
int	GenerateClippedOutput
vtkHyperOctree *	Input
vtkUnstructuredGrid *	Output
vtkUnstructuredGrid *	ClippedOutput
vtkUnsignedCharArray *	Types [2]
vtkIdTypeArray *	Locs [2]
vtkCellArray *	Conn [2]
vtkCellData *	InCD
vtkCellData *	OutCD [2]
vtkPointData *	OutPD [2]
vtkOrderedTriangulator *	Triangulator
vtkHyperOctreeCursor *	Sibling
vtkDoubleArray *	CellScalars
vtkTetra *	Tetra
vtkDoubleArray *	TetScalars
vtkPoints *	Pts
vtkPolygon *	Polygon
vtkIdType	CellTypeCounter [65536]
vtkIdType	TotalCounter
vtkIdType	TemplateCounter
vtkHyperOctreeClipCutPointsGrabber *	Grabber

Member Typedef Documentation

typedef vtkUnstructuredGridAlgorithm vtkClipHyperOctree::Superclass

Reimplemented from vtkUnstructuredGridAlgorithm.

Definition at line 86 of file vtkClipHyperOctree.h.

Constructor & Destructor Documentation

vtkClipHyperOctree::vtkClipHyperOctree ( vtkImplicitFunction * cf = NULL ) [protected]

vtkClipHyperOctree::~vtkClipHyperOctree ( ) [protected]

Member Function Documentation

virtual const char* vtkClipHyperOctree::GetClassName ( ) [virtual]

Reimplemented from vtkUnstructuredGridAlgorithm.

static int vtkClipHyperOctree::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkUnstructuredGridAlgorithm.

virtual int vtkClipHyperOctree::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkUnstructuredGridAlgorithm.

static vtkClipHyperOctree* vtkClipHyperOctree::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkUnstructuredGridAlgorithm.

void vtkClipHyperOctree::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 vtkUnstructuredGridAlgorithm.

static vtkClipHyperOctree* vtkClipHyperOctree::New ( ) [static]

Construct with user-specified implicit function; InsideOut turned off; value set to 0.0; and generate clip scalars turned off.

Reimplemented from vtkUnstructuredGridAlgorithm.

virtual void vtkClipHyperOctree::SetValue ( double ) [virtual]

Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars). The default value is 0.0.

virtual double vtkClipHyperOctree::GetValue ( ) [virtual]

Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars). The default value is 0.0.

virtual void vtkClipHyperOctree::SetInsideOut ( int ) [virtual]

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off by default.

virtual int vtkClipHyperOctree::GetInsideOut ( ) [virtual]

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off by default.

virtual void vtkClipHyperOctree::InsideOutOn ( ) [virtual]

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off by default.

virtual void vtkClipHyperOctree::InsideOutOff ( ) [virtual]

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off by default.

virtual void vtkClipHyperOctree::SetClipFunction ( vtkImplicitFunction * ) [virtual]

Specify the implicit function with which to perform the clipping. If you do not define an implicit function, then the selected input scalar data will be used for clipping.

virtual vtkImplicitFunction* vtkClipHyperOctree::GetClipFunction ( ) [virtual]

Specify the implicit function with which to perform the clipping. If you do not define an implicit function, then the selected input scalar data will be used for clipping.

virtual void vtkClipHyperOctree::SetGenerateClipScalars ( int ) [virtual]

If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not provide an implicit function an error will be reported.

virtual int vtkClipHyperOctree::GetGenerateClipScalars ( ) [virtual]

If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not provide an implicit function an error will be reported.

virtual void vtkClipHyperOctree::GenerateClipScalarsOn ( ) [virtual]

If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not provide an implicit function an error will be reported.

virtual void vtkClipHyperOctree::GenerateClipScalarsOff ( ) [virtual]

If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not provide an implicit function an error will be reported.

virtual void vtkClipHyperOctree::SetGenerateClippedOutput ( int ) [virtual]

Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.

virtual int vtkClipHyperOctree::GetGenerateClippedOutput ( ) [virtual]

Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.

virtual void vtkClipHyperOctree::GenerateClippedOutputOn ( ) [virtual]

Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.

virtual void vtkClipHyperOctree::GenerateClippedOutputOff ( ) [virtual]

Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.

vtkUnstructuredGrid* vtkClipHyperOctree::GetClippedOutput ( )

Return the Clipped output.

void vtkClipHyperOctree::SetLocator ( vtkPointLocator * locator )

Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used.

virtual vtkPointLocator* vtkClipHyperOctree::GetLocator ( ) [virtual]

Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used.

void vtkClipHyperOctree::CreateDefaultLocator ( )

Create default locator. Used to create one when none is specified. The locator is used to merge coincident points.

unsigned long vtkClipHyperOctree::GetMTime ( ) [virtual]

Return the mtime also considering the locator and clip function.

Reimplemented from vtkObject.

virtual int vtkClipHyperOctree::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`

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

Reimplemented from vtkUnstructuredGridAlgorithm.

void vtkClipHyperOctree::ClipNode	(	vtkHyperOctreeCursor *	cursor,
		int	level,
		double	bounds[6]
	)			`[protected]`

Clip the sub-hierarchy pointed by cursor.

Precondition:: cursor_exists: cursor!=0
positive_level: level>=0

virtual int vtkClipHyperOctree::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)			`[protected, virtual]`

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkUnstructuredGridAlgorithm.