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

#include <vtkClipClosedSurface.h>

Inheritance diagram for vtkClipClosedSurface:

Collaboration diagram for vtkClipClosedSurface:

Public Member Functions
vtkPolyData *	GetClipFaceOutput ()
	Return the clip face triangulated output.


virtual void	SetClippingPlanes (vtkPlaneCollection *planes)
	Set the vtkPlaneCollection that holds the clipping planes.

virtual vtkPlaneCollection *	GetClippingPlanes ()
	Set the vtkPlaneCollection that holds the clipping planes.


virtual void	SetTolerance (double)
	Set the tolerance for creating new points while clipping.

virtual double	GetTolerance ()
	Set the tolerance for creating new points while clipping.


virtual void	SetPassPointData (vtkTypeBool)
	Pass the point data to the output.

virtual void	PassPointDataOn ()
	Pass the point data to the output.

virtual void	PassPointDataOff ()
	Pass the point data to the output.

virtual vtkTypeBool	GetPassPointData ()
	Pass the point data to the output.


virtual void	SetGenerateOutline (vtkTypeBool)
	Set whether to generate an outline wherever an input face was cut by a plane.

virtual void	GenerateOutlineOn ()
	Set whether to generate an outline wherever an input face was cut by a plane.

virtual void	GenerateOutlineOff ()
	Set whether to generate an outline wherever an input face was cut by a plane.

virtual vtkTypeBool	GetGenerateOutline ()
	Set whether to generate an outline wherever an input face was cut by a plane.


virtual void	SetGenerateFaces (vtkTypeBool)
	Set whether to generate polygonal faces for the output.

virtual void	GenerateFacesOn ()
	Set whether to generate polygonal faces for the output.

virtual void	GenerateFacesOff ()
	Set whether to generate polygonal faces for the output.

virtual vtkTypeBool	GetGenerateFaces ()
	Set whether to generate polygonal faces for the output.


virtual void	SetScalarMode (int)
	Set whether to add cell scalars, so that new faces and outlines can be distinguished from original faces and lines.

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

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

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

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

const char *	GetScalarModeAsString ()
	Set whether to add cell scalars, so that new faces and outlines can be distinguished from original faces and lines.


virtual void	SetBaseColor (double, double, double)
	Set the color for all cells were part of the original geometry.

virtual void	SetBaseColor (double[3])
	Set the color for all cells were part of the original geometry.

virtual double *	GetBaseColor ()
	Set the color for all cells were part of the original geometry.

virtual void	GetBaseColor (double &, double &, double &)
	Set the color for all cells were part of the original geometry.

virtual void	GetBaseColor (double[3])
	Set the color for all cells were part of the original geometry.


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.

virtual void	SetClipColor (double[3])
	Set the color for any new geometry, either faces or outlines, that are created as a result of the clipping.

virtual double *	GetClipColor ()
	Set the color for any new geometry, either faces or outlines, that are created as a result of the clipping.

virtual void	GetClipColor (double &, double &, double &)
	Set the color for any new geometry, either faces or outlines, that are created as a result of the clipping.

virtual void	GetClipColor (double[3])
	Set the color for any new geometry, either faces or outlines, that are created as a result of the clipping.


virtual void	SetActivePlaneId (int)
	Set the active plane, so that the clipping from that plane can be displayed in a different color.

virtual int	GetActivePlaneId ()
	Set the active plane, so that the clipping from that plane can be displayed in a different color.


virtual void	SetActivePlaneColor (double, double, double)
	Set the color for any new geometry produced by clipping with the ActivePlane, if ActivePlaneId is set.

virtual void	SetActivePlaneColor (double[3])
	Set the color for any new geometry produced by clipping with the ActivePlane, if ActivePlaneId is set.

virtual double *	GetActivePlaneColor ()
	Set the color for any new geometry produced by clipping with the ActivePlane, if ActivePlaneId is set.

virtual void	GetActivePlaneColor (double &, double &, double &)
	Set the color for any new geometry produced by clipping with the ActivePlane, if ActivePlaneId is set.

virtual void	GetActivePlaneColor (double[3])
	Set the color for any new geometry produced by clipping with the ActivePlane, if ActivePlaneId is set.


virtual void	SetTriangulationErrorDisplay (vtkTypeBool)
	Generate errors when the triangulation fails.

virtual void	TriangulationErrorDisplayOn ()
	Generate errors when the triangulation fails.

virtual void	TriangulationErrorDisplayOff ()
	Generate errors when the triangulation fails.

virtual vtkTypeBool	GetTriangulationErrorDisplay ()
	Generate errors when the triangulation fails.


virtual void	SetInsideOut (vtkTypeBool)
	Set/Get the InsideOut flag.

virtual vtkTypeBool	GetInsideOut ()
	Set/Get the InsideOut flag.

virtual void	InsideOutOn ()
	Set/Get the InsideOut flag.

virtual void	InsideOutOff ()
	Set/Get the InsideOut flag.


virtual void	SetGenerateClipFaceOutput (vtkTypeBool)
	Control whether a second output is generated.

virtual vtkTypeBool	GetGenerateClipFaceOutput ()
	Control whether a second output is generated.

virtual void	GenerateClipFaceOutputOn ()
	Control whether a second output is generated.

virtual void	GenerateClipFaceOutputOff ()
	Control whether a second output is generated.

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.

vtkPolyDataAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkTypeBool	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	see vtkAlgorithm for details

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

vtkPolyData *	GetPolyDataInput (int port)

vtkPolyData *	GetOutput ()
	Get the output data object for a port on this algorithm.

vtkPolyData *	GetOutput (int)
	Get the output data object for a port on this algorithm.

virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm.

void	SetInputData (vtkDataObject *)
	Assign a data object as input.

void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.

void	AddInputData (vtkDataObject *)
	Assign a data object as input.

void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.

Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkTypeBool	HasExecutive ()
	Check whether this algorithm has an assigned executive.

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.

virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.

virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.

void	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.

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.

void	RemoveAllInputs ()
	Remove all the input data.

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.

virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).

virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual 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 vtkInformation *	GetInformation ()
	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.

vtkAlgorithm *	GetContainerAlgorithm ()
	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.

void	SetInputArrayToProcess (const char *name, int fieldAssociation)
	Set the input data arrays that this algorithm will process.

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	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	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 vtkProgressObserver *	GetProgressObserver ()
	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.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

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.

Protected Member Functions
	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.

int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	This is called by the superclass.

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.

void	ClipAndContourPolys (vtkPoints points, vtkDoubleArray pointScalars, vtkPointData pointData, vtkCCSEdgeLocator edgeLocator, int triangulate, vtkCellArray inputCells, vtkCellArray outputPolys, vtkCellArray outputLines, vtkCellData inCellData, 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.

int	TriangulatePolygon (vtkIdList polygon, vtkPoints points, vtkCellArray *triangles)
	A robust method for triangulating a polygon.

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.

Protected Member Functions inherited from vtkPolyDataAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () 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 vtkObjectBase *	NewInstanceInternal () 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.

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	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.

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.

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.

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.

static void	SqueezeOutputPoints (vtkPolyData output, vtkPoints points, vtkPointData *pointData, int outputPointDataType)
	Squeeze the points and store them in the output.

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.

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtkPlaneCollection *	ClippingPlanes

double	Tolerance

vtkTypeBool	PassPointData

vtkTypeBool	GenerateOutline

vtkTypeBool	GenerateFaces

int	ActivePlaneId

int	ScalarMode

double	BaseColor [3]

double	ClipColor [3]

double	ActivePlaneColor [3]

vtkTypeBool	InsideOut = false

vtkTypeBool	GenerateClipFaceOutput = false

vtkTypeBool	TriangulationErrorDisplay

vtkIdList *	IdList

Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp	LastAbortCheckTime

vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkPolyDataAlgorithm	Superclass
	Standard methods for instantiation, obtaining type information, and printing.

static vtkClipClosedSurface *	New ()
	Standard methods for instantiation, obtaining type information, and printing.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instantiation, obtaining type information, and printing.

static vtkClipClosedSurface *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instantiation, obtaining type information, and printing.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instantiation, obtaining type information, and printing.

vtkClipClosedSurface *	NewInstance () const
	Standard methods for instantiation, obtaining type information, and printing.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instantiation, obtaining type information, and printing.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instantiation, obtaining type information, and printing.

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

Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkPolyDataAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.

static vtkInformationIntegerKey *	ABORTED ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool >	AbortExecute

Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp	LastAbortTime

static vtkExecutive *	DefaultExecutivePrototype

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.

The orientation of the polygons that form the surface is important. Polygons have a front face and a back face, and it's the back face that defines the interior or "solid" region of the closed surface. When a clipping plane cuts through a "solid" region, a new cut face is generated, but not when a clipping plane cuts through a hole or "empty" region. This distinction is crucial when dealing with complex surfaces. Note that if a simple surface has its back faces pointing outwards, then that surface defines a hole in a potentially infinite solid.

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.

The InsideOut flag can be used to reverse the sense of what inside/outside the clip region means. This changes the which side of the clipping plane is clipped away.

This filter can be configured to compute a second output. The second output is the polygonal data with the new triangulated faces. Set the GenerateClipFaceOutput boolean on if you wish to access this output data.

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 vtkContourTriangulator

Thanks:: Thanks to David Gobbi for contributing this class to VTK.

Online Examples:

ClipClosedSurface

Tests:: vtkClipClosedSurface (Tests)

Definition at line 104 of file vtkClipClosedSurface.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPolyDataAlgorithm vtkClipClosedSurface::Superclass

Standard methods for instantiation, obtaining type information, and printing.

Definition at line 112 of file vtkClipClosedSurface.h.

Constructor & Destructor Documentation

◆ vtkClipClosedSurface()

vtkClipClosedSurface::vtkClipClosedSurface ( )

protected

◆ ~vtkClipClosedSurface()

vtkClipClosedSurface::~vtkClipClosedSurface ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkClipClosedSurface * vtkClipClosedSurface::New ( )

static

Standard methods for instantiation, obtaining type information, and printing.

◆ IsTypeOf()

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

static

Standard methods for instantiation, obtaining type information, and printing.

◆ IsA()

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

virtual

Standard methods for instantiation, obtaining type information, and printing.

Reimplemented from vtkPolyDataAlgorithm.

◆ SafeDownCast()

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

static

Standard methods for instantiation, obtaining type information, and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkClipClosedSurface::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instantiation, obtaining type information, and printing.

Reimplemented from vtkPolyDataAlgorithm.

◆ NewInstance()

vtkClipClosedSurface * vtkClipClosedSurface::NewInstance ( ) const

Standard methods for instantiation, obtaining type information, and printing.

◆ PrintSelf()

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

overridevirtual

Standard methods for instantiation, obtaining type information, and printing.

Reimplemented from vtkAlgorithm.

◆ SetClippingPlanes()

virtual void vtkClipClosedSurface::SetClippingPlanes ( vtkPlaneCollection * planes )

virtual

Set the vtkPlaneCollection that holds the clipping planes.

◆ GetClippingPlanes()

virtual vtkPlaneCollection * vtkClipClosedSurface::GetClippingPlanes ( )

virtual

Set the vtkPlaneCollection that holds the clipping planes.

◆ 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

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.

◆ 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

Pass the point data to the output.

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

◆ PassPointDataOff()

virtual void vtkClipClosedSurface::PassPointDataOff ( )

virtual

Pass the point data to the output.

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

◆ GetPassPointData()

virtual vtkTypeBool vtkClipClosedSurface::GetPassPointData ( )

virtual

Pass the point data to the output.

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

◆ 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

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

This is off by default.

◆ GenerateOutlineOff()

virtual void vtkClipClosedSurface::GenerateOutlineOff ( )

virtual

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

This is off by default.

◆ GetGenerateOutline()

virtual vtkTypeBool vtkClipClosedSurface::GetGenerateOutline ( )

virtual

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

This is off by default.

◆ 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

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.

◆ GenerateFacesOff()

virtual void vtkClipClosedSurface::GenerateFacesOff ( )

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.

◆ GetGenerateFaces()

virtual vtkTypeBool vtkClipClosedSurface::GetGenerateFaces ( )

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.

◆ 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

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".

Definition at line 175 of file vtkClipClosedSurface.h.

◆ SetScalarModeToColors()

void vtkClipClosedSurface::SetScalarModeToColors ( )

inline

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".

Definition at line 176 of file vtkClipClosedSurface.h.

◆ SetScalarModeToLabels()

void vtkClipClosedSurface::SetScalarModeToLabels ( )

inline

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".

Definition at line 177 of file vtkClipClosedSurface.h.

◆ GetScalarMode()

virtual int vtkClipClosedSurface::GetScalarMode ( )

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".

◆ GetScalarModeAsString()

const char * vtkClipClosedSurface::GetScalarModeAsString ( )

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".

◆ 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

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.

◆ GetBaseColor() [1/3]

virtual double * vtkClipClosedSurface::GetBaseColor ( )

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.

◆ GetBaseColor() [2/3]

virtual void vtkClipClosedSurface::GetBaseColor	(	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.

◆ GetBaseColor() [3/3]

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

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.

◆ 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

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.

◆ GetClipColor() [1/3]

virtual double * vtkClipClosedSurface::GetClipColor ( )

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.

◆ GetClipColor() [2/3]

virtual void vtkClipClosedSurface::GetClipColor	(	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.

◆ GetClipColor() [3/3]

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

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.

◆ 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

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.

◆ 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

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

Default is yellow. Requires SetScalarModeToColors.

◆ GetActivePlaneColor() [1/3]

virtual double * vtkClipClosedSurface::GetActivePlaneColor ( )

virtual

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

Default is yellow. Requires SetScalarModeToColors.

◆ GetActivePlaneColor() [2/3]

virtual void vtkClipClosedSurface::GetActivePlaneColor	(	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.

◆ GetActivePlaneColor() [3/3]

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

virtual

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

Default is yellow. Requires SetScalarModeToColors.

◆ 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

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.

◆ TriangulationErrorDisplayOff()

virtual void vtkClipClosedSurface::TriangulationErrorDisplayOff ( )

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.

◆ GetTriangulationErrorDisplay()

virtual vtkTypeBool vtkClipClosedSurface::GetTriangulationErrorDisplay ( )

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.

◆ SetInsideOut()

virtual void vtkClipClosedSurface::SetInsideOut ( vtkTypeBool )

virtual

Set/Get the InsideOut flag.

When off, a vertex is considered inside the implicit function if it lies in front of the clipping plane. When InsideOutside is turned on, a vertex is considered inside if it lies on the back side of the plane. InsideOut is off by default.

Note: Regardless of the InsideOut flag, it is not possible to generate an inside (that is, convex) corner by clipping.

◆ GetInsideOut()

virtual vtkTypeBool vtkClipClosedSurface::GetInsideOut ( )

virtual

Set/Get the InsideOut flag.

When off, a vertex is considered inside the implicit function if it lies in front of the clipping plane. When InsideOutside is turned on, a vertex is considered inside if it lies on the back side of the plane. InsideOut is off by default.

Note: Regardless of the InsideOut flag, it is not possible to generate an inside (that is, convex) corner by clipping.

◆ InsideOutOn()

virtual void vtkClipClosedSurface::InsideOutOn ( )

virtual

Set/Get the InsideOut flag.

When off, a vertex is considered inside the implicit function if it lies in front of the clipping plane. When InsideOutside is turned on, a vertex is considered inside if it lies on the back side of the plane. InsideOut is off by default.

Note: Regardless of the InsideOut flag, it is not possible to generate an inside (that is, convex) corner by clipping.

◆ InsideOutOff()

virtual void vtkClipClosedSurface::InsideOutOff ( )

virtual

Set/Get the InsideOut flag.

When off, a vertex is considered inside the implicit function if it lies in front of the clipping plane. When InsideOutside is turned on, a vertex is considered inside if it lies on the back side of the plane. InsideOut is off by default.

Note: Regardless of the InsideOut flag, it is not possible to generate an inside (that is, convex) corner by clipping.

◆ SetGenerateClipFaceOutput()

virtual void vtkClipClosedSurface::SetGenerateClipFaceOutput ( vtkTypeBool )

virtual

Control whether a second output is generated.

The second output contains the polygonal data that is generated at the clip face as a result of the triangulation. GenerateClipFaceOutput is off by default.

◆ GetGenerateClipFaceOutput()

virtual vtkTypeBool vtkClipClosedSurface::GetGenerateClipFaceOutput ( )

virtual

Control whether a second output is generated.

The second output contains the polygonal data that is generated at the clip face as a result of the triangulation. GenerateClipFaceOutput is off by default.

◆ GenerateClipFaceOutputOn()

virtual void vtkClipClosedSurface::GenerateClipFaceOutputOn ( )

virtual

Control whether a second output is generated.

The second output contains the polygonal data that is generated at the clip face as a result of the triangulation. GenerateClipFaceOutput is off by default.

◆ GenerateClipFaceOutputOff()

virtual void vtkClipClosedSurface::GenerateClipFaceOutputOff ( )

virtual

Control whether a second output is generated.

The second output contains the polygonal data that is generated at the clip face as a result of the triangulation. GenerateClipFaceOutput is off by default.

◆ GetClipFaceOutput()

vtkPolyData * vtkClipClosedSurface::GetClipFaceOutput ( )

Return the clip face triangulated output.

◆ 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 *	inCellData,
		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 endpoints 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 270 of file vtkClipClosedSurface.h.

◆ Tolerance

double vtkClipClosedSurface::Tolerance

protected

Definition at line 272 of file vtkClipClosedSurface.h.

◆ PassPointData

vtkTypeBool vtkClipClosedSurface::PassPointData

protected

Definition at line 274 of file vtkClipClosedSurface.h.

◆ GenerateOutline

vtkTypeBool vtkClipClosedSurface::GenerateOutline

protected

Definition at line 275 of file vtkClipClosedSurface.h.

◆ GenerateFaces

vtkTypeBool vtkClipClosedSurface::GenerateFaces

protected

Definition at line 276 of file vtkClipClosedSurface.h.

◆ ActivePlaneId

int vtkClipClosedSurface::ActivePlaneId

protected

Definition at line 277 of file vtkClipClosedSurface.h.

◆ ScalarMode

int vtkClipClosedSurface::ScalarMode

protected

Definition at line 278 of file vtkClipClosedSurface.h.

◆ BaseColor

double vtkClipClosedSurface::BaseColor[3]

protected

Definition at line 279 of file vtkClipClosedSurface.h.

◆ ClipColor

double vtkClipClosedSurface::ClipColor[3]

protected

Definition at line 280 of file vtkClipClosedSurface.h.

◆ ActivePlaneColor

double vtkClipClosedSurface::ActivePlaneColor[3]

protected

Definition at line 281 of file vtkClipClosedSurface.h.

◆ InsideOut

vtkTypeBool vtkClipClosedSurface::InsideOut = false

protected

Definition at line 282 of file vtkClipClosedSurface.h.

◆ GenerateClipFaceOutput

vtkTypeBool vtkClipClosedSurface::GenerateClipFaceOutput = false

protected

Definition at line 283 of file vtkClipClosedSurface.h.

◆ TriangulationErrorDisplay

vtkTypeBool vtkClipClosedSurface::TriangulationErrorDisplay

protected

Definition at line 285 of file vtkClipClosedSurface.h.

◆ IdList

vtkIdList* vtkClipClosedSurface::IdList

protected

Definition at line 287 of file vtkClipClosedSurface.h.

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

Filters/General/vtkClipClosedSurface.h

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkClipClosedSurface()

◆ ~vtkClipClosedSurface()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetClippingPlanes()

◆ GetClippingPlanes()

◆ SetTolerance()

◆ GetTolerance()

◆ SetPassPointData()

◆ PassPointDataOn()

◆ PassPointDataOff()

◆ GetPassPointData()

◆ SetGenerateOutline()

◆ GenerateOutlineOn()

◆ GenerateOutlineOff()

◆ GetGenerateOutline()

◆ SetGenerateFaces()

◆ GenerateFacesOn()

◆ GenerateFacesOff()

◆ GetGenerateFaces()

◆ SetScalarMode()

◆ SetScalarModeToNone()

◆ SetScalarModeToColors()

◆ SetScalarModeToLabels()

◆ GetScalarMode()

◆ GetScalarModeAsString()

◆ SetBaseColor() [1/2]

◆ SetBaseColor() [2/2]

◆ GetBaseColor() [1/3]

◆ GetBaseColor() [2/3]

◆ GetBaseColor() [3/3]

◆ SetClipColor() [1/2]

◆ SetClipColor() [2/2]

◆ GetClipColor() [1/3]

◆ GetClipColor() [2/3]

◆ GetClipColor() [3/3]

◆ SetActivePlaneId()

◆ GetActivePlaneId()

◆ SetActivePlaneColor() [1/2]

◆ SetActivePlaneColor() [2/2]

◆ GetActivePlaneColor() [1/3]

◆ GetActivePlaneColor() [2/3]

◆ GetActivePlaneColor() [3/3]

◆ SetTriangulationErrorDisplay()

◆ TriangulationErrorDisplayOn()

◆ TriangulationErrorDisplayOff()

◆ GetTriangulationErrorDisplay()

◆ SetInsideOut()

◆ GetInsideOut()

◆ InsideOutOn()

◆ InsideOutOff()

◆ SetGenerateClipFaceOutput()

◆ GetGenerateClipFaceOutput()

◆ GenerateClipFaceOutputOn()

◆ GenerateClipFaceOutputOff()

◆ GetClipFaceOutput()

◆ ComputePipelineMTime()

◆ RequestData()

◆ ClipLines()

◆ ClipAndContourPolys()

◆ InterpolateEdge()

◆ TriangulatePolygon()

◆ TriangulateContours()

◆ BreakPolylines()

◆ CopyPolygons()