VTK  9.3.20240724
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPolyDataPlaneClipper Class Reference

clip a vtkPolyData with a plane and optionally cap it More...

#include <vtkPolyDataPlaneClipper.h>

Inheritance diagram for vtkPolyDataPlaneClipper:
[legend]
Collaboration diagram for vtkPolyDataPlaneClipper:
[legend]

Public Member Functions

vtkMTimeType GetMTime () override
 The modified time depends on the delegated clipping plane.
 
vtkPolyDataGetCap ()
 Get the output dataset representing the clipping loops and capping polygons.
 
void SetPlane (vtkPlane *)
 Specify the plane (an implicit function) to perform the clipping.
 
virtual vtkPlaneGetPlane ()
 Specify the plane (an implicit function) to perform the clipping.
 
virtual void SetClippingLoops (bool)
 Specify whether to generate clipping loops, i.e., the intersection of the plane with the input polydata.
 
virtual bool GetClippingLoops ()
 Specify whether to generate clipping loops, i.e., the intersection of the plane with the input polydata.
 
virtual void ClippingLoopsOn ()
 Specify whether to generate clipping loops, i.e., the intersection of the plane with the input polydata.
 
virtual void ClippingLoopsOff ()
 Specify whether to generate clipping loops, i.e., the intersection of the plane with the input polydata.
 
virtual void SetCapping (bool)
 Specify whether to cap the clipped output vtkPolyData.
 
virtual bool GetCapping ()
 Specify whether to cap the clipped output vtkPolyData.
 
virtual void CappingOn ()
 Specify whether to cap the clipped output vtkPolyData.
 
virtual void CappingOff ()
 Specify whether to cap the clipped output vtkPolyData.
 
virtual void SetPassCapPointData (bool)
 Specify whether to pass point data through to the second (Cap) output.
 
virtual bool GetPassCapPointData ()
 Specify whether to pass point data through to the second (Cap) output.
 
virtual void PassCapPointDataOn ()
 Specify whether to pass point data through to the second (Cap) output.
 
virtual void PassCapPointDataOff ()
 Specify whether to pass point data through to the second (Cap) output.
 
virtual void SetOutputPointsPrecision (int)
 Set/get the desired precision for the output points type.
 
virtual int GetOutputPointsPrecision ()
 Set/get the desired precision for the output points type.
 
virtual void SetBatchSize (unsigned int)
 Specify the number of input triangles in a batch, where a batch defines a subset of the input triangles operated on during threaded execution.
 
virtual unsigned int GetBatchSize ()
 Specify the number of input triangles in a batch, where a batch defines a subset of the input triangles operated on during threaded execution.
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkPolyDataAlgorithmNewInstance () 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
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm.
 
vtkPolyDataGetOutput (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.
 
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive.
 
vtkExecutiveGetExecutive ()
 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.
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port.
 
vtkInformationGetOutputPortInformation (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 SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime.
 
void UpdateProgress (double amount)
 Update the progress of the process object.
 
bool CheckAbort ()
 Checks to see if this filter should abort.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess().
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
 
void RemoveAllInputs ()
 Remove all the input data.
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
 
vtkDataObjectGetInputDataObject (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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm.
 
vtkAlgorithmOutputGetOutputPort ()
 
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.
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0).
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection.
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0)
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection.
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0)
 
vtkInformationGetOutputInformation (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 VTK_UNBLOCKTHREADS int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual VTK_UNBLOCKTHREADS 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 VTK_UNBLOCKTHREADS 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 VTK_UNBLOCKTHREADS 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.
 
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm.
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm.
 
bool UsesGarbageCollector () const 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 SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm.
 
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm.
 
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive.
 
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive.
 
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 VTK_UNBLOCKTHREADS void Update (int port)
 Bring this algorithm's outputs up-to-date.
 
virtual VTK_UNBLOCKTHREADS void Update ()
 Bring this algorithm's outputs up-to-date.
 
virtual void SetReleaseDataFlag (vtkTypeBool)
 Turn release data flag on or off for all output ports.
 
virtual vtkTypeBool 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 vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
- 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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
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.
 
vtkCommandGetCommand (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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
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.
 
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)
 This helper method can be used to determine the if the input vtkPolyData contains convex polygonal cells, and therefore is suitable for processing by this filter.
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements.
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_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 vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
 
static vtkInformationIntegerKeyABORTED ()
 
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 vtkObjectNew ()
 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 (vtkTypeBool 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 vtkTypeBool 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 vtkObjectBaseNew ()
 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

 vtkPolyDataPlaneClipper ()
 
 ~vtkPolyDataPlaneClipper () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass.
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm () 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.
 
virtual int RequestUpdateTime (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 vtkObjectBaseNewInstanceInternal () const
 
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted.
 
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 association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
 
virtual vtkExecutiveCreateDefaultExecutive ()
 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.
 
vtkDataArrayGetInputArrayToProcess (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.
 
vtkDataArrayGetInputArrayToProcess (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.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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 *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkSmartPointer< vtkPlanePlane
 
bool ClippingLoops
 
bool Capping
 
bool PassCapPointData
 
int OutputPointsPrecision
 
unsigned int BatchSize
 
- Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
 
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
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
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkPolyDataAlgorithm Superclass
 Standard construction, type, and print methods.
 
static vtkPolyDataPlaneClipperNew ()
 Standard construction, type, and print methods.
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard construction, type, and print methods.
 
static vtkPolyDataPlaneClipperSafeDownCast (vtkObjectBase *o)
 Standard construction, type, and print methods.
 
virtual vtkTypeBool IsA (const char *type)
 Standard construction, type, and print methods.
 
vtkPolyDataPlaneClipperNewInstance () const
 Standard construction, type, and print methods.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard construction, type, and print methods.
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard construction, type, and print methods.
 

Additional Inherited Members

- Public Types inherited from vtkPolyDataAlgorithm
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
std::atomic< vtkTypeBoolAbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_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 vtkTimeStamp LastAbortTime
 
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

clip a vtkPolyData with a plane and optionally cap it

vtkPolyDataPlaneClipper clips an input vtkPolyData with a plane to produce an output vtkPolyData. (Here clipping means extracting cells, or portions of cells, that are on one side of a specified plane.) The input vtkPolyData must consist of convex polygons forming one or more manifold shells (use vtkTriangleFilter to triangulate the input if necessary. Note that if the input cells are non-convex, then the clipping operation will likely produce erroneous results.)

An optional, second vtkPolyData output may also be generated if either ClippingLoops or Capping is enabled. The clipping loops are a set of lines representing the curve(s) of intersection between the plane and the one or more shells of the input vtkPolyData. If Capping is enabled, then the clipping loops are tessellated to produce a "cap" across the clipped output. The capping option is only available if the input consists of one or more manifold shells. If not, the loop generation will fail and no cap(s) will be generated.

Warning
The method CanFullyProcessDataObject() is available to see whether the input data can be successfully processed by this filter. Use this method sparingly because it can be slow.
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
vtkClipPolyData vtkClipClosedSurface vtkPolyDataPlaneCutter vtkPlaneCutter vtkTriangleFilter vtkCutter
Tests:
vtkPolyDataPlaneClipper (Tests)

Definition at line 52 of file vtkPolyDataPlaneClipper.h.

Member Typedef Documentation

◆ Superclass

Standard construction, type, and print methods.

Definition at line 60 of file vtkPolyDataPlaneClipper.h.

Constructor & Destructor Documentation

◆ vtkPolyDataPlaneClipper()

vtkPolyDataPlaneClipper::vtkPolyDataPlaneClipper ( )
protected

◆ ~vtkPolyDataPlaneClipper()

vtkPolyDataPlaneClipper::~vtkPolyDataPlaneClipper ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPolyDataPlaneClipper * vtkPolyDataPlaneClipper::New ( )
static

Standard construction, type, and print methods.

◆ IsTypeOf()

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

Standard construction, type, and print methods.

◆ IsA()

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

Standard construction, type, and print methods.

Reimplemented from vtkPolyDataAlgorithm.

◆ SafeDownCast()

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

Standard construction, type, and print methods.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPolyDataPlaneClipper::NewInstanceInternal ( ) const
protectedvirtual

Standard construction, type, and print methods.

Reimplemented from vtkPolyDataAlgorithm.

◆ NewInstance()

vtkPolyDataPlaneClipper * vtkPolyDataPlaneClipper::NewInstance ( ) const

Standard construction, type, and print methods.

◆ PrintSelf()

void vtkPolyDataPlaneClipper::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Standard construction, type, and print methods.

Reimplemented from vtkPolyDataAlgorithm.

◆ GetMTime()

vtkMTimeType vtkPolyDataPlaneClipper::GetMTime ( )
overridevirtual

The modified time depends on the delegated clipping plane.

Reimplemented from vtkObject.

◆ SetPlane()

void vtkPolyDataPlaneClipper::SetPlane ( vtkPlane )

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

The definition of the plane used to perform the clipping (i.e., its origin and normal) is controlled via this instance of vtkPlane.

◆ GetPlane()

virtual vtkPlane * vtkPolyDataPlaneClipper::GetPlane ( )
virtual

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

The definition of the plane used to perform the clipping (i.e., its origin and normal) is controlled via this instance of vtkPlane.

◆ SetClippingLoops()

virtual void vtkPolyDataPlaneClipper::SetClippingLoops ( bool  )
virtual

Specify whether to generate clipping loops, i.e., the intersection of the plane with the input polydata.

The generation of clipping loops will function correctly even if the input vtkPolyData consists of non-closed shells; however if the shells are not closed, the loops will not be either. If enabled, a second vtkPolyData output will be produced that contains the clipping loops (in vtkPolyData::Lines)

◆ GetClippingLoops()

virtual bool vtkPolyDataPlaneClipper::GetClippingLoops ( )
virtual

Specify whether to generate clipping loops, i.e., the intersection of the plane with the input polydata.

The generation of clipping loops will function correctly even if the input vtkPolyData consists of non-closed shells; however if the shells are not closed, the loops will not be either. If enabled, a second vtkPolyData output will be produced that contains the clipping loops (in vtkPolyData::Lines)

◆ ClippingLoopsOn()

virtual void vtkPolyDataPlaneClipper::ClippingLoopsOn ( )
virtual

Specify whether to generate clipping loops, i.e., the intersection of the plane with the input polydata.

The generation of clipping loops will function correctly even if the input vtkPolyData consists of non-closed shells; however if the shells are not closed, the loops will not be either. If enabled, a second vtkPolyData output will be produced that contains the clipping loops (in vtkPolyData::Lines)

◆ ClippingLoopsOff()

virtual void vtkPolyDataPlaneClipper::ClippingLoopsOff ( )
virtual

Specify whether to generate clipping loops, i.e., the intersection of the plane with the input polydata.

The generation of clipping loops will function correctly even if the input vtkPolyData consists of non-closed shells; however if the shells are not closed, the loops will not be either. If enabled, a second vtkPolyData output will be produced that contains the clipping loops (in vtkPolyData::Lines)

◆ SetCapping()

virtual void vtkPolyDataPlaneClipper::SetCapping ( bool  )
virtual

Specify whether to cap the clipped output vtkPolyData.

If enabled, a second vtkPolyData output will be produced that contains the capping polygons (in vtkPolyData:Polys). Note that the capping operation assumes that the input to this filter is a manifold shell. If not, no output will be generated. Note that point data or cell data is not produced on this second output (because the results of interpolation across the cap(s) are generally nonsensical).

◆ GetCapping()

virtual bool vtkPolyDataPlaneClipper::GetCapping ( )
virtual

Specify whether to cap the clipped output vtkPolyData.

If enabled, a second vtkPolyData output will be produced that contains the capping polygons (in vtkPolyData:Polys). Note that the capping operation assumes that the input to this filter is a manifold shell. If not, no output will be generated. Note that point data or cell data is not produced on this second output (because the results of interpolation across the cap(s) are generally nonsensical).

◆ CappingOn()

virtual void vtkPolyDataPlaneClipper::CappingOn ( )
virtual

Specify whether to cap the clipped output vtkPolyData.

If enabled, a second vtkPolyData output will be produced that contains the capping polygons (in vtkPolyData:Polys). Note that the capping operation assumes that the input to this filter is a manifold shell. If not, no output will be generated. Note that point data or cell data is not produced on this second output (because the results of interpolation across the cap(s) are generally nonsensical).

◆ CappingOff()

virtual void vtkPolyDataPlaneClipper::CappingOff ( )
virtual

Specify whether to cap the clipped output vtkPolyData.

If enabled, a second vtkPolyData output will be produced that contains the capping polygons (in vtkPolyData:Polys). Note that the capping operation assumes that the input to this filter is a manifold shell. If not, no output will be generated. Note that point data or cell data is not produced on this second output (because the results of interpolation across the cap(s) are generally nonsensical).

◆ GetCap()

vtkPolyData * vtkPolyDataPlaneClipper::GetCap ( )

Get the output dataset representing the clipping loops and capping polygons.

This output is empty if both ClippingLoops and Capping is off. Otherwise, if there is an intersection with the clipping plane, then polyline loops are available from the vtkPolyData::Lines, and the capping polygons are available from the vtkPolyData::Polys data arrays.

◆ SetPassCapPointData()

virtual void vtkPolyDataPlaneClipper::SetPassCapPointData ( bool  )
virtual

Specify whether to pass point data through to the second (Cap) output.

By default this is disabled. This feature is useful in certain situations when trying to combine the cap with clipped polydata.

◆ GetPassCapPointData()

virtual bool vtkPolyDataPlaneClipper::GetPassCapPointData ( )
virtual

Specify whether to pass point data through to the second (Cap) output.

By default this is disabled. This feature is useful in certain situations when trying to combine the cap with clipped polydata.

◆ PassCapPointDataOn()

virtual void vtkPolyDataPlaneClipper::PassCapPointDataOn ( )
virtual

Specify whether to pass point data through to the second (Cap) output.

By default this is disabled. This feature is useful in certain situations when trying to combine the cap with clipped polydata.

◆ PassCapPointDataOff()

virtual void vtkPolyDataPlaneClipper::PassCapPointDataOff ( )
virtual

Specify whether to pass point data through to the second (Cap) output.

By default this is disabled. This feature is useful in certain situations when trying to combine the cap with clipped polydata.

◆ SetOutputPointsPrecision()

virtual void vtkPolyDataPlaneClipper::SetOutputPointsPrecision ( int  )
virtual

Set/get the desired precision for the output points type.

See the documentation for the vtkAlgorithm::DesiredOutputPrecision enum for an explanation of the available precision settings. OutputPointsPrecision is DEFAULT_PRECISION by default.

◆ GetOutputPointsPrecision()

virtual int vtkPolyDataPlaneClipper::GetOutputPointsPrecision ( )
virtual

Set/get the desired precision for the output points type.

See the documentation for the vtkAlgorithm::DesiredOutputPrecision enum for an explanation of the available precision settings. OutputPointsPrecision is DEFAULT_PRECISION by default.

◆ SetBatchSize()

virtual void vtkPolyDataPlaneClipper::SetBatchSize ( unsigned int  )
virtual

Specify the number of input triangles in a batch, where a batch defines a subset of the input triangles operated on during threaded execution.

Generally this is only used for debugging or performance studies (since batch size affects the thread workload).

◆ GetBatchSize()

virtual unsigned int vtkPolyDataPlaneClipper::GetBatchSize ( )
virtual

Specify the number of input triangles in a batch, where a batch defines a subset of the input triangles operated on during threaded execution.

Generally this is only used for debugging or performance studies (since batch size affects the thread workload).

◆ CanFullyProcessDataObject()

static bool vtkPolyDataPlaneClipper::CanFullyProcessDataObject ( vtkDataObject object)
inlinestatic

This helper method can be used to determine the if the input vtkPolyData contains convex polygonal cells, and therefore is suitable for processing by this filter.

(The name of the method is consistent with other filters that perform similar operations.) This method returns true when the input contains only polygons (i.e., no verts, lines, or triangle strips); and each polygon is convex. It returns false otherwise.

Definition at line 159 of file vtkPolyDataPlaneClipper.h.

◆ RequestData()

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

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

Member Data Documentation

◆ Plane

vtkSmartPointer<vtkPlane> vtkPolyDataPlaneClipper::Plane
protected

Definition at line 168 of file vtkPolyDataPlaneClipper.h.

◆ ClippingLoops

bool vtkPolyDataPlaneClipper::ClippingLoops
protected

Definition at line 169 of file vtkPolyDataPlaneClipper.h.

◆ Capping

bool vtkPolyDataPlaneClipper::Capping
protected

Definition at line 170 of file vtkPolyDataPlaneClipper.h.

◆ PassCapPointData

bool vtkPolyDataPlaneClipper::PassCapPointData
protected

Definition at line 171 of file vtkPolyDataPlaneClipper.h.

◆ OutputPointsPrecision

int vtkPolyDataPlaneClipper::OutputPointsPrecision
protected

Definition at line 172 of file vtkPolyDataPlaneClipper.h.

◆ BatchSize

unsigned int vtkPolyDataPlaneClipper::BatchSize
protected

Definition at line 173 of file vtkPolyDataPlaneClipper.h.


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