vtk3DLinearGridPlaneCutter Class Reference

fast plane cutting of vtkUnstructuredGrid containing 3D linear cells More...

#include <vtk3DLinearGridPlaneCutter.h>

Inheritance diagram for vtk3DLinearGridPlaneCutter:

Collaboration diagram for vtk3DLinearGridPlaneCutter:

Public Member Functions
vtkMTimeType	GetMTime () override
	Overloaded GetMTime() because of delegation to the helper vtkPlane.
int	GetNumberOfThreadsUsed ()
	Return the number of threads actually used during execution.
bool	GetLargeIds ()
	Inform the user as to whether large ids were used during filter execution.
virtual void	SetPlane (vtkPlane *)
	Specify the plane (an implicit function) to perform the cutting.
virtual vtkPlane *	GetPlane ()
	Specify the plane (an implicit function) to perform the cutting.
virtual void	SetMergePoints (bool)
	Indicate whether to merge coincident points.
virtual bool	GetMergePoints ()
	Indicate whether to merge coincident points.
virtual void	MergePointsOn ()
	Indicate whether to merge coincident points.
virtual void	MergePointsOff ()
	Indicate whether to merge coincident points.
virtual void	SetInterpolateAttributes (bool)
	Indicate whether to interpolate input attributes onto the cut plane.
virtual bool	GetInterpolateAttributes ()
	Indicate whether to interpolate input attributes onto the cut plane.
virtual void	InterpolateAttributesOn ()
	Indicate whether to interpolate input attributes onto the cut plane.
virtual void	InterpolateAttributesOff ()
	Indicate whether to interpolate input attributes onto the cut plane.
virtual void	SetComputeNormals (bool)
	Set/Get the computation of normals.
virtual bool	GetComputeNormals ()
	Set/Get the computation of normals.
virtual void	ComputeNormalsOn ()
	Set/Get the computation of normals.
virtual void	ComputeNormalsOff ()
	Set/Get the computation of normals.
void	SetOutputPointsPrecision (int precision)
	Set/get the desired precision for the output points.
int	GetOutputPointsPrecision () const
	Set/get the desired precision for the output points.
virtual void	SetSequentialProcessing (bool)
	Force sequential processing (i.e.
virtual bool	GetSequentialProcessing ()
	Force sequential processing (i.e.
virtual void	SequentialProcessingOn ()
	Force sequential processing (i.e.
virtual void	SequentialProcessingOff ()
	Force sequential processing (i.e.
Public Member Functions inherited from vtkDataObjectAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkDataObjectAlgorithm *	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 ()
vtkDataObject *	GetInput (int port)
vtkDataObject *	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkDataObject *	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 bool	CanFullyProcessDataObject (vtkDataObject *object)
	Returns true if the data object passed in is fully supported by this filter, i.e., all cell types are linear.
Static Public Member Functions inherited from vtkDataObjectAlgorithm
static vtkDataObjectAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkDataObjectAlgorithm *	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
	vtk3DLinearGridPlaneCutter ()
	~vtk3DLinearGridPlaneCutter () override
int	ProcessPiece (vtkUnstructuredGrid *input, vtkPlane *plane, vtkPolyData *output)
int	RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
	This is called by the superclass.
int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.
Protected Member Functions inherited from vtkDataObjectAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkDataObjectAlgorithm ()
	~vtkDataObjectAlgorithm () override
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	This is called by the superclass.
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	This is called by the superclass.
virtual int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
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
vtkPlane *	Plane
bool	MergePoints
bool	InterpolateAttributes
bool	ComputeNormals
int	OutputPointsPrecision
bool	SequentialProcessing
int	NumberOfThreadsUsed
bool	LargeIds
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
typedef vtkDataObjectAlgorithm	Superclass
	Standard methods for construction, type info, and printing.
static vtk3DLinearGridPlaneCutter *	New ()
	Standard methods for construction, type info, and printing.
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for construction, type info, and printing.
static vtk3DLinearGridPlaneCutter *	SafeDownCast (vtkObjectBase *o)
	Standard methods for construction, type info, and printing.
virtual vtkTypeBool	IsA (const char *type)
	Standard methods for construction, type info, and printing.
vtk3DLinearGridPlaneCutter *	NewInstance () const
	Standard methods for construction, type info, and printing.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for construction, type info, and printing.
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for construction, type info, and printing.

Additional Inherited Members
Public Types inherited from vtkDataObjectAlgorithm
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 Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute
Static Protected Member Functions inherited from vtkDataObjectAlgorithm
static bool	SetOutputDataObject (int dataType, vtkInformation *outputInformation, bool exact=false)
	A helper method that can be used by subclasses in RequestDataObject to create an output data object of the given type if not already present.
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

fast plane cutting of vtkUnstructuredGrid containing 3D linear cells

vtk3DLinearGridPlaneCutter is a specialized filter that cuts an input vtkUnstructuredGrid consisting of 3D linear cells: tetrahedra, hexahedra, voxels, pyramids, and/or wedges. (The cells are linear in the sense that each cell edge is a straight line.) The filter is designed for high-speed, specialized operation. All other cell types are skipped and produce no output.

To use this filter you must specify an input unstructured grid or vtkCompositeDataSet (containing unstructured grids) and a plane to cut with.

The filter performance varies depending on optional output information. Basically if point merging is required (when PointMerging is set) a sorting process is required to eliminate duplicate output points in the cut surface. Otherwise when point merging is not required, a fast path process produces independent triangles representing the cut surface.

This algorithm is fast because it is threaded, and may perform operations (in a preprocessing step) to accelerate the plane cutting.

Because this filter may build an initial data structure during a preprocessing step, the first execution of the filter may take longer than subsequent operations. Typically the first execution is still faster than vtkCutter (especially with threading enabled), but for certain types of data this may not be true. However if you are using the filter to cut a dataset multiple times (as in an exploratory or interactive workflow) this filter works well.

Warning

When the input is of type vtkCompositeDataSet the filter will process the unstructured grid(s) contained in the composite data set. As a result the output of this filter is then a vtkMultiBlockDataSet containing multiple vtkPolyData. When a vtkUnstructuredGrid is provided as input the output is a single vtkPolyData.

Input cells that are not of 3D linear type (tetrahedron, hexahedron, wedge, pyramid, and voxel) are simply skipped and not processed.

The filter is templated on types of input and output points, and input scalar type. To reduce object file bloat, only real points (float,double) are processed.

This class has been threaded with vtkSMPTools. Using TBB or other non-sequential type (set in the CMake variable VTK_SMP_IMPLEMENTATION_TYPE) may improve performance significantly.

See also

vtkCutter vtkFlyingEdgesPlaneCutter vtkPlaneCutter vtkPlane vtkSphereTree vtkContour3DLinearGrid

Definition at line 83 of file vtk3DLinearGridPlaneCutter.h.

Member Typedef Documentation

Superclass

typedef vtkDataObjectAlgorithm vtk3DLinearGridPlaneCutter::Superclass

Standard methods for construction, type info, and printing.

Definition at line 91 of file vtk3DLinearGridPlaneCutter.h.

Constructor & Destructor Documentation

vtk3DLinearGridPlaneCutter()

vtk3DLinearGridPlaneCutter::vtk3DLinearGridPlaneCutter ( )

protected

~vtk3DLinearGridPlaneCutter()

vtk3DLinearGridPlaneCutter::~vtk3DLinearGridPlaneCutter ( )

overrideprotected

Member Function Documentation

New()

static vtk3DLinearGridPlaneCutter * vtk3DLinearGridPlaneCutter::New ( )

static

Standard methods for construction, type info, and printing.

IsTypeOf()

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

static

Standard methods for construction, type info, and printing.

IsA()

virtual vtkTypeBool vtk3DLinearGridPlaneCutter::IsA ( const char *  type )

virtual

Standard methods for construction, type info, and printing.

Reimplemented from vtkDataObjectAlgorithm.

SafeDownCast()

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

static

Standard methods for construction, type info, and printing.

NewInstanceInternal()

virtual vtkObjectBase * vtk3DLinearGridPlaneCutter::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for construction, type info, and printing.

Reimplemented from vtkDataObjectAlgorithm.

NewInstance()

vtk3DLinearGridPlaneCutter * vtk3DLinearGridPlaneCutter::NewInstance

(

)

const

Standard methods for construction, type info, and printing.

PrintSelf()

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

overridevirtual

Standard methods for construction, type info, and printing.

Reimplemented from vtkDataObjectAlgorithm.

SetPlane()

virtual void vtk3DLinearGridPlaneCutter::SetPlane ( vtkPlane *  )

virtual

Specify the plane (an implicit function) to perform the cutting.

The definition of the plane (its origin and normal) is controlled via this instance of vtkPlane.

GetPlane()

virtual vtkPlane * vtk3DLinearGridPlaneCutter::GetPlane ( )

virtual

Specify the plane (an implicit function) to perform the cutting.

The definition of the plane (its origin and normal) is controlled via this instance of vtkPlane.

SetMergePoints()

virtual void vtk3DLinearGridPlaneCutter::SetMergePoints ( bool  )

virtual

Indicate whether to merge coincident points.

Merging can take extra time and produces fewer output points, creating a "watertight" output surface. On the other hand, merging reduced output data size and may be just as fast especially for smaller data. By default this is off.

GetMergePoints()

virtual bool vtk3DLinearGridPlaneCutter::GetMergePoints ( )

virtual

Indicate whether to merge coincident points.

Merging can take extra time and produces fewer output points, creating a "watertight" output surface. On the other hand, merging reduced output data size and may be just as fast especially for smaller data. By default this is off.

MergePointsOn()

virtual void vtk3DLinearGridPlaneCutter::MergePointsOn ( )

virtual

Indicate whether to merge coincident points.

Merging can take extra time and produces fewer output points, creating a "watertight" output surface. On the other hand, merging reduced output data size and may be just as fast especially for smaller data. By default this is off.

MergePointsOff()

virtual void vtk3DLinearGridPlaneCutter::MergePointsOff ( )

virtual

Indicate whether to merge coincident points.

Merging can take extra time and produces fewer output points, creating a "watertight" output surface. On the other hand, merging reduced output data size and may be just as fast especially for smaller data. By default this is off.

SetInterpolateAttributes()

virtual void vtk3DLinearGridPlaneCutter::SetInterpolateAttributes ( bool  )

virtual

Indicate whether to interpolate input attributes onto the cut plane.

By default this option is on.

GetInterpolateAttributes()

virtual bool vtk3DLinearGridPlaneCutter::GetInterpolateAttributes ( )

virtual

Indicate whether to interpolate input attributes onto the cut plane.

By default this option is on.

InterpolateAttributesOn()

virtual void vtk3DLinearGridPlaneCutter::InterpolateAttributesOn ( )

virtual

Indicate whether to interpolate input attributes onto the cut plane.

By default this option is on.

InterpolateAttributesOff()

virtual void vtk3DLinearGridPlaneCutter::InterpolateAttributesOff ( )

virtual

Indicate whether to interpolate input attributes onto the cut plane.

By default this option is on.

SetComputeNormals()

virtual void vtk3DLinearGridPlaneCutter::SetComputeNormals ( bool  )

virtual

Set/Get the computation of normals.

The normal generated is simply the cut plane normal. The normal, if generated, is defined by cell data associated with the output polygons. By default computing of normals is off.

GetComputeNormals()

virtual bool vtk3DLinearGridPlaneCutter::GetComputeNormals ( )

virtual

Set/Get the computation of normals.

The normal generated is simply the cut plane normal. The normal, if generated, is defined by cell data associated with the output polygons. By default computing of normals is off.

ComputeNormalsOn()

virtual void vtk3DLinearGridPlaneCutter::ComputeNormalsOn ( )

virtual

Set/Get the computation of normals.

The normal generated is simply the cut plane normal. The normal, if generated, is defined by cell data associated with the output polygons. By default computing of normals is off.

ComputeNormalsOff()

virtual void vtk3DLinearGridPlaneCutter::ComputeNormalsOff ( )

virtual

Set/Get the computation of normals.

The normal generated is simply the cut plane normal. The normal, if generated, is defined by cell data associated with the output polygons. By default computing of normals is off.

GetMTime()

vtkMTimeType vtk3DLinearGridPlaneCutter::GetMTime ( )

overridevirtual

Overloaded GetMTime() because of delegation to the helper vtkPlane.

Reimplemented from vtkObject.

SetOutputPointsPrecision()

void vtk3DLinearGridPlaneCutter::SetOutputPointsPrecision

(

int

precision

)

Set/get the desired precision for the output points.

See the documentation for the vtkAlgorithm::Precision enum for an explanation of the available precision settings.

GetOutputPointsPrecision()

int vtk3DLinearGridPlaneCutter::GetOutputPointsPrecision

(

)

const

Set/get the desired precision for the output points.

See the documentation for the vtkAlgorithm::Precision enum for an explanation of the available precision settings.

SetSequentialProcessing()

virtual void vtk3DLinearGridPlaneCutter::SetSequentialProcessing ( bool  )

virtual

Force sequential processing (i.e.

single thread) of the contouring process. By default, sequential processing is off. Note this flag only applies if the class has been compiled with VTK_SMP_IMPLEMENTATION_TYPE set to something other than Sequential. (If set to Sequential, then the filter always runs in serial mode.) This flag is typically used for benchmarking purposes.

GetSequentialProcessing()

virtual bool vtk3DLinearGridPlaneCutter::GetSequentialProcessing ( )

virtual

Force sequential processing (i.e.

single thread) of the contouring process. By default, sequential processing is off. Note this flag only applies if the class has been compiled with VTK_SMP_IMPLEMENTATION_TYPE set to something other than Sequential. (If set to Sequential, then the filter always runs in serial mode.) This flag is typically used for benchmarking purposes.

SequentialProcessingOn()

virtual void vtk3DLinearGridPlaneCutter::SequentialProcessingOn ( )

virtual

Force sequential processing (i.e.

single thread) of the contouring process. By default, sequential processing is off. Note this flag only applies if the class has been compiled with VTK_SMP_IMPLEMENTATION_TYPE set to something other than Sequential. (If set to Sequential, then the filter always runs in serial mode.) This flag is typically used for benchmarking purposes.

SequentialProcessingOff()

virtual void vtk3DLinearGridPlaneCutter::SequentialProcessingOff ( )

virtual

Force sequential processing (i.e.

single thread) of the contouring process. By default, sequential processing is off. Note this flag only applies if the class has been compiled with VTK_SMP_IMPLEMENTATION_TYPE set to something other than Sequential. (If set to Sequential, then the filter always runs in serial mode.) This flag is typically used for benchmarking purposes.

GetNumberOfThreadsUsed()

int vtk3DLinearGridPlaneCutter::GetNumberOfThreadsUsed ( )

inline

Return the number of threads actually used during execution.

This is valid only after algorithm execution.

Definition at line 173 of file vtk3DLinearGridPlaneCutter.h.

GetLargeIds()

bool vtk3DLinearGridPlaneCutter::GetLargeIds ( )

inline

Inform the user as to whether large ids were used during filter execution.

This flag only has meaning after the filter has executed. Large ids are used when the id of the larges cell or point is greater than signed 32-bit precision. (Smaller ids reduce memory usage and speed computation. Note that LargeIds are only available on 64-bit architectures.)

Definition at line 183 of file vtk3DLinearGridPlaneCutter.h.

CanFullyProcessDataObject()

static bool vtk3DLinearGridPlaneCutter::CanFullyProcessDataObject ( vtkDataObject *  object )

static

Returns true if the data object passed in is fully supported by this filter, i.e., all cell types are linear.

For composite datasets, this means all dataset leaves have only linear cell types that can be processed by this filter.

ProcessPiece()

int vtk3DLinearGridPlaneCutter::ProcessPiece ( vtkUnstructuredGrid *  input, vtkPlane *  plane, vtkPolyData *  output  )

protected

RequestDataObject()

int vtk3DLinearGridPlaneCutter::RequestDataObject ( vtkInformation *  , vtkInformationVector **  , vtkInformationVector *    )

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkDataObjectAlgorithm.

RequestData()

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

overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

FillInputPortInformation()

int vtk3DLinearGridPlaneCutter::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 vtkDataObjectAlgorithm.

Member Data Documentation

Plane

vtkPlane* vtk3DLinearGridPlaneCutter::Plane

protected

Definition at line 197 of file vtk3DLinearGridPlaneCutter.h.

MergePoints

bool vtk3DLinearGridPlaneCutter::MergePoints

protected

Definition at line 198 of file vtk3DLinearGridPlaneCutter.h.

InterpolateAttributes

bool vtk3DLinearGridPlaneCutter::InterpolateAttributes

protected

Definition at line 199 of file vtk3DLinearGridPlaneCutter.h.

ComputeNormals

bool vtk3DLinearGridPlaneCutter::ComputeNormals

protected

Definition at line 200 of file vtk3DLinearGridPlaneCutter.h.

OutputPointsPrecision

int vtk3DLinearGridPlaneCutter::OutputPointsPrecision

protected

Definition at line 201 of file vtk3DLinearGridPlaneCutter.h.

SequentialProcessing

bool vtk3DLinearGridPlaneCutter::SequentialProcessing

protected

Definition at line 202 of file vtk3DLinearGridPlaneCutter.h.

NumberOfThreadsUsed

int vtk3DLinearGridPlaneCutter::NumberOfThreadsUsed

protected

Definition at line 203 of file vtk3DLinearGridPlaneCutter.h.

LargeIds

bool vtk3DLinearGridPlaneCutter::LargeIds

protected

Definition at line 204 of file vtk3DLinearGridPlaneCutter.h.

---

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

• Filters/Core/vtk3DLinearGridPlaneCutter.h