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

cut any dataset with a plane and generate a polygonal cut surface More...

#include <vtkPlaneCutter.h>

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

Public Member Functions

vtkMTimeType GetMTime () override
 The modified time depends on the delegated cut plane. More...
 
int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 See vtkAlgorithm for details. More...
 
virtual void SetPlane (vtkPlane *)
 Specify the plane (an implicit function) to perform the cutting. More...
 
virtual vtkPlaneGetPlane ()
 Specify the plane (an implicit function) to perform the cutting. More...
 
virtual void SetComputeNormals (bool)
 Set/Get the computation of normals. More...
 
virtual bool GetComputeNormals ()
 Set/Get the computation of normals. More...
 
virtual void ComputeNormalsOn ()
 Set/Get the computation of normals. More...
 
virtual void ComputeNormalsOff ()
 Set/Get the computation of normals. More...
 
virtual void SetInterpolateAttributes (bool)
 Indicate whether to interpolate attribute data. More...
 
virtual bool GetInterpolateAttributes ()
 Indicate whether to interpolate attribute data. More...
 
virtual void InterpolateAttributesOn ()
 Indicate whether to interpolate attribute data. More...
 
virtual void InterpolateAttributesOff ()
 Indicate whether to interpolate attribute data. More...
 
virtual void SetGeneratePolygons (bool)
 Indicate whether to generate polygons instead of triangles when cutting structured and rectilinear grid. More...
 
virtual bool GetGeneratePolygons ()
 Indicate whether to generate polygons instead of triangles when cutting structured and rectilinear grid. More...
 
virtual void GeneratePolygonsOn ()
 Indicate whether to generate polygons instead of triangles when cutting structured and rectilinear grid. More...
 
virtual void GeneratePolygonsOff ()
 Indicate whether to generate polygons instead of triangles when cutting structured and rectilinear grid. More...
 
virtual void SetBuildTree (bool)
 Indicate whether to build the sphere tree. More...
 
virtual bool GetBuildTree ()
 Indicate whether to build the sphere tree. More...
 
virtual void BuildTreeOn ()
 Indicate whether to build the sphere tree. More...
 
virtual void BuildTreeOff ()
 Indicate whether to build the sphere tree. More...
 
virtual void SetBuildHierarchy (bool)
 Indicate whether to build tree hierarchy. More...
 
virtual bool GetBuildHierarchy ()
 Indicate whether to build tree hierarchy. More...
 
virtual void BuildHierarchyOn ()
 Indicate whether to build tree hierarchy. More...
 
virtual void BuildHierarchyOff ()
 Indicate whether to build tree hierarchy. More...
 
- Public Member Functions inherited from vtkDataSetAlgorithm
vtkDataSetAlgorithmNewInstance () const
 
vtkDataObjectGetInput ()
 Get the input data object. More...
 
vtkPolyDataGetPolyDataOutput ()
 Get the output as vtkPolyData. More...
 
vtkStructuredPointsGetStructuredPointsOutput ()
 Get the output as vtkStructuredPoints. More...
 
vtkImageDataGetImageDataOutput ()
 Get the output as vtkStructuredPoints. More...
 
vtkStructuredGridGetStructuredGridOutput ()
 Get the output as vtkStructuredGrid. More...
 
vtkUnstructuredGridGetUnstructuredGridOutput ()
 Get the output as vtkUnstructuredGrid. More...
 
vtkRectilinearGridGetRectilinearGridOutput ()
 Get the output as vtkRectilinearGrid. More...
 
vtkDataSetGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkDataSetGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (vtkDataSet *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataSet *)
 Assign a data object as input. More...
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (vtkDataSet *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataSet *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
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. More...
 
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. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual int 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). More...
 
virtual int Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void SetProgress (double)
 Set/Get the execution progress of a process object. More...
 
virtual double GetProgress ()
 Set/Get the execution progress of a process object. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
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. More...
 
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. More...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
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. More...
 
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. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
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. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Protected Member Functions

 vtkPlaneCutter ()
 
 ~vtkPlaneCutter () override
 
int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called within ProcessRequest to when a request asks the algorithm to create empty output data objects. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called within ProcessRequest when a request asks the algorithm to do its work. More...
 
int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
virtual int ExecuteDataSet (vtkDataSet *input, vtkSphereTree *tree, vtkMultiPieceDataSet *output)
 
- Protected Member Functions inherited from vtkDataSetAlgorithm
 vtkDataSetAlgorithm ()
 
 ~vtkDataSetAlgorithm () override
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when a request asks for Information. More...
 
vtkDataObjectGetInput (int port)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
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. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
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. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
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. More...
 
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. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
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. More...
 
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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static void AddNormalArray (double *planeNormal, vtkDataSet *ds)
 
static void InitializeOutput (vtkMultiPieceDataSet *output)
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 

Protected Attributes

vtkPlanePlane
 
bool ComputeNormals
 
bool InterpolateAttributes
 
bool GeneratePolygons
 
bool BuildTree
 
bool BuildHierarchy
 
std::vector< vtkSmartPointer< vtkSphereTree > > SphereTrees
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkDataSetAlgorithm Superclass
 Standard construction and print methods. More...
 
static vtkPlaneCutterNew ()
 Standard construction and print methods. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard construction and print methods. More...
 
static vtkPlaneCutterSafeDownCast (vtkObjectBase *o)
 Standard construction and print methods. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard construction and print methods. More...
 
vtkPlaneCutterNewInstance () const
 Standard construction and print methods. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard construction and print methods. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard construction and print methods. More...
 

Additional Inherited Members

- Public Types inherited from vtkDataSetAlgorithm
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
 
- Static Public Member Functions inherited from vtkDataSetAlgorithm
static vtkDataSetAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataSetAlgorithmSafeDownCast (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. More...
 
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. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- 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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

cut any dataset with a plane and generate a polygonal cut surface

vtkPlaneCutter is a specialization of the vtkCutter algorithm to cut a dataset grid with a single plane. It is designed for performance and an exploratory, fast workflow. It produces output polygons that result from cutting the icnput dataset with the specified plane.

This algorithm is fast because it is threaded, and may build (in a preprocessing step) a spatial search structure that accelerates the plane cuts. The search structure, which is typically a sphere tree, is used to quickly cull candidate cells. Also unlike vtkCutter, the vtkPlane implicit function (representing the plane) does not need to be evaluated with each cut. (Note that other methods of acceleration are delegated to for image data, see vtkFlyingEdgesPlaneCutter documentation.)

Because this filter builds 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
This filter outputs a vtkMultiPieceDataSet.
This filter delegates to vtkFlyingEdgesPlaneCutter to process image data, but output and input have been standardized when possible.
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 vtkPlane
Tests:
vtkPlaneCutter (Tests)

Definition at line 79 of file vtkPlaneCutter.h.

Member Typedef Documentation

Standard construction and print methods.

Definition at line 87 of file vtkPlaneCutter.h.

Constructor & Destructor Documentation

vtkPlaneCutter::vtkPlaneCutter ( )
protected
vtkPlaneCutter::~vtkPlaneCutter ( )
overrideprotected

Member Function Documentation

static vtkPlaneCutter* vtkPlaneCutter::New ( )
static

Standard construction and print methods.

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

Standard construction and print methods.

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

Standard construction and print methods.

Reimplemented from vtkDataSetAlgorithm.

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

Standard construction and print methods.

virtual vtkObjectBase* vtkPlaneCutter::NewInstanceInternal ( ) const
protectedvirtual

Standard construction and print methods.

Reimplemented from vtkDataSetAlgorithm.

vtkPlaneCutter* vtkPlaneCutter::NewInstance ( ) const

Standard construction and print methods.

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

Standard construction and print methods.

Reimplemented from vtkDataSetAlgorithm.

vtkMTimeType vtkPlaneCutter::GetMTime ( )
overridevirtual

The modified time depends on the delegated cut plane.

Reimplemented from vtkObject.

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

virtual vtkPlane* vtkPlaneCutter::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.

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

virtual bool vtkPlaneCutter::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 disabled.

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

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

virtual void vtkPlaneCutter::SetInterpolateAttributes ( bool  )
virtual

Indicate whether to interpolate attribute data.

By default this is enabled. Note that both cell data and point data is interpolated and outputted, except for image data input where only point data are outputted.

virtual bool vtkPlaneCutter::GetInterpolateAttributes ( )
virtual

Indicate whether to interpolate attribute data.

By default this is enabled. Note that both cell data and point data is interpolated and outputted, except for image data input where only point data are outputted.

virtual void vtkPlaneCutter::InterpolateAttributesOn ( )
virtual

Indicate whether to interpolate attribute data.

By default this is enabled. Note that both cell data and point data is interpolated and outputted, except for image data input where only point data are outputted.

virtual void vtkPlaneCutter::InterpolateAttributesOff ( )
virtual

Indicate whether to interpolate attribute data.

By default this is enabled. Note that both cell data and point data is interpolated and outputted, except for image data input where only point data are outputted.

virtual void vtkPlaneCutter::SetGeneratePolygons ( bool  )
virtual

Indicate whether to generate polygons instead of triangles when cutting structured and rectilinear grid.

No effect with other kinds of inputs, enabled by default.

virtual bool vtkPlaneCutter::GetGeneratePolygons ( )
virtual

Indicate whether to generate polygons instead of triangles when cutting structured and rectilinear grid.

No effect with other kinds of inputs, enabled by default.

virtual void vtkPlaneCutter::GeneratePolygonsOn ( )
virtual

Indicate whether to generate polygons instead of triangles when cutting structured and rectilinear grid.

No effect with other kinds of inputs, enabled by default.

virtual void vtkPlaneCutter::GeneratePolygonsOff ( )
virtual

Indicate whether to generate polygons instead of triangles when cutting structured and rectilinear grid.

No effect with other kinds of inputs, enabled by default.

virtual void vtkPlaneCutter::SetBuildTree ( bool  )
virtual

Indicate whether to build the sphere tree.

Computing the sphere will take some time on the first computation but if the input does not change, the computation of all further slice will be much faster. Default is on.

virtual bool vtkPlaneCutter::GetBuildTree ( )
virtual

Indicate whether to build the sphere tree.

Computing the sphere will take some time on the first computation but if the input does not change, the computation of all further slice will be much faster. Default is on.

virtual void vtkPlaneCutter::BuildTreeOn ( )
virtual

Indicate whether to build the sphere tree.

Computing the sphere will take some time on the first computation but if the input does not change, the computation of all further slice will be much faster. Default is on.

virtual void vtkPlaneCutter::BuildTreeOff ( )
virtual

Indicate whether to build the sphere tree.

Computing the sphere will take some time on the first computation but if the input does not change, the computation of all further slice will be much faster. Default is on.

virtual void vtkPlaneCutter::SetBuildHierarchy ( bool  )
virtual

Indicate whether to build tree hierarchy.

Computing the tree hierarchy can take some time on the first computation but if the input does not change, the computation of all further slice will be faster. Default is on.

virtual bool vtkPlaneCutter::GetBuildHierarchy ( )
virtual

Indicate whether to build tree hierarchy.

Computing the tree hierarchy can take some time on the first computation but if the input does not change, the computation of all further slice will be faster. Default is on.

virtual void vtkPlaneCutter::BuildHierarchyOn ( )
virtual

Indicate whether to build tree hierarchy.

Computing the tree hierarchy can take some time on the first computation but if the input does not change, the computation of all further slice will be faster. Default is on.

virtual void vtkPlaneCutter::BuildHierarchyOff ( )
virtual

Indicate whether to build tree hierarchy.

Computing the tree hierarchy can take some time on the first computation but if the input does not change, the computation of all further slice will be faster. Default is on.

int vtkPlaneCutter::ProcessRequest ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overridevirtual

See vtkAlgorithm for details.

Reimplemented from vtkDataSetAlgorithm.

int vtkPlaneCutter::RequestDataObject ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called within ProcessRequest to when a request asks the algorithm to create empty output data objects.

This typically happens early on in the execution of the pipeline. The default behavior is to create an output DataSet of the same type as the input for each output port. This method can be overridden to change the output data type of an algorithm. This happens in the third pass of the pipeline execution.

Reimplemented from vtkDataSetAlgorithm.

int vtkPlaneCutter::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called within ProcessRequest when a request asks the algorithm to do its work.

This is the method you should override to do whatever the algorithm is designed to do. This happens during the fourth pass in the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.

int vtkPlaneCutter::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for.

This happens during the second pass in the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.

int vtkPlaneCutter::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 vtkDataSetAlgorithm.

int vtkPlaneCutter::FillOutputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Fill the output port information objects for this algorithm.

This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkDataSetAlgorithm.

virtual int vtkPlaneCutter::ExecuteDataSet ( vtkDataSet input,
vtkSphereTree tree,
vtkMultiPieceDataSet output 
)
protectedvirtual
static void vtkPlaneCutter::AddNormalArray ( double planeNormal,
vtkDataSet ds 
)
staticprotected
static void vtkPlaneCutter::InitializeOutput ( vtkMultiPieceDataSet output)
staticprotected

Member Data Documentation

vtkPlane* vtkPlaneCutter::Plane
protected

Definition at line 173 of file vtkPlaneCutter.h.

bool vtkPlaneCutter::ComputeNormals
protected

Definition at line 174 of file vtkPlaneCutter.h.

bool vtkPlaneCutter::InterpolateAttributes
protected

Definition at line 175 of file vtkPlaneCutter.h.

bool vtkPlaneCutter::GeneratePolygons
protected

Definition at line 176 of file vtkPlaneCutter.h.

bool vtkPlaneCutter::BuildTree
protected

Definition at line 177 of file vtkPlaneCutter.h.

bool vtkPlaneCutter::BuildHierarchy
protected

Definition at line 178 of file vtkPlaneCutter.h.

std::vector<vtkSmartPointer<vtkSphereTree> > vtkPlaneCutter::SphereTrees
protected

Definition at line 181 of file vtkPlaneCutter.h.


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