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

Inheritance diagram for Kitware.VTK.vtkTableBasedClipDataSet:

[legend]

Collaboration diagram for Kitware.VTK.vtkTableBasedClipDataSet:

[legend]

List of all members.

Public Member Functions
	vtkTableBasedClipDataSet (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkTableBasedClipDataSet ()
	Create an instance with a user-specified implicit function, turning off IVARs InsideOut and GenerateClipScalars and setting IVAR Value to 0.0.
void	CreateDefaultLocator ()
	Create a default point locator when none is specified. The point locator is used to merge coincident points.
virtual void	GenerateClipScalarsOff ()
	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	GenerateClipScalarsOn ()
	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	GenerateClippedOutputOff ()
	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	GenerateClippedOutputOn ()
	Set/Get whether a second output is generated. The second output contains the polygonal data that is clipped away by the iso-surface.
virtual vtkImplicitFunction	GetClipFunction ()
	Description 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.
vtkUnstructuredGrid	GetClippedOutput ()
	Return the clipped output.
virtual int	GetGenerateClipScalars ()
	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	GetGenerateClippedOutput ()
	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	GetInsideOut ()
	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 vtkIncrementalPointLocator	GetLocator ()
	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.
override uint	GetMTime ()
	Get the MTime for which the point locator and clip function are consdiered.
virtual double	GetMergeTolerance ()
	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	GetMergeToleranceMaxValue ()
	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	GetMergeToleranceMinValue ()
	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 bool	GetUseValueAsOffset ()
	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 double	GetValue ()
	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	InsideOutOff ()
	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	InsideOutOn ()
	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.
override int	IsA (string type)
	*Undocumented Block
new vtkTableBasedClipDataSet	NewInstance ()
	*Undocumented Block
virtual void	SetClipFunction (vtkImplicitFunction arg0)
	Description 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	SetGenerateClipScalars (int _arg)
	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	SetGenerateClippedOutput (int _arg)
	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	SetInsideOut (int _arg)
	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.
void	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 void	SetMergeTolerance (double _arg)
	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 void	SetUseValueAsOffset (bool _arg)
	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	SetValue (double _arg)
	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	UseValueAsOffsetOff ()
	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	UseValueAsOffsetOn ()
	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.
Public Member Functions inherited from Kitware.VTK.vtkUnstructuredGridAlgorithm
	vtkUnstructuredGridAlgorithm (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkUnstructuredGridAlgorithm ()
	*Undocumented Block
void	AddInput (vtkDataObject arg0)
	Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
void	AddInput (int arg0, vtkDataObject arg1)
	Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
vtkDataObject	GetInput (int port)
	this method is not recommended for use, but lots of old style filters use it
vtkDataObject	GetInput ()
	this method is not recommended for use, but lots of old style filters use it
vtkUnstructuredGrid	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkUnstructuredGrid	GetOutput (int arg0)
	Get the output data object for a port on this algorithm.
vtkUnstructuredGrid	GetUnstructuredGridInput (int port)
	this method is not recommended for use, but lots of old style filters use it
void	SetInput (vtkDataObject arg0)
	Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
void	SetInput (int arg0, vtkDataObject arg1)
	Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
virtual void	SetOutput (vtkDataObject d)
	Get the output data object for a port on this algorithm.
Public Member Functions inherited from Kitware.VTK.vtkAlgorithm
	vtkAlgorithm (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkAlgorithm ()
	*Undocumented Block
override void	Register (vtkObjectBase o)
	Participate in garbage collection.
virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void	AddInputConnection (int port, vtkAlgorithmOutput input)
	Add a connection to the given input port index. See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is.
virtual void	AddInputConnection (vtkAlgorithmOutput input)
	Add a connection to the given input port index. See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is.
virtual double	ComputePriority ()
	Returns the priority of the piece described by the current update extent. The priority is a number between 0.0 and 1.0 with 0 meaning skippable (REQUEST_DATA not needed) and 1.0 meaning important.
void	ConvertTotalInputToPortConnection (int ind, ref int port, ref int conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual int	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual uint	GetErrorCode ()
	The error code contains a possible error that occured while reading or writing the file.
vtkExecutive	GetExecutive ()
	Get this algorithm's executive. If it has none, a default executive will be created.
virtual vtkInformation	GetInformation ()
	Set/Get the information object associated with this algorithm.
vtkInformation	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
vtkAlgorithmOutput	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
vtkDataObject	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.
vtkInformation	GetInputPortInformation (int port)
	Get the information object associated with an input port. There is one input port per kind of input to the algorithm. Each input port tells executives what kind of data and downstream requests this algorithm can handle for that input.
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.
int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.
int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.
vtkDataObject	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkAlgorithmOutput	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity.
vtkAlgorithmOutput	GetOutputPort ()
	Get a proxy object corresponding to the given output port of this algorithm. The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity.
vtkInformation	GetOutputPortInformation (int port)
	Get the information object associated with an output port. There is one output port per output from the algorithm. Each output port tells executives what kind of upstream requests this algorithm can handle for that output.
virtual double	GetProgress ()
	Set/Get the execution progress of a process object.
virtual double	GetProgressMaxValue ()
	Set/Get the execution progress of a process object.
virtual double	GetProgressMinValue ()
	Set/Get the execution progress of a process object.
virtual string	GetProgressText ()
	Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().
virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.
int	HasExecutive ()
	Check whether this algorithm has an assigned executive. This will NOT create a default executive.
virtual int	ModifyRequest (vtkInformation request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. The default implementation is empty. Returns 1 on success, 0 on failure. When can be either vtkExecutive::BeforeForward or vtkExecutive::AfterForward.
int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector outInfo)
	Version of ProcessRequest() that is wrapped. This converts the collection to an array and calls the other version.
void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.
void	RemoveAllInputs ()
	Remove all the input data.
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput input)
	Remove a connection from the given input port index. See SetInputConnection() for details on input connection. This method is the complement to AddInputConnection() in that it removes only the connection specified without affecting other connections. Typical usage is.
virtual void	SetAbortExecute (int _arg)
	Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void	SetExecutive (vtkExecutive executive)
	Set this algorithm's executive. This algorithm is removed from any executive to which it has previously been assigned and then assigned to the given executive.
virtual void	SetInformation (vtkInformation arg0)
	Set/Get the information object associated with this algorithm.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, string name)
	Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void	SetInputArrayToProcess (int idx, vtkInformation info)
	Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, string fieldAssociation, string attributeTypeorName)
	String based versions of SetInputArrayToProcess(). Because fieldAssociation and fieldAttributeType are enums, they cannot be easily accessed from scripting language. These methods provides an easy and safe way of passing association and attribute type information. Field association is one of the following:
virtual void	SetInputConnection (int port, vtkAlgorithmOutput input)
	Set the connection for the given input port index. Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().
virtual void	SetInputConnection (vtkAlgorithmOutput input)
	Set the connection for the given input port index. Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().
virtual void	SetProgress (double _arg)
	Set/Get the execution progress of a process object.
void	SetProgressText (string ptext)
	Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().
virtual void	SetReleaseDataFlag (int arg0)
	Turn release data flag on or off for all output ports.
virtual void	Update ()
	Bring this algorithm's outputs up-to-date.
int	UpdateExtentIsEmpty (vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. The source uses this call to determine whether to call Execute.
int	UpdateExtentIsEmpty (vtkInformation pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. The source uses this call to determine whether to call Execute.
virtual void	UpdateInformation ()
	Backward compatibility method to invoke UpdateInformation on executive.
void	UpdateProgress (double amount)
	Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).
virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.
Public Member Functions inherited from Kitware.VTK.vtkObject
	vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObject ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint	AddObserver (uint arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
uint	AddObserver (string arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	DebugOff ()
	Turn debugging output off.
virtual void	DebugOn ()
	Turn debugging output on.
vtkCommand	GetCommand (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
byte	GetDebug ()
	Get the value of the debug flag.
int	HasObserver (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	Modified ()
	Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void	RemoveAllObservers ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (vtkCommand arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	SetDebug (byte debugFlag)
	Set the value of the debug flag. A non-zero value turns debugging on.
override string	ToString ()
	Returns the result of calling vtkObject::Print as a C# string.
delegate void	vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
	Generic signature for all vtkObject events.
void	RemoveAllHandlersForAllEvents ()
	Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
Public Member Functions inherited from Kitware.VTK.vtkObjectBase
	vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObjectBase ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void	FastDelete ()
	Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string	GetClassName ()
	Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int arg0)
	Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions
static new vtkTableBasedClipDataSet	New ()
	Create an instance with a user-specified implicit function, turning off IVARs InsideOut and GenerateClipScalars and setting IVAR Value to 0.0.
static new int	IsTypeOf (string type)
	*Undocumented Block
static new vtkTableBasedClipDataSet	SafeDownCast (vtkObjectBase o)
	*Undocumented Block

Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkTableBasedClipDataSet"
	Automatically generated type registration mechanics.
Public Attributes inherited from Kitware.VTK.vtkUnstructuredGridAlgorithm
Public Attributes inherited from Kitware.VTK.vtkAlgorithm
Public Attributes inherited from Kitware.VTK.vtkObject
Public Attributes inherited from Kitware.VTK.vtkObjectBase
Public Attributes inherited from Kitware.VTK.WrappedObject
const string	vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
	Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string	vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
	Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string	vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
	Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
	Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
	Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string	vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
	Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string	vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
	Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string	vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
	Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string	vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
	Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string	vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
	Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string	vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
	Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string	vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
	Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string	vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
	Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string	vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
	Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string	vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
	Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes
static new readonly string	MRClassNameKey = "24vtkTableBasedClipDataSet"
	Automatically generated type registration mechanics.
Static Public Attributes inherited from Kitware.VTK.vtkUnstructuredGridAlgorithm
Static Public Attributes inherited from Kitware.VTK.vtkAlgorithm
Static Public Attributes inherited from Kitware.VTK.vtkObject
Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions
override void	Dispose (bool disposing)
	Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions
static	vtkTableBasedClipDataSet ()
	Automatically generated type registration mechanics.

Detailed Description

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

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

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

vtkClipDataSet vtkClipVolume vtkClipPolyData vtkCutter vtkImplicitFunction

Constructor & Destructor Documentation

static Kitware.VTK.vtkTableBasedClipDataSet.vtkTableBasedClipDataSet ( )

staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkTableBasedClipDataSet.vtkTableBasedClipDataSet	(	IntPtr	rawCppThis,
		bool	callDisposalMethod,
		bool	strong
	)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkTableBasedClipDataSet.vtkTableBasedClipDataSet ( )

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

Member Function Documentation

void Kitware.VTK.vtkTableBasedClipDataSet.CreateDefaultLocator ( )

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

override void Kitware.VTK.vtkTableBasedClipDataSet.Dispose ( bool disposing )

protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkUnstructuredGridAlgorithm.

virtual void Kitware.VTK.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.

virtual void Kitware.VTK.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 Kitware.VTK.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.

virtual void Kitware.VTK.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 vtkImplicitFunction Kitware.VTK.vtkTableBasedClipDataSet.GetClipFunction ( )

virtual

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

Here is the call graph for this function:

vtkUnstructuredGrid Kitware.VTK.vtkTableBasedClipDataSet.GetClippedOutput ( )

Return the clipped output.

Here is the call graph for this function:

virtual int Kitware.VTK.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 int Kitware.VTK.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 int Kitware.VTK.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 vtkIncrementalPointLocator Kitware.VTK.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.

Here is the call graph for this function:

virtual double Kitware.VTK.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.

virtual double Kitware.VTK.vtkTableBasedClipDataSet.GetMergeToleranceMaxValue ( )

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 Kitware.VTK.vtkTableBasedClipDataSet.GetMergeToleranceMinValue ( )

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.

override uint Kitware.VTK.vtkTableBasedClipDataSet.GetMTime ( )

virtual

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

Reimplemented from Kitware.VTK.vtkObject.

virtual bool Kitware.VTK.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 double Kitware.VTK.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 Kitware.VTK.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 Kitware.VTK.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.

override int Kitware.VTK.vtkTableBasedClipDataSet.IsA ( string type )

virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkUnstructuredGridAlgorithm.

static new int Kitware.VTK.vtkTableBasedClipDataSet.IsTypeOf ( string type )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkUnstructuredGridAlgorithm.

static new vtkTableBasedClipDataSet Kitware.VTK.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.

Reimplemented from Kitware.VTK.vtkUnstructuredGridAlgorithm.

new vtkTableBasedClipDataSet Kitware.VTK.vtkTableBasedClipDataSet.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkUnstructuredGridAlgorithm.

static new vtkTableBasedClipDataSet Kitware.VTK.vtkTableBasedClipDataSet.SafeDownCast ( vtkObjectBase o )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkUnstructuredGridAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkTableBasedClipDataSet.SetClipFunction ( vtkImplicitFunction arg0 )

virtual

Description 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 Kitware.VTK.vtkTableBasedClipDataSet.SetGenerateClippedOutput ( int _arg )

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 Kitware.VTK.vtkTableBasedClipDataSet.SetGenerateClipScalars ( int _arg )

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 Kitware.VTK.vtkTableBasedClipDataSet.SetInsideOut ( int _arg )

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.

void Kitware.VTK.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 void Kitware.VTK.vtkTableBasedClipDataSet.SetMergeTolerance ( double _arg )

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 void Kitware.VTK.vtkTableBasedClipDataSet.SetUseValueAsOffset ( bool _arg )

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 Kitware.VTK.vtkTableBasedClipDataSet.SetValue ( double _arg )

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