vtkGenericClip Class Reference

clip any dataset with an implicit function or scalar data More...

#include <vtkGenericClip.h>

Inheritance diagram for vtkGenericClip:

Collaboration diagram for vtkGenericClip:

Public Types
typedef vtkUnstructuredGridAlgorithm	Superclass
Public Types inherited from vtkUnstructuredGridAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkGenericClip *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	CreateDefaultLocator ()
	Create default locator.
vtkMTimeType	GetMTime () override
	Return the mtime also considering the locator and clip function.
virtual void	SetValue (double)
	Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars).
virtual double	GetValue ()
	Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars).
virtual void	SetInsideOut (vtkTypeBool)
	Set/Get the InsideOut flag.
virtual vtkTypeBool	GetInsideOut ()
	Set/Get the InsideOut flag.
virtual void	InsideOutOn ()
	Set/Get the InsideOut flag.
virtual void	InsideOutOff ()
	Set/Get the InsideOut flag.
virtual void	SetClipFunction (vtkImplicitFunction *)
	Specify the implicit function with which to perform the clipping.
virtual vtkImplicitFunction *	GetClipFunction ()
	Specify the implicit function with which to perform the clipping.
virtual void	SetGenerateClipScalars (vtkTypeBool)
	If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.
virtual vtkTypeBool	GetGenerateClipScalars ()
	If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.
virtual void	GenerateClipScalarsOn ()
	If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.
virtual void	GenerateClipScalarsOff ()
	If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.
virtual void	SetGenerateClippedOutput (vtkTypeBool)
	Control whether a second output is generated.
virtual vtkTypeBool	GetGenerateClippedOutput ()
	Control whether a second output is generated.
virtual void	GenerateClippedOutputOn ()
	Control whether a second output is generated.
virtual void	GenerateClippedOutputOff ()
	Control whether a second output is generated.
virtual void	SetMergeTolerance (double)
	Set the tolerance for merging clip intersection points that are near the vertices of cells.
virtual double	GetMergeTolerance ()
	Set the tolerance for merging clip intersection points that are near the vertices of cells.
vtkUnstructuredGrid *	GetClippedOutput ()
	Return the Clipped output.
virtual int	GetNumberOfOutputs ()
	Return the Clipped output.
void	SetLocator (vtkIncrementalPointLocator *locator)
	Specify a spatial locator for merging points.
virtual vtkIncrementalPointLocator *	GetLocator ()
	Specify a spatial locator for merging points.
virtual char *	GetInputScalarsSelection ()
	If you want to clip by an arbitrary array, then set its name here.
void	SelectInputScalars (const char *fieldName)
	If you want to clip by an arbitrary array, then set its name here.
Public Member Functions inherited from vtkUnstructuredGridAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkUnstructuredGridAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkTypeBool	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	see vtkAlgorithm for details
vtkDataObject *	GetInput (int port)
vtkDataObject *	GetInput ()
vtkUnstructuredGrid *	GetUnstructuredGridInput (int port)
vtkUnstructuredGrid *	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkUnstructuredGrid *	GetOutput (int)
	Get the output data object for a port on this algorithm.
virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm.
void	SetInputData (vtkDataObject *)
	Assign a data object as input.
void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.
void	AddInputData (vtkDataObject *)
	Assign a data object as input.
void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.
Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
int	HasExecutive ()
	Check whether this algorithm has an assigned executive.
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.
virtual vtkTypeBool	ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
vtkTypeBool	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.
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.
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.
vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output 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.
void	SetProgress (double)
	SetProgress is deprecated.
void	UpdateProgress (double amount)
	Update the progress of the process object.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
	String based versions of SetInputArrayToProcess().
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
void	RemoveAllInputs ()
	Remove all the input data.
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.
virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.
virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.
virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.
virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date.
virtual void	UpdateDataObject ()
	Create output object(s).
virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.
virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.
void	Register (vtkObjectBase *o) override
	Participate in garbage collection.
void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection.
virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.
virtual double	GetProgress ()
	Get the execution progress of a process object.
void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.
virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.
virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual void	Update ()
	Bring this algorithm's outputs up-to-date.
virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports.
virtual int	GetReleaseDataFlag ()
	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	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, 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.
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.
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.
int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.
int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.
void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkGenericClip *	SafeDownCast (vtkObjectBase *o)
static vtkGenericClip *	New ()
	Construct with user-specified implicit function; InsideOut turned off; value set to 0.0; and generate clip scalars turned off.
Static Public Member Functions inherited from vtkUnstructuredGridAlgorithm
static vtkUnstructuredGridAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkUnstructuredGridAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.
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 ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkGenericClip (vtkImplicitFunction *cf=nullptr)
	~vtkGenericClip () override
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	This is called by the superclass.
int	FillInputPortInformation (int, vtkInformation *) override
	Fill the input port information objects for this algorithm.
virtual void	SetInputScalarsSelection (const char *)
Protected Member Functions inherited from vtkUnstructuredGridAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkUnstructuredGridAlgorithm ()
	~vtkUnstructuredGridAlgorithm () override
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	This is called by the superclass.
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	This is called by the superclass.
int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm.
int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.
Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAlgorithm ()
	~vtkAlgorithm () override
virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.
virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.
virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.
void	ReportReferences (vtkGarbageCollector *) override
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.
virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.
void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.
void	AddInputDataInternal (int port, vtkDataObject *input)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkImplicitFunction *	ClipFunction
vtkIncrementalPointLocator *	Locator
vtkTypeBool	InsideOut
double	Value
vtkTypeBool	GenerateClipScalars
vtkTypeBool	GenerateClippedOutput
double	MergeTolerance
char *	InputScalarsSelection
vtkPointData *	InternalPD
vtkPointData *	SecondaryPD
vtkCellData *	SecondaryCD
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

clip any dataset with an implicit function or scalar data

vtkGenericClip is a filter that any type of dataset using either any subclass of vtkImplicitFunction, or the input scalar data. Clipping means that it actually "cuts" through the cells of the dataset, 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.

This filter has been implemented to operate on generic datasets, rather than the typical vtkDataSet (and subclasses). vtkGenericDataSet is a more complex cousin of vtkDataSet, typically consisting of nonlinear, higher-order cells. To process this type of data, generic cells are automatically tessellated into linear cells prior to isocontouring.

See also

vtkClipDataSet vtkClipPolyData vtkClipVolume vtkImplicitFunction vtkGenericDataSet

Online Examples:

GenericClip

Definition at line 92 of file vtkGenericClip.h.

Member Typedef Documentation

Superclass

typedef vtkUnstructuredGridAlgorithm vtkGenericClip::Superclass

Definition at line 95 of file vtkGenericClip.h.

Constructor & Destructor Documentation

vtkGenericClip()

vtkGenericClip::vtkGenericClip ( vtkImplicitFunction *  cf = nullptr )

protected

~vtkGenericClip()

vtkGenericClip::~vtkGenericClip ( )

overrideprotected

Member Function Documentation

IsTypeOf()

static vtkTypeBool vtkGenericClip::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkGenericClip::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.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkGenericClip::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkUnstructuredGridAlgorithm.

NewInstance()

vtkGenericClip * vtkGenericClip::NewInstance

(

)

const

PrintSelf()

void vtkGenericClip::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

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.

New()

static vtkGenericClip * vtkGenericClip::New ( )

static

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

SetValue()

virtual void vtkGenericClip::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.

GetValue()

virtual double vtkGenericClip::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.

SetInsideOut()

virtual void vtkGenericClip::SetInsideOut ( vtkTypeBool  )

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.

GetInsideOut()

virtual vtkTypeBool vtkGenericClip::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.

InsideOutOn()

virtual void vtkGenericClip::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.

InsideOutOff()

virtual void vtkGenericClip::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.

SetClipFunction()

virtual void vtkGenericClip::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.

GetClipFunction()

virtual vtkImplicitFunction * vtkGenericClip::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.

SetGenerateClipScalars()

virtual void vtkGenericClip::SetGenerateClipScalars ( vtkTypeBool  )

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.

GetGenerateClipScalars()

virtual vtkTypeBool vtkGenericClip::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.

GenerateClipScalarsOn()

virtual void vtkGenericClip::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.

GenerateClipScalarsOff()

virtual void vtkGenericClip::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.

SetGenerateClippedOutput()

virtual void vtkGenericClip::SetGenerateClippedOutput ( vtkTypeBool  )

virtual

Control whether a second output is generated.

The second output contains the polygonal data that's been clipped away.

GetGenerateClippedOutput()

virtual vtkTypeBool vtkGenericClip::GetGenerateClippedOutput ( )

virtual

Control whether a second output is generated.

The second output contains the polygonal data that's been clipped away.

GenerateClippedOutputOn()

virtual void vtkGenericClip::GenerateClippedOutputOn ( )

virtual

Control whether a second output is generated.

The second output contains the polygonal data that's been clipped away.

GenerateClippedOutputOff()

virtual void vtkGenericClip::GenerateClippedOutputOff ( )

virtual

Control whether a second output is generated.

The second output contains the polygonal data that's been clipped away.

SetMergeTolerance()

virtual void vtkGenericClip::SetMergeTolerance ( double  )

virtual

Set the tolerance for merging clip intersection points that are near the vertices of cells.

This tolerance is used to prevent the generation of degenerate primitives. Note that only 3D cells actually use this instance variable.

GetMergeTolerance()

virtual double vtkGenericClip::GetMergeTolerance ( )

virtual

Set the tolerance for merging clip intersection points that are near the vertices of cells.

This tolerance is used to prevent the generation of degenerate primitives. Note that only 3D cells actually use this instance variable.

GetClippedOutput()

vtkUnstructuredGrid * vtkGenericClip::GetClippedOutput

(

)

Return the Clipped output.

GetNumberOfOutputs()

virtual int vtkGenericClip::GetNumberOfOutputs ( )

virtual

Return the Clipped output.

SetLocator()

void vtkGenericClip::SetLocator

(

vtkIncrementalPointLocator *

locator

)

Specify a spatial locator for merging points.

By default, an instance of vtkMergePoints is used.

GetLocator()

virtual vtkIncrementalPointLocator * vtkGenericClip::GetLocator ( )

virtual

Specify a spatial locator for merging points.

By default, an instance of vtkMergePoints is used.

CreateDefaultLocator()

void vtkGenericClip::CreateDefaultLocator

(

)

Create default locator.

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

GetMTime()

vtkMTimeType vtkGenericClip::GetMTime ( )

overridevirtual

Return the mtime also considering the locator and clip function.

Reimplemented from vtkObject.

GetInputScalarsSelection()

virtual char * vtkGenericClip::GetInputScalarsSelection ( )

virtual

If you want to clip by an arbitrary array, then set its name here.

By default this in nullptr and the filter will use the active scalar array.

SelectInputScalars()

void vtkGenericClip::SelectInputScalars ( const char *  fieldName )

inline

If you want to clip by an arbitrary array, then set its name here.

By default this in nullptr and the filter will use the active scalar array.

Definition at line 205 of file vtkGenericClip.h.

RequestData()

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

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkUnstructuredGridAlgorithm.

FillInputPortInformation()

int vtkGenericClip::FillInputPortInformation ( int  port, vtkInformation *  info  )

overrideprotectedvirtual

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.

SetInputScalarsSelection()

virtual void vtkGenericClip::SetInputScalarsSelection ( const char *  )

protectedvirtual

Member Data Documentation

ClipFunction

vtkImplicitFunction* vtkGenericClip::ClipFunction

protected

Definition at line 215 of file vtkGenericClip.h.

Locator

vtkIncrementalPointLocator* vtkGenericClip::Locator

protected

Definition at line 217 of file vtkGenericClip.h.

InsideOut

vtkTypeBool vtkGenericClip::InsideOut

protected

Definition at line 218 of file vtkGenericClip.h.

Value

double vtkGenericClip::Value

protected

Definition at line 219 of file vtkGenericClip.h.

GenerateClipScalars

vtkTypeBool vtkGenericClip::GenerateClipScalars

protected

Definition at line 220 of file vtkGenericClip.h.

GenerateClippedOutput

vtkTypeBool vtkGenericClip::GenerateClippedOutput

protected

Definition at line 222 of file vtkGenericClip.h.

MergeTolerance

double vtkGenericClip::MergeTolerance

protected

Definition at line 223 of file vtkGenericClip.h.

InputScalarsSelection

char* vtkGenericClip::InputScalarsSelection

protected

Definition at line 225 of file vtkGenericClip.h.

InternalPD

vtkPointData* vtkGenericClip::InternalPD

protected

Definition at line 229 of file vtkGenericClip.h.

SecondaryPD

vtkPointData* vtkGenericClip::SecondaryPD

protected

Definition at line 230 of file vtkGenericClip.h.

SecondaryCD

vtkCellData* vtkGenericClip::SecondaryCD

protected

Definition at line 231 of file vtkGenericClip.h.

---

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

• Filters/Generic/vtkGenericClip.h