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

Clip a closed surface with a plane collection. More...

#include <vtkClipClosedSurface.h>

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

Public Types

typedef vtkPolyDataAlgorithm Superclass
 
- 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 Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkClipClosedSurfaceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetClippingPlanes (vtkPlaneCollection *planes)
 Set the vtkPlaneCollection that holds the clipping planes. More...
 
virtual vtkPlaneCollectionGetClippingPlanes ()
 
virtual void SetTolerance (double)
 Set the tolerance for creating new points while clipping. More...
 
virtual double GetTolerance ()
 
virtual void SetPassPointData (vtkTypeBool)
 Pass the point data to the output. More...
 
virtual void PassPointDataOn ()
 
virtual void PassPointDataOff ()
 
virtual vtkTypeBool GetPassPointData ()
 
virtual void SetGenerateOutline (vtkTypeBool)
 Set whether to generate an outline wherever an input face was cut by a plane. More...
 
virtual void GenerateOutlineOn ()
 
virtual void GenerateOutlineOff ()
 
virtual vtkTypeBool GetGenerateOutline ()
 
virtual void SetGenerateFaces (vtkTypeBool)
 Set whether to generate polygonal faces for the output. More...
 
virtual void GenerateFacesOn ()
 
virtual void GenerateFacesOff ()
 
virtual vtkTypeBool GetGenerateFaces ()
 
virtual void SetScalarMode (int)
 Set whether to add cell scalars, so that new faces and outlines can be distinguished from original faces and lines. More...
 
void SetScalarModeToNone ()
 
void SetScalarModeToColors ()
 
void SetScalarModeToLabels ()
 
virtual int GetScalarMode ()
 
const char * GetScalarModeAsString ()
 
virtual void SetBaseColor (double, double, double)
 Set the color for all cells were part of the original geometry. More...
 
virtual void SetBaseColor (double[3])
 
virtual doubleGetBaseColor ()
 
virtual void GetBaseColor (double &, double &, double &)
 
virtual void GetBaseColor (double[3])
 
virtual void SetClipColor (double, double, double)
 Set the color for any new geometry, either faces or outlines, that are created as a result of the clipping. More...
 
virtual void SetClipColor (double[3])
 
virtual doubleGetClipColor ()
 
virtual void GetClipColor (double &, double &, double &)
 
virtual void GetClipColor (double[3])
 
virtual void SetActivePlaneId (int)
 Set the active plane, so that the clipping from that plane can be displayed in a different color. More...
 
virtual int GetActivePlaneId ()
 
virtual void SetActivePlaneColor (double, double, double)
 Set the color for any new geometry produced by clipping with the ActivePlane, if ActivePlaneId is set. More...
 
virtual void SetActivePlaneColor (double[3])
 
virtual doubleGetActivePlaneColor ()
 
virtual void GetActivePlaneColor (double &, double &, double &)
 
virtual void GetActivePlaneColor (double[3])
 
virtual void SetTriangulationErrorDisplay (vtkTypeBool)
 Generate errors when the triangulation fails. More...
 
virtual void TriangulationErrorDisplayOn ()
 
virtual void TriangulationErrorDisplayOff ()
 
virtual vtkTypeBool GetTriangulationErrorDisplay ()
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkPolyDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 
- 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...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. 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...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
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 Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
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)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
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 SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
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 void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
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). More...
 
virtual vtkTypeBool 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 void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
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)
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- 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...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkClipClosedSurfaceNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkClipClosedSurfaceSafeDownCast (vtkObjectBase *o)
 
- 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. 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkClipClosedSurface ()
 
 ~vtkClipClosedSurface () override
 
int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, int requestFromOutputPort, vtkMTimeType *mtime) override
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 This is called by the superclass. More...
 
void ClipLines (vtkPoints *points, vtkDoubleArray *pointScalars, vtkPointData *pointData, vtkCCSEdgeLocator *edgeLocator, vtkCellArray *inputCells, vtkCellArray *outputLines, vtkCellData *inCellData, vtkCellData *outLineData)
 Method for clipping lines and copying the scalar data. More...
 
void ClipAndContourPolys (vtkPoints *points, vtkDoubleArray *pointScalars, vtkPointData *pointData, vtkCCSEdgeLocator *edgeLocator, int triangulate, vtkCellArray *inputCells, vtkCellArray *outputPolys, vtkCellArray *outputLines, vtkCellData *inPolyData, vtkCellData *outPolyData, vtkCellData *outLineData)
 Clip and contour polys in one step, in order to guarantee that the contour lines exactly match the new free edges of the clipped polygons. More...
 
int TriangulatePolygon (vtkIdList *polygon, vtkPoints *points, vtkCellArray *triangles)
 A robust method for triangulating a polygon. More...
 
void TriangulateContours (vtkPolyData *data, vtkIdType firstLine, vtkIdType numLines, vtkCellArray *outputPolys, const double normal[3])
 Given some closed contour lines, create a triangle mesh that fills those lines. More...
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
- 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...
 
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)
 
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)
 
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)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
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)
 
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)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
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...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. 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)
 
- 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 ()
 
- 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 int InterpolateEdge (vtkPoints *points, vtkPointData *pointData, vtkCCSEdgeLocator *edgeLocator, double tol, vtkIdType i0, vtkIdType i1, double v0, double v1, vtkIdType &i)
 A helper function for interpolating a new point along an edge. More...
 
static void BreakPolylines (vtkCellArray *inputLines, vtkCellArray *outputLines, vtkUnsignedCharArray *inputScalars, vtkIdType firstLineScalar, vtkUnsignedCharArray *outputScalars, const unsigned char color[3])
 Break polylines into individual lines, copying scalar values from inputScalars starting at firstLineScalar. More...
 
static void CopyPolygons (vtkCellArray *inputPolys, vtkCellArray *outputPolys, vtkUnsignedCharArray *inputScalars, vtkIdType firstPolyScalar, vtkUnsignedCharArray *outputScalars, const unsigned char color[3])
 Copy polygons and their associated scalars to a new array. More...
 
static void BreakTriangleStrips (vtkCellArray *inputStrips, vtkCellArray *outputPolys, vtkUnsignedCharArray *inputScalars, vtkIdType firstStripScalar, vtkUnsignedCharArray *outputScalars, const unsigned char color[3])
 Break triangle strips and add the triangles to the output. More...
 
static void SqueezeOutputPoints (vtkPolyData *output, vtkPoints *points, vtkPointData *pointData, int outputPointDataType)
 Squeeze the points and store them in the output. More...
 
static void CreateColorValues (const double color1[3], const double color2[3], const double color3[3], unsigned char colors[3][3])
 Take three colors as doubles, and convert to unsigned char. More...
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 

Protected Attributes

vtkPlaneCollectionClippingPlanes
 
double Tolerance
 
vtkTypeBool PassPointData
 
vtkTypeBool GenerateOutline
 
vtkTypeBool GenerateFaces
 
int ActivePlaneId
 
int ScalarMode
 
double BaseColor [3]
 
double ClipColor [3]
 
double ActivePlaneColor [3]
 
vtkTypeBool TriangulationErrorDisplay
 
vtkIdListIdList
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Clip a closed surface with a plane collection.

vtkClipClosedSurface will clip a closed polydata surface with a collection of clipping planes. It will produce a new closed surface by creating new polygonal faces where the input data was clipped.

Non-manifold surfaces should not be used as input for this filter. The input surface should have no open edges, and must not have any edges that are shared by more than two faces. The vtkFeatureEdges filter can be used to verify that a data set satisfies these conditions. In addition, the input surface should not self-intersect, meaning that the faces of the surface should only touch at their edges.

If GenerateOutline is on, this filter will generate an outline wherever the clipping planes intersect the data. The ScalarMode option will add cell scalars to the output, so that the generated faces can be visualized in a different color from the original surface.

Warning
The triangulation of new faces is done in O(n) time for simple convex inputs, but for non-convex inputs the worst-case time is O(n^2*m^2) where n is the number of points and m is the number of 3D cavities. The best triangulation algorithms, in contrast, are O(n log n). There are also rare cases where the triangulation will fail to produce a watertight output. Turn on TriangulationErrorDisplay to be notified of these failures.
See also
vtkOutlineFilter vtkOutlineSource vtkVolumeOutlineSource
Thanks:
Thanks to David Gobbi for contributing this class to VTK.
Tests:
vtkClipClosedSurface (Tests)

Definition at line 75 of file vtkClipClosedSurface.h.

Member Typedef Documentation

◆ Superclass

Definition at line 79 of file vtkClipClosedSurface.h.

Constructor & Destructor Documentation

◆ vtkClipClosedSurface()

vtkClipClosedSurface::vtkClipClosedSurface ( )
protected

◆ ~vtkClipClosedSurface()

vtkClipClosedSurface::~vtkClipClosedSurface ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkClipClosedSurface* vtkClipClosedSurface::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkClipClosedSurface::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkClipClosedSurface::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

◆ NewInstance()

vtkClipClosedSurface* vtkClipClosedSurface::NewInstance ( ) const

◆ PrintSelf()

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

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPolyDataAlgorithm.

◆ SetClippingPlanes()

virtual void vtkClipClosedSurface::SetClippingPlanes ( vtkPlaneCollection planes)
virtual

Set the vtkPlaneCollection that holds the clipping planes.

◆ GetClippingPlanes()

virtual vtkPlaneCollection* vtkClipClosedSurface::GetClippingPlanes ( )
virtual

◆ SetTolerance()

virtual void vtkClipClosedSurface::SetTolerance ( double  )
virtual

Set the tolerance for creating new points while clipping.

If the tolerance is too small, then degenerate triangles might be produced. The default tolerance is 1e-6.

◆ GetTolerance()

virtual double vtkClipClosedSurface::GetTolerance ( )
virtual

◆ SetPassPointData()

virtual void vtkClipClosedSurface::SetPassPointData ( vtkTypeBool  )
virtual

Pass the point data to the output.

Point data will be interpolated when new points are generated. This is off by default.

◆ PassPointDataOn()

virtual void vtkClipClosedSurface::PassPointDataOn ( )
virtual

◆ PassPointDataOff()

virtual void vtkClipClosedSurface::PassPointDataOff ( )
virtual

◆ GetPassPointData()

virtual vtkTypeBool vtkClipClosedSurface::GetPassPointData ( )
virtual

◆ SetGenerateOutline()

virtual void vtkClipClosedSurface::SetGenerateOutline ( vtkTypeBool  )
virtual

Set whether to generate an outline wherever an input face was cut by a plane.

This is off by default.

◆ GenerateOutlineOn()

virtual void vtkClipClosedSurface::GenerateOutlineOn ( )
virtual

◆ GenerateOutlineOff()

virtual void vtkClipClosedSurface::GenerateOutlineOff ( )
virtual

◆ GetGenerateOutline()

virtual vtkTypeBool vtkClipClosedSurface::GetGenerateOutline ( )
virtual

◆ SetGenerateFaces()

virtual void vtkClipClosedSurface::SetGenerateFaces ( vtkTypeBool  )
virtual

Set whether to generate polygonal faces for the output.

This is on by default. If it is off, then the output will have no polys.

◆ GenerateFacesOn()

virtual void vtkClipClosedSurface::GenerateFacesOn ( )
virtual

◆ GenerateFacesOff()

virtual void vtkClipClosedSurface::GenerateFacesOff ( )
virtual

◆ GetGenerateFaces()

virtual vtkTypeBool vtkClipClosedSurface::GetGenerateFaces ( )
virtual

◆ SetScalarMode()

virtual void vtkClipClosedSurface::SetScalarMode ( int  )
virtual

Set whether to add cell scalars, so that new faces and outlines can be distinguished from original faces and lines.

The options are "None", "Colors", and "Labels". For the "Labels" option, a scalar value of "0" indicates an original cell, "1" indicates a new cell on a cut face, and "2" indicates a new cell on the ActivePlane as set by the SetActivePlane() method. The default scalar mode is "None".

◆ SetScalarModeToNone()

void vtkClipClosedSurface::SetScalarModeToNone ( )
inline

Definition at line 142 of file vtkClipClosedSurface.h.

◆ SetScalarModeToColors()

void vtkClipClosedSurface::SetScalarModeToColors ( )
inline

Definition at line 144 of file vtkClipClosedSurface.h.

◆ SetScalarModeToLabels()

void vtkClipClosedSurface::SetScalarModeToLabels ( )
inline

Definition at line 146 of file vtkClipClosedSurface.h.

◆ GetScalarMode()

virtual int vtkClipClosedSurface::GetScalarMode ( )
virtual

◆ GetScalarModeAsString()

const char* vtkClipClosedSurface::GetScalarModeAsString ( )

◆ SetBaseColor() [1/2]

virtual void vtkClipClosedSurface::SetBaseColor ( double  ,
double  ,
double   
)
virtual

Set the color for all cells were part of the original geometry.

If the input data already has color cell scalars, then those values will be used and parameter will be ignored. The default color is red. Requires SetScalarModeToColors.

◆ SetBaseColor() [2/2]

virtual void vtkClipClosedSurface::SetBaseColor ( double  [3])
virtual

◆ GetBaseColor() [1/3]

virtual double* vtkClipClosedSurface::GetBaseColor ( )
virtual

◆ GetBaseColor() [2/3]

virtual void vtkClipClosedSurface::GetBaseColor ( double ,
double ,
double  
)
virtual

◆ GetBaseColor() [3/3]

virtual void vtkClipClosedSurface::GetBaseColor ( double  [3])
virtual

◆ SetClipColor() [1/2]

virtual void vtkClipClosedSurface::SetClipColor ( double  ,
double  ,
double   
)
virtual

Set the color for any new geometry, either faces or outlines, that are created as a result of the clipping.

The default color is orange. Requires SetScalarModeToColors.

◆ SetClipColor() [2/2]

virtual void vtkClipClosedSurface::SetClipColor ( double  [3])
virtual

◆ GetClipColor() [1/3]

virtual double* vtkClipClosedSurface::GetClipColor ( )
virtual

◆ GetClipColor() [2/3]

virtual void vtkClipClosedSurface::GetClipColor ( double ,
double ,
double  
)
virtual

◆ GetClipColor() [3/3]

virtual void vtkClipClosedSurface::GetClipColor ( double  [3])
virtual

◆ SetActivePlaneId()

virtual void vtkClipClosedSurface::SetActivePlaneId ( int  )
virtual

Set the active plane, so that the clipping from that plane can be displayed in a different color.

Set this to -1 if there is no active plane. The default value is -1.

◆ GetActivePlaneId()

virtual int vtkClipClosedSurface::GetActivePlaneId ( )
virtual

◆ SetActivePlaneColor() [1/2]

virtual void vtkClipClosedSurface::SetActivePlaneColor ( double  ,
double  ,
double   
)
virtual

Set the color for any new geometry produced by clipping with the ActivePlane, if ActivePlaneId is set.

Default is yellow. Requires SetScalarModeToColors.

◆ SetActivePlaneColor() [2/2]

virtual void vtkClipClosedSurface::SetActivePlaneColor ( double  [3])
virtual

◆ GetActivePlaneColor() [1/3]

virtual double* vtkClipClosedSurface::GetActivePlaneColor ( )
virtual

◆ GetActivePlaneColor() [2/3]

virtual void vtkClipClosedSurface::GetActivePlaneColor ( double ,
double ,
double  
)
virtual

◆ GetActivePlaneColor() [3/3]

virtual void vtkClipClosedSurface::GetActivePlaneColor ( double  [3])
virtual

◆ SetTriangulationErrorDisplay()

virtual void vtkClipClosedSurface::SetTriangulationErrorDisplay ( vtkTypeBool  )
virtual

Generate errors when the triangulation fails.

Usually the triangulation errors are too small to see, but they result in a surface that is not watertight. This option has no impact on performance.

◆ TriangulationErrorDisplayOn()

virtual void vtkClipClosedSurface::TriangulationErrorDisplayOn ( )
virtual

◆ TriangulationErrorDisplayOff()

virtual void vtkClipClosedSurface::TriangulationErrorDisplayOff ( )
virtual

◆ GetTriangulationErrorDisplay()

virtual vtkTypeBool vtkClipClosedSurface::GetTriangulationErrorDisplay ( )
virtual

◆ ComputePipelineMTime()

int vtkClipClosedSurface::ComputePipelineMTime ( vtkInformation request,
vtkInformationVector **  inInfoVec,
vtkInformationVector outInfoVec,
int  requestFromOutputPort,
vtkMTimeType mtime 
)
overrideprotectedvirtual

A special version of ProcessRequest meant specifically for the pipeline modified time request.

See vtkExecutive::ComputePipelineMTime() for details.

Reimplemented from vtkAlgorithm.

◆ RequestData()

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

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

◆ ClipLines()

void vtkClipClosedSurface::ClipLines ( vtkPoints points,
vtkDoubleArray pointScalars,
vtkPointData pointData,
vtkCCSEdgeLocator *  edgeLocator,
vtkCellArray inputCells,
vtkCellArray outputLines,
vtkCellData inCellData,
vtkCellData outLineData 
)
protected

Method for clipping lines and copying the scalar data.

◆ ClipAndContourPolys()

void vtkClipClosedSurface::ClipAndContourPolys ( vtkPoints points,
vtkDoubleArray pointScalars,
vtkPointData pointData,
vtkCCSEdgeLocator *  edgeLocator,
int  triangulate,
vtkCellArray inputCells,
vtkCellArray outputPolys,
vtkCellArray outputLines,
vtkCellData inPolyData,
vtkCellData outPolyData,
vtkCellData outLineData 
)
protected

Clip and contour polys in one step, in order to guarantee that the contour lines exactly match the new free edges of the clipped polygons.

This exact correspondence is necessary in order to guarantee that the surface remains closed.

◆ InterpolateEdge()

static int vtkClipClosedSurface::InterpolateEdge ( vtkPoints points,
vtkPointData pointData,
vtkCCSEdgeLocator *  edgeLocator,
double  tol,
vtkIdType  i0,
vtkIdType  i1,
double  v0,
double  v1,
vtkIdType i 
)
staticprotected

A helper function for interpolating a new point along an edge.

It stores the index of the interpolated point in "i", and returns 1 if a new point was added to the points. The values i0, i1, v0, v1 are the edge enpoints and scalar values, respectively.

◆ TriangulatePolygon()

int vtkClipClosedSurface::TriangulatePolygon ( vtkIdList polygon,
vtkPoints points,
vtkCellArray triangles 
)
protected

A robust method for triangulating a polygon.

It cleans up the polygon and then applies the ear-cut method that is implemented in vtkPolygon. A zero return value indicates that triangulation failed.

◆ TriangulateContours()

void vtkClipClosedSurface::TriangulateContours ( vtkPolyData data,
vtkIdType  firstLine,
vtkIdType  numLines,
vtkCellArray outputPolys,
const double  normal[3] 
)
protected

Given some closed contour lines, create a triangle mesh that fills those lines.

The input lines must be single-segment lines, not polylines. The input lines do not have to be in order. Only lines from firstLine to will be used. Specify the normal of the clip plane, which will be opposite the normals of the polys that will be produced. If outCD has scalars, then color scalars will be added for each poly that is created.

◆ BreakPolylines()

static void vtkClipClosedSurface::BreakPolylines ( vtkCellArray inputLines,
vtkCellArray outputLines,
vtkUnsignedCharArray inputScalars,
vtkIdType  firstLineScalar,
vtkUnsignedCharArray outputScalars,
const unsigned char  color[3] 
)
staticprotected

Break polylines into individual lines, copying scalar values from inputScalars starting at firstLineScalar.

If inputScalars is zero, then scalars will be set to color. If scalars is zero, then no scalars will be generated.

◆ CopyPolygons()

static void vtkClipClosedSurface::CopyPolygons ( vtkCellArray inputPolys,
vtkCellArray outputPolys,
vtkUnsignedCharArray inputScalars,
vtkIdType  firstPolyScalar,
vtkUnsignedCharArray outputScalars,
const unsigned char  color[3] 
)
staticprotected

Copy polygons and their associated scalars to a new array.

If inputScalars is set to zero, set polyScalars to color instead. If polyScalars is set to zero, don't generate scalars.

◆ BreakTriangleStrips()

static void vtkClipClosedSurface::BreakTriangleStrips ( vtkCellArray inputStrips,
vtkCellArray outputPolys,
vtkUnsignedCharArray inputScalars,
vtkIdType  firstStripScalar,
vtkUnsignedCharArray outputScalars,
const unsigned char  color[3] 
)
staticprotected

Break triangle strips and add the triangles to the output.

See CopyPolygons for more information.

◆ SqueezeOutputPoints()

static void vtkClipClosedSurface::SqueezeOutputPoints ( vtkPolyData output,
vtkPoints points,
vtkPointData pointData,
int  outputPointDataType 
)
staticprotected

Squeeze the points and store them in the output.

Only the points that are used by the cells will be saved, and the pointIds of the cells will be modified.

◆ CreateColorValues()

static void vtkClipClosedSurface::CreateColorValues ( const double  color1[3],
const double  color2[3],
const double  color3[3],
unsigned char  colors[3][3] 
)
staticprotected

Take three colors as doubles, and convert to unsigned char.

Member Data Documentation

◆ ClippingPlanes

vtkPlaneCollection* vtkClipClosedSurface::ClippingPlanes
protected

Definition at line 209 of file vtkClipClosedSurface.h.

◆ Tolerance

double vtkClipClosedSurface::Tolerance
protected

Definition at line 211 of file vtkClipClosedSurface.h.

◆ PassPointData

vtkTypeBool vtkClipClosedSurface::PassPointData
protected

Definition at line 213 of file vtkClipClosedSurface.h.

◆ GenerateOutline

vtkTypeBool vtkClipClosedSurface::GenerateOutline
protected

Definition at line 214 of file vtkClipClosedSurface.h.

◆ GenerateFaces

vtkTypeBool vtkClipClosedSurface::GenerateFaces
protected

Definition at line 215 of file vtkClipClosedSurface.h.

◆ ActivePlaneId

int vtkClipClosedSurface::ActivePlaneId
protected

Definition at line 216 of file vtkClipClosedSurface.h.

◆ ScalarMode

int vtkClipClosedSurface::ScalarMode
protected

Definition at line 217 of file vtkClipClosedSurface.h.

◆ BaseColor

double vtkClipClosedSurface::BaseColor[3]
protected

Definition at line 218 of file vtkClipClosedSurface.h.

◆ ClipColor

double vtkClipClosedSurface::ClipColor[3]
protected

Definition at line 219 of file vtkClipClosedSurface.h.

◆ ActivePlaneColor

double vtkClipClosedSurface::ActivePlaneColor[3]
protected

Definition at line 220 of file vtkClipClosedSurface.h.

◆ TriangulationErrorDisplay

vtkTypeBool vtkClipClosedSurface::TriangulationErrorDisplay
protected

Definition at line 222 of file vtkClipClosedSurface.h.

◆ IdList

vtkIdList* vtkClipClosedSurface::IdList
protected

Definition at line 224 of file vtkClipClosedSurface.h.


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