Clip any dataset with a user-specified implicit function or an input scalar point data array. More...

#include <vtkTableBasedClipDataSet.h>

Inheritance diagram for vtkTableBasedClipDataSet:

Collaboration diagram for vtkTableBasedClipDataSet:

Public Types
typedef vtkUnstructuredGridAlgorithm	Superclass

Public Types inherited from vtkUnstructuredGridAlgorithm
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)

vtkTableBasedClipDataSet *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

unsigned long	GetMTime ()

void	CreateDefaultLocator ()

vtkUnstructuredGrid *	GetClippedOutput ()


virtual void	SetInsideOut (int)

virtual int	GetInsideOut ()

virtual void	InsideOutOn ()

virtual void	InsideOutOff ()


virtual void	SetValue (double)

virtual double	GetValue ()


virtual void	SetUseValueAsOffset (bool)

virtual bool	GetUseValueAsOffset ()

virtual void	UseValueAsOffsetOn ()

virtual void	UseValueAsOffsetOff ()


virtual void	SetClipFunction (vtkImplicitFunction *)

virtual vtkImplicitFunction *	GetClipFunction ()


virtual void	SetGenerateClipScalars (int)

virtual int	GetGenerateClipScalars ()

virtual void	GenerateClipScalarsOn ()

virtual void	GenerateClipScalarsOff ()


void	SetLocator (vtkIncrementalPointLocator *locator)

virtual vtkIncrementalPointLocator *	GetLocator ()


virtual void	SetMergeTolerance (double)

virtual double	GetMergeTolerance ()


virtual void	SetGenerateClippedOutput (int)

virtual int	GetGenerateClippedOutput ()

virtual void	GenerateClippedOutputOn ()

virtual void	GenerateClippedOutputOff ()


virtual void	SetOutputPointsPrecision (int)

virtual int	GetOutputPointsPrecision ()

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

vtkDataObject *	GetInput (int port)

vtkDataObject *	GetInput ()

vtkUnstructuredGrid *	GetUnstructuredGridInput (int port)

vtkUnstructuredGrid *	GetOutput ()

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

static vtkTableBasedClipDataSet *	New ()

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

static int	IsTypeOf (const char *type)

static vtkUnstructuredGridAlgorithm *	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

	vtkTableBasedClipDataSet (vtkImplicitFunction *cf=NULL)

	~vtkTableBasedClipDataSet ()

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	FillInputPortInformation (int port, vtkInformation *info)

void	InternalProgressCallback (vtkAlgorithm *algorithm)


void	ClipDataSet (vtkDataSet pDataSet, vtkDataArray clipAray, vtkUnstructuredGrid *unstruct)


void	ClipImageData (vtkDataSet inputGrd, vtkDataArray clipAray, double isoValue, vtkUnstructuredGrid *outputUG)


void	ClipPolyData (vtkDataSet inputGrd, vtkDataArray clipAray, double isoValue, vtkUnstructuredGrid *outputUG)


void	ClipRectilinearGridData (vtkDataSet inputGrd, vtkDataArray clipAray, double isoValue, vtkUnstructuredGrid *outputUG)


void	ClipStructuredGridData (vtkDataSet inputGrd, vtkDataArray clipAray, double isoValue, vtkUnstructuredGrid *outputUG)


void	ClipUnstructuredGridData (vtkDataSet inputGrd, vtkDataArray clipAray, double isoValue, vtkUnstructuredGrid *outputUG)

Protected Member Functions inherited from vtkUnstructuredGridAlgorithm
	vtkUnstructuredGridAlgorithm ()

	~vtkUnstructuredGridAlgorithm ()

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	FillOutputPortInformation (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 &)

Static Protected Member Functions

static void	InternalProgressCallbackFunction (vtkObject , unsigned long, void clientdata, void *)

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

Protected Attributes
int	InsideOut

int	GenerateClipScalars

int	GenerateClippedOutput

bool	UseValueAsOffset

double	Value

double	MergeTolerance

vtkCallbackCommand *	InternalProgressObserver

vtkImplicitFunction *	ClipFunction

vtkIncrementalPointLocator *	Locator

int	OutputPointsPrecision

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 Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Clip any dataset with a user-specified implicit function or an input scalar point data array.

vtkTableBasedClipDataSet is a filter that clips any type of dataset using either any subclass of vtkImplicitFunction or an input scalar point data array. Clipping means that it actually "cuts" through the cells of the dataset, returning everything outside the specified implicit function (or greater than the scalar value) including "pieces" of a cell (Note to compare this with vtkExtractGeometry, which pulls out entire, uncut cells). The output of this filter is a vtkUnstructuredGrid data.

To use this filter, you need to decide whether an implicit function or an input scalar point data array is used for clipping. For the former case, 1) define an implicit function 2) provide it to this filter via SetClipFunction() If a clipping function is not specified, or GenerateClipScalars is off( the default), the input scalar point data array is then employed for clipping.

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

Although this filter sometimes (but rarely) may resort to the sibling class vtkClipDataSet for handling some special grids (such as cylinders or cones with capping faces in the form of a vtkPolyData), it itself is able to deal with most grids. It is worth mentioning that vtkTableBasedClipDataSet is capable of addressing the artifacts that may occur with vtkClipDataSet due to the possibly inconsistent triangulation modes between neighboring cells. In addition, the former is much faster than the latter. Furthermore, the former produces less cells (with ratio usually being 5~6) than by the latter in the output. In other words, this filter retains the original cells (i.e., without triangulation / tetrahedralization) wherever possible. All these advantages are gained by adopting the unique clipping and triangulation tables proposed by VisIt.

Warning: vtkTableBasedClipDataSet makes use of a hash table (that is provided by class maintained by internal class vtkTableBasedClipperDataSetFromVolume) to achieve rapid removal of duplicate points. The hash-based mechanism simply compares the point Ids, without considering the actual inter-point distance (vtkClipDataSet adopts vtkMergePoints that though considers the inter-point distance for robust points merging ). As a result, some duplicate points may be present in the output. This problem occurs when some boundary (cut-through cells) happen to have faces EXACTLY aligned with the clipping plane (such as Plane, Box, or other implicit functions with planar shapes). The occurrence (though very rare) of duplicate points produces degenerate cells, which can be fixed by post-processing the output with a filter like vtkCleanGrid.

Thanks:: This filter was adapted from the VisIt clipper (vtkVisItClipper).

See also: vtkClipDataSet vtkClipVolume vtkClipPolyData vtkCutter vtkImplicitFunction

Tests:: vtkTableBasedClipDataSet (Tests)

Definition at line 105 of file vtkTableBasedClipDataSet.h.

Member Typedef Documentation

typedef vtkUnstructuredGridAlgorithm vtkTableBasedClipDataSet::Superclass

Definition at line 108 of file vtkTableBasedClipDataSet.h.

Constructor & Destructor Documentation

vtkTableBasedClipDataSet::vtkTableBasedClipDataSet ( vtkImplicitFunction * cf = NULL )

protected

vtkTableBasedClipDataSet::~vtkTableBasedClipDataSet ( )

protected

Member Function Documentation

static int vtkTableBasedClipDataSet::IsTypeOf ( const char * type )

static

virtual int vtkTableBasedClipDataSet::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 vtkUnstructuredGridAlgorithm.

static vtkTableBasedClipDataSet* vtkTableBasedClipDataSet::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkTableBasedClipDataSet::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkUnstructuredGridAlgorithm.

vtkTableBasedClipDataSet* vtkTableBasedClipDataSet::NewInstance ( ) const

void vtkTableBasedClipDataSet::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 vtkTableBasedClipDataSet* vtkTableBasedClipDataSet::New ( )

static

Create an instance with a user-specified implicit function, turning off IVARs InsideOut and GenerateClipScalars and setting IVAR Value to 0.0.

unsigned long vtkTableBasedClipDataSet::GetMTime ( )

virtual

Get the MTime for which the point locator and clip function are considered.

Reimplemented from vtkObject.

virtual void vtkTableBasedClipDataSet::SetInsideOut ( int )

virtual

Set/Get the InsideOut flag. With this flag off, a vertex is considered inside (the implicit function or the isosurface) if the (function or scalar) value is greater than IVAR Value. With this flag on, a vertex is considered inside (the implicit function or the isosurface) if the (function or scalar) value is less than or equal to IVAR Value. This flag is off by default.

virtual int vtkTableBasedClipDataSet::GetInsideOut ( )

virtual

Set/Get the InsideOut flag. With this flag off, a vertex is considered inside (the implicit function or the isosurface) if the (function or scalar) value is greater than IVAR Value. With this flag on, a vertex is considered inside (the implicit function or the isosurface) if the (function or scalar) value is less than or equal to IVAR Value. This flag is off by default.

virtual void vtkTableBasedClipDataSet::InsideOutOn ( )

virtual

Set/Get the InsideOut flag. With this flag off, a vertex is considered inside (the implicit function or the isosurface) if the (function or scalar) value is greater than IVAR Value. With this flag on, a vertex is considered inside (the implicit function or the isosurface) if the (function or scalar) value is less than or equal to IVAR Value. This flag is off by default.

virtual void vtkTableBasedClipDataSet::InsideOutOff ( )

virtual

Set/Get the InsideOut flag. With this flag off, a vertex is considered inside (the implicit function or the isosurface) if the (function or scalar) value is greater than IVAR Value. With this flag on, a vertex is considered inside (the implicit function or the isosurface) if the (function or scalar) value is less than or equal to IVAR Value. This flag is off by default.

virtual void vtkTableBasedClipDataSet::SetValue ( double )

virtual

Set/Get the clipping value of the implicit function (if an implicit function is applied) or scalar data array (if a scalar data array is used), with 0.0 as the default value. This value is ignored if flag UseValueAsOffset is true AND a clip function is defined.

virtual double vtkTableBasedClipDataSet::GetValue ( )

virtual

Set/Get the clipping value of the implicit function (if an implicit function is applied) or scalar data array (if a scalar data array is used), with 0.0 as the default value. This value is ignored if flag UseValueAsOffset is true AND a clip function is defined.

virtual void vtkTableBasedClipDataSet::SetUseValueAsOffset ( bool )

virtual

Set/Get flag UseValueAsOffset, with true as the default value. With this flag on, IVAR Value is used as an offset parameter to the implicit function. Value is used only when clipping using a scalar array.

virtual bool vtkTableBasedClipDataSet::GetUseValueAsOffset ( )

virtual

Set/Get flag UseValueAsOffset, with true as the default value. With this flag on, IVAR Value is used as an offset parameter to the implicit function. Value is used only when clipping using a scalar array.

virtual void vtkTableBasedClipDataSet::UseValueAsOffsetOn ( )

virtual

Set/Get flag UseValueAsOffset, with true as the default value. With this flag on, IVAR Value is used as an offset parameter to the implicit function. Value is used only when clipping using a scalar array.

virtual void vtkTableBasedClipDataSet::UseValueAsOffsetOff ( )

virtual

Set/Get flag UseValueAsOffset, with true as the default value. With this flag on, IVAR Value is used as an offset parameter to the implicit function. Value is used only when clipping using a scalar array.

virtual void vtkTableBasedClipDataSet::SetClipFunction ( vtkImplicitFunction * )

virtual

Set/Get the implicit function with which to perform the clipping operation. Unless an implicit function is defined, the specified input scalar data will be used for clipping.

virtual vtkImplicitFunction* vtkTableBasedClipDataSet::GetClipFunction ( )

virtual

Set/Get the implicit function with which to perform the clipping operation. Unless an implicit function is defined, the specified input scalar data will be used for clipping.

virtual void vtkTableBasedClipDataSet::SetGenerateClipScalars ( int )

virtual

Set/Get flag GenerateClipScalars, with 0 as the default value. With this flag on, the scalar point data values obtained by evaluating the implicit function will be exported to the output. Note that this flag requries that an implicit function be provided.

virtual int vtkTableBasedClipDataSet::GetGenerateClipScalars ( )

virtual

Set/Get flag GenerateClipScalars, with 0 as the default value. With this flag on, the scalar point data values obtained by evaluating the implicit function will be exported to the output. Note that this flag requries that an implicit function be provided.

virtual void vtkTableBasedClipDataSet::GenerateClipScalarsOn ( )

virtual

Set/Get flag GenerateClipScalars, with 0 as the default value. With this flag on, the scalar point data values obtained by evaluating the implicit function will be exported to the output. Note that this flag requries that an implicit function be provided.

virtual void vtkTableBasedClipDataSet::GenerateClipScalarsOff ( )

virtual

Set/Get flag GenerateClipScalars, with 0 as the default value. With this flag on, the scalar point data values obtained by evaluating the implicit function will be exported to the output. Note that this flag requries that an implicit function be provided.

void vtkTableBasedClipDataSet::SetLocator ( vtkIncrementalPointLocator * locator )

Set/Get a point locator locator for merging duplicate points. By default, an instance of vtkMergePoints is used. Note that this IVAR is provided in this class only because this filter may resort to its sibling class vtkClipDataSet when processing some special grids (such as cylinders or cones with capping faces in the form of a vtkPolyData) while the latter requires a point locator. This filter itself does not need a locator.

virtual vtkIncrementalPointLocator* vtkTableBasedClipDataSet::GetLocator ( )

virtual

Set/Get a point locator locator for merging duplicate points. By default, an instance of vtkMergePoints is used. Note that this IVAR is provided in this class only because this filter may resort to its sibling class vtkClipDataSet when processing some special grids (such as cylinders or cones with capping faces in the form of a vtkPolyData) while the latter requires a point locator. This filter itself does not need a locator.

virtual void vtkTableBasedClipDataSet::SetMergeTolerance ( double )

virtual

Set/Get the tolerance used for merging duplicate points near the clipping intersection cells. This tolerance may prevent the generation of degenerate primitives. Note that only 3D cells actually use this IVAR.

virtual double vtkTableBasedClipDataSet::GetMergeTolerance ( )

virtual

Set/Get the tolerance used for merging duplicate points near the clipping intersection cells. This tolerance may prevent the generation of degenerate primitives. Note that only 3D cells actually use this IVAR.

void vtkTableBasedClipDataSet::CreateDefaultLocator ( )

Create a default point locator when none is specified. The point locator is used to merge coincident points.

virtual void vtkTableBasedClipDataSet::SetGenerateClippedOutput ( int )

virtual

Set/Get whether a second output is generated. The second output contains the polygonal data that is clipped away by the iso-surface.

virtual int vtkTableBasedClipDataSet::GetGenerateClippedOutput ( )

virtual

Set/Get whether a second output is generated. The second output contains the polygonal data that is clipped away by the iso-surface.

virtual void vtkTableBasedClipDataSet::GenerateClippedOutputOn ( )

virtual

Set/Get whether a second output is generated. The second output contains the polygonal data that is clipped away by the iso-surface.

virtual void vtkTableBasedClipDataSet::GenerateClippedOutputOff ( )

virtual

Set/Get whether a second output is generated. The second output contains the polygonal data that is clipped away by the iso-surface.

vtkUnstructuredGrid* vtkTableBasedClipDataSet::GetClippedOutput ( )

Return the clipped output.

virtual void vtkTableBasedClipDataSet::SetOutputPointsPrecision ( int )

virtual

Set/get the desired precision for the output types. See the documentation for the vtkAlgorithm::Precision enum for an explanation of the available precision settings.

virtual int vtkTableBasedClipDataSet::GetOutputPointsPrecision ( )

virtual

Set/get the desired precision for the output types. See the documentation for the vtkAlgorithm::Precision enum for an explanation of the available precision settings.

virtual int vtkTableBasedClipDataSet::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)

protectedvirtual

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

Reimplemented from vtkUnstructuredGridAlgorithm.

virtual int vtkTableBasedClipDataSet::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)

protectedvirtual

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.

void vtkTableBasedClipDataSet::ClipDataSet	(	vtkDataSet *	pDataSet,
		vtkDataArray *	clipAray,
		vtkUnstructuredGrid *	unstruct
	)

protected

This function resorts to the sibling class vtkClipDataSet to handle special grids (such as cylinders or cones with capping faces in the form a vtkPolyData).

void vtkTableBasedClipDataSet::ClipImageData	(	vtkDataSet *	inputGrd,
		vtkDataArray *	clipAray,
		double	isoValue,
		vtkUnstructuredGrid *	outputUG
	)

protected

This function takes a vtkImageData as a vtkRectilinearGrid, which is then clipped by ClipRectilinearGridData(......).

void vtkTableBasedClipDataSet::ClipPolyData	(	vtkDataSet *	inputGrd,
		vtkDataArray *	clipAray,
		double	isoValue,
		vtkUnstructuredGrid *	outputUG
	)

protected

This function clips a vtkPolyData object based on a specified iso-value (isoValue) using a scalar point data array (clipAray) that is either just an input scalar point data array or the result of evaluating an implicit function (provided via SetClipFunction()). The clipping result is exported to outputUG.

void vtkTableBasedClipDataSet::ClipRectilinearGridData	(	vtkDataSet *	inputGrd,
		vtkDataArray *	clipAray,
		double	isoValue,
		vtkUnstructuredGrid *	outputUG
	)

protected

This function clips a vtkRectilinearGrid based on a specified iso-value (isoValue) using a scalar point data array (clipAray) that is either just an input scalar point data array or the result of evaluating an implicit function (provided via SetClipFunction()). The clipping result is exported to outputUG.

void vtkTableBasedClipDataSet::ClipStructuredGridData	(	vtkDataSet *	inputGrd,
		vtkDataArray *	clipAray,
		double	isoValue,
		vtkUnstructuredGrid *	outputUG
	)

protected

This function clips a vtkStructuredGrid based on a specified iso-value (isoValue) using a scalar point data array (clipAray) that is either just an input scalar point data array or the result of evaluating an implicit function (provided via SetClipFunction()). The clipping result is exported to outputUG.

void vtkTableBasedClipDataSet::ClipUnstructuredGridData	(	vtkDataSet *	inputGrd,
		vtkDataArray *	clipAray,
		double	isoValue,
		vtkUnstructuredGrid *	outputUG
	)

protected

This function clips a vtkUnstructuredGrid based on a specified iso-value (isoValue) using a scalar point data array (clipAray) that is either just an input scalar point data array or the result of evaluating an implicit function (provided via SetClipFunction()). The clipping result is exported to outputUG.