Imprint the contact surface of one object onto another surface. More...

#include <vtkImprintFilter.h>

Inheritance diagram for vtkImprintFilter:

Collaboration diagram for vtkImprintFilter:

Public Types
enum	MergeTolType { ABSOLUTE_TOLERANCE = 0 , RELATIVE_TO_PROJECTION_TOLERANCE = 1 , RELATIVE_TO_MIN_EDGE_LENGTH = 2 , RELATIVE_TO_AVERAGE_EDGE_LENGTH = 3 }

enum	ToleranceStrategy { DECOUPLED_TOLERANCES = 0 , LINKED_TOLERANCES = 1 }

enum	SpecifiedOutput { TARGET_CELLS = 0 , IMPRINTED_CELLS = 1 , PROJECTED_IMPRINT = 2 , IMPRINTED_REGION = 3 , MERGED_IMPRINT = 5 }

enum	PointInterpolationType { USE_TARGET_EDGES = 0 , USE_IMPRINT_EDGES = 1 }

enum	DebugOutput { NO_DEBUG_OUTPUT = 0 , TRIANGULATION_INPUT = 1 , TRIANGULATION_OUTPUT = 2 }

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
void	SetTargetConnection (vtkAlgorithmOutput *algOutput)
	Specify the first vtkPolyData input connection which defines the surface mesh to imprint (i.e., the target).

vtkAlgorithmOutput *	GetTargetConnection ()

void	SetImprintConnection (vtkAlgorithmOutput *algOutput)
	Specify the a second vtkPolyData input connection which defines the surface mesh with which to imprint the target (the target is provided by the first input).

vtkAlgorithmOutput *	GetImprintConnection ()


void	SetTargetData (vtkDataObject *target)
	Specify the first vtkPolyData input which defines the surface mesh to imprint (i.e., the taregt).

vtkDataObject *	GetTarget ()
	Specify the first vtkPolyData input which defines the surface mesh to imprint (i.e., the taregt).


void	SetImprintData (vtkDataObject *imprint)
	Specify the a second vtkPolyData input which defines the surface mesh with which to imprint the target (i.e., the first input).

vtkDataObject *	GetImprint ()
	Specify the a second vtkPolyData input which defines the surface mesh with which to imprint the target (i.e., the first input).


virtual void	SetTolerance (double)
	Specify a projection tolerance which controls how close the imprint surface must be to the target to successfully imprint the surface.

virtual double	GetTolerance ()
	Specify a projection tolerance which controls how close the imprint surface must be to the target to successfully imprint the surface.


virtual void	SetMergeToleranceType (int)
	Specify a tolerance which is used to determine whether two points are considered coincident to one another.

virtual int	GetMergeToleranceType ()
	Specify a tolerance which is used to determine whether two points are considered coincident to one another.

void	SetMergeToleranceTypeToAbsolute ()
	Specify a tolerance which is used to determine whether two points are considered coincident to one another.

void	SetMergeToleranceTypeToRelativeToProjection ()
	Specify a tolerance which is used to determine whether two points are considered coincident to one another.

void	SetMergeToleranceTypeToMinEdge ()
	Specify a tolerance which is used to determine whether two points are considered coincident to one another.

void	SetMergeToleranceTypeToAverageEdge ()
	Specify a tolerance which is used to determine whether two points are considered coincident to one another.

virtual void	SetMergeTolerance (double)
	Specify a tolerance which is used to determine whether two points are considered coincident to one another.

virtual double	GetMergeTolerance ()
	Specify a tolerance which is used to determine whether two points are considered coincident to one another.


virtual void	SetToleranceStrategy (int)
	Specify the relationship between the merge tolerance and the projection tolerance.

virtual int	GetToleranceStrategy ()
	Specify the relationship between the merge tolerance and the projection tolerance.

void	SetToleranceStrategyToDecoupled ()
	Specify the relationship between the merge tolerance and the projection tolerance.

void	SetToleranceStrategyToLinked ()
	Specify the relationship between the merge tolerance and the projection tolerance.


virtual void	SetOutputType (int)
	Control what is output by the filter.

virtual int	GetOutputType ()
	Control what is output by the filter.

void	SetOutputTypeToTargetCells ()
	Control what is output by the filter.

void	SetOutputTypeToImprintedCells ()
	Control what is output by the filter.

void	SetOutputTypeToProjectedImprint ()
	Control what is output by the filter.

void	SetOutputTypeToImprintedRegion ()
	Control what is output by the filter.

void	SetOutputTypeToMergedImprint ()
	Control what is output by the filter.


virtual void	SetBoundaryEdgeInsertion (bool)
	Indicate whether to insert just the boundary edges of the imprint mesh (i.e., do not insert the interior edges).

virtual bool	GetBoundaryEdgeInsertion ()
	Indicate whether to insert just the boundary edges of the imprint mesh (i.e., do not insert the interior edges).

virtual void	BoundaryEdgeInsertionOn ()
	Indicate whether to insert just the boundary edges of the imprint mesh (i.e., do not insert the interior edges).

virtual void	BoundaryEdgeInsertionOff ()
	Indicate whether to insert just the boundary edges of the imprint mesh (i.e., do not insert the interior edges).


virtual void	SetPassCellData (bool)
	Indicate whether cell data from the input target is to be passed through to the output mesh.

virtual bool	GetPassCellData ()
	Indicate whether cell data from the input target is to be passed through to the output mesh.

virtual void	PassCellDataOn ()
	Indicate whether cell data from the input target is to be passed through to the output mesh.

virtual void	PassCellDataOff ()
	Indicate whether cell data from the input target is to be passed through to the output mesh.


virtual void	SetPassPointData (bool)
	Indicate whether point data from the input target mesh and the imprint mesh are to be passed through and/or interpolated to the output mesh.

virtual bool	GetPassPointData ()
	Indicate whether point data from the input target mesh and the imprint mesh are to be passed through and/or interpolated to the output mesh.

virtual void	PassPointDataOn ()
	Indicate whether point data from the input target mesh and the imprint mesh are to be passed through and/or interpolated to the output mesh.

virtual void	PassPointDataOff ()
	Indicate whether point data from the input target mesh and the imprint mesh are to be passed through and/or interpolated to the output mesh.


virtual void	SetPointInterpolation (int)
	If PassPointData is on, indicate how new point data is to generated at the intersection points between the input target mesh edges and the imprint edges By default, PointInterpolation is set to USE_TARGET_EDGES.

virtual int	GetPointInterpolation ()
	If PassPointData is on, indicate how new point data is to generated at the intersection points between the input target mesh edges and the imprint edges By default, PointInterpolation is set to USE_TARGET_EDGES.

void	SetPointInterpolationToTargetEdges ()
	If PassPointData is on, indicate how new point data is to generated at the intersection points between the input target mesh edges and the imprint edges By default, PointInterpolation is set to USE_TARGET_EDGES.

void	SetPointInterpolationToImprintEdges ()
	If PassPointData is on, indicate how new point data is to generated at the intersection points between the input target mesh edges and the imprint edges By default, PointInterpolation is set to USE_TARGET_EDGES.


virtual void	SetTriangulateOutput (bool)
	Indicate whether the output should be triangulated.

virtual bool	GetTriangulateOutput ()
	Indicate whether the output should be triangulated.

virtual void	TriangulateOutputOn ()
	Indicate whether the output should be triangulated.

virtual void	TriangulateOutputOff ()
	Indicate whether the output should be triangulated.


virtual void	SetDebugOutputType (int)
	The following methods support debugging.

virtual int	GetDebugOutputType ()
	The following methods support debugging.

void	SetDebugOutputTypeToNoDebugOutput ()
	The following methods support debugging.

void	SetDebugOutputTypeToTriangulationInput ()
	The following methods support debugging.

void	SetDebugOutputTypeToTriangulationOutput ()
	The following methods support debugging.

virtual void	SetDebugCellId (vtkIdType)
	The following methods support debugging.

virtual vtkIdType	GetDebugCellId ()
	The following methods support debugging.

vtkPolyData *	GetDebugOutput ()
	Get the output data (in the second output, if the DebugOutput != NO_DEBUG_OUTPUT).

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.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess().

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

void	RemoveAllInputs ()
	Remove all the input data.

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

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

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

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

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

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

virtual void	SetInputDataObject (vtkDataObject *data)

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

virtual void	AddInputDataObject (vtkDataObject *data)

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

vtkAlgorithmOutput *	GetOutputPort ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual VTK_UNBLOCKTHREADS void	Update (int port)
	Bring this algorithm's outputs up-to-date.

virtual VTK_UNBLOCKTHREADS void	Update ()
	Bring this algorithm's outputs up-to-date.

virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports.

virtual vtkTypeBool	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

virtual 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
	vtkImprintFilter ()

	~vtkImprintFilter () override

double	ComputeMergeTolerance (vtkPolyData *pdata)

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

int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called by the superclass.

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 &)

Protected Attributes
double	Tolerance

double	MergeTolerance

int	MergeToleranceType

int	ToleranceStrategy

int	OutputType

bool	BoundaryEdgeInsertion

bool	TriangulateOutput

bool	PassCellData

bool	PassPointData

int	PointInterpolation

int	DebugOutputType

vtkIdType	DebugCellId

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 to instantiate, print and provide type information.

static vtkImprintFilter *	New ()
	Standard methods to instantiate, print and provide type information.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods to instantiate, print and provide type information.

static vtkImprintFilter *	SafeDownCast (vtkObjectBase *o)
	Standard methods to instantiate, print and provide type information.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods to instantiate, print and provide type information.

vtkImprintFilter *	NewInstance () const
	Standard methods to instantiate, print and provide type information.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods to instantiate, print and provide type information.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods to instantiate, print and provide type information.

Additional Inherited Members
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 Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp	LastAbortTime

static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Imprint the contact surface of one object onto another surface.

This filter imprints the contact surface of one vtkPolyData mesh onto a second, input vtkPolyData mesh. There are two inputs to the filter: the target, which is the surface to be imprinted, and the imprint, which is the object imprinting the target.

A high level overview of the algorithm is as follows. 1) The target cells are segregated into two subsets: those that may intersect the imprint surface (the candidate cells determined by bounding box checks), and those that do not. 2) The non-candidates are sent to the output, the candidate intersection cells are further processed - eventually they will be triangulated as a result of contact with the imprint, with the result of the triangulation appended to the output. 3) The imprint points are projected onto the candidate cells, determining a classification (on a target point, on a target edge, interior to a target cell, outside the target). 4) The non-outside imprint points are associated with one or more target cells. 5) The imprint edges are intersected with the target cell edges, producing additional points associated with the the candidate cells, as well as "fragments" or portions of edges associated with the candidate target cells. 6) On a per-candidate-target-cell basis, the points and edge fragments associated with that cell are used to triangulate the cell. 7) Finally, the triangulated target cells are appended to the output.

Several options exist to specify how to produce an output cell data array that indicates whether the output cells are in the imprinted area. If enabled, this output vtkSignedCharArray will have a value=1 for cells that are in the imprinted area. Otherwise, the value=0 is indicating the cell is not in contact with the imprinted area. The name of this cell data array is "ImprintedCells".

The filter also has the option to pass through and generate point and cell data. If PassCellData is enabled, then the cell data associated with the cropped cells, or cells passed through from the input mesh, are passed through to the output. If PassPointData is enabled, then in similar fashion the point data is passed through; however new points generated by intersection may have point data interpolated in one of two ways. First, the target mesh edges are interpolated at the new intersection points to generate point data, or the imprint edges are interpolated at the new intersection points to generate point data. Note: for PassPointData and point interpolation to function, the filter requires that the point data attributes (from the target mesh and imprint mesh) are exactly the same. If they are not, then a set intersection operation is performed that uses the point data arrays common to both the target and imprint meshes.

Some notes: – The algorithm assumes that the input target and imprint cells are convex. – If performing a PROJECTED_IMPRINT, the output is the imprint mesh with the point coordinates modified by projecting the imprint points onto the target. If the projection of an imprint point onto the target is unsuccessful, the imprint point coordinates are not modified. – If performing a MERGED_IMPRINT, the number of output points is (numTargetPts + numImprintPts + numEdgeIntPts). – Not all of the output points may be used, for example if an imprint point is coincident (within the tolerance) of a target point, the target point replaces the imprint point. – Candidate cells which may reside within the bounding box of the imprint but may not actually intersect the imprint will be appended to the output without triangulation. – Candidate cells that are intersected will be triangulated: i.e., triangles will be produced and appended to the output. – Triangulation requires combining the points and edge fragments associated with each target candidate cell, as well as the candidate cell's defining points and edges, to produce the final triangulation. – Portions of the algorithm are SMP threaded. For example, steps #1 and #2 (candidate segregation); point projection step #3; cell triangulation step #6. Future implementations may further parallelize the algorithm. – The algorithm produces an output cell data array that indicates which output cells are in the imprinted area. This vtkSignedCharArray has a value=0 for cells that were originally target cells; a value=2 for output cells that are in the imprinted region; and a value=1 for cells that are in the transition region (between target and imprinted cells). The name of this cell data array is "ImprintedCells".

Tests:: vtkImprintFilter (Tests)

Definition at line 93 of file vtkImprintFilter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPolyDataAlgorithm vtkImprintFilter::Superclass

Standard methods to instantiate, print and provide type information.

Definition at line 101 of file vtkImprintFilter.h.

Member Enumeration Documentation

◆ MergeTolType

enum vtkImprintFilter::MergeTolType

Enumerator
ABSOLUTE_TOLERANCE
RELATIVE_TO_PROJECTION_TOLERANCE
RELATIVE_TO_MIN_EDGE_LENGTH
RELATIVE_TO_AVERAGE_EDGE_LENGTH

Definition at line 156 of file vtkImprintFilter.h.

◆ ToleranceStrategy

enum vtkImprintFilter::ToleranceStrategy

Enumerator
DECOUPLED_TOLERANCES
LINKED_TOLERANCES

Definition at line 195 of file vtkImprintFilter.h.

◆ SpecifiedOutput

enum vtkImprintFilter::SpecifiedOutput

Enumerator
TARGET_CELLS
IMPRINTED_CELLS
PROJECTED_IMPRINT
IMPRINTED_REGION
MERGED_IMPRINT

Definition at line 215 of file vtkImprintFilter.h.

◆ PointInterpolationType

enum vtkImprintFilter::PointInterpolationType

Enumerator
USE_TARGET_EDGES
USE_IMPRINT_EDGES

Definition at line 284 of file vtkImprintFilter.h.

◆ DebugOutput

enum vtkImprintFilter::DebugOutput

Enumerator
NO_DEBUG_OUTPUT
TRIANGULATION_INPUT
TRIANGULATION_OUTPUT

Definition at line 302 of file vtkImprintFilter.h.

Constructor & Destructor Documentation

◆ vtkImprintFilter()

vtkImprintFilter::vtkImprintFilter ( )

protected

◆ ~vtkImprintFilter()

vtkImprintFilter::~vtkImprintFilter ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkImprintFilter * vtkImprintFilter::New ( )

static

Standard methods to instantiate, print and provide type information.

◆ IsTypeOf()

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

static

Standard methods to instantiate, print and provide type information.

◆ IsA()

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

virtual

Standard methods to instantiate, print and provide type information.

Reimplemented from vtkPolyDataAlgorithm.

◆ SafeDownCast()

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

static

Standard methods to instantiate, print and provide type information.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkImprintFilter::NewInstanceInternal ( ) const

protectedvirtual

Standard methods to instantiate, print and provide type information.

Reimplemented from vtkPolyDataAlgorithm.

◆ NewInstance()

vtkImprintFilter * vtkImprintFilter::NewInstance ( ) const

Standard methods to instantiate, print and provide type information.

◆ PrintSelf()

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

overridevirtual

Standard methods to instantiate, print and provide type information.

Reimplemented from vtkAlgorithm.

◆ SetTargetConnection()

void vtkImprintFilter::SetTargetConnection ( vtkAlgorithmOutput * algOutput )

Specify the first vtkPolyData input connection which defines the surface mesh to imprint (i.e., the target).

◆ GetTargetConnection()

vtkAlgorithmOutput * vtkImprintFilter::GetTargetConnection ( )

◆ SetTargetData()

void vtkImprintFilter::SetTargetData ( vtkDataObject * target )

Specify the first vtkPolyData input which defines the surface mesh to imprint (i.e., the taregt).

The imprint surface is provided by the second input.

◆ GetTarget()

vtkDataObject * vtkImprintFilter::GetTarget ( )

Specify the first vtkPolyData input which defines the surface mesh to imprint (i.e., the taregt).

The imprint surface is provided by the second input.

◆ SetImprintConnection()

void vtkImprintFilter::SetImprintConnection ( vtkAlgorithmOutput * algOutput )

Specify the a second vtkPolyData input connection which defines the surface mesh with which to imprint the target (the target is provided by the first input).

◆ GetImprintConnection()

vtkAlgorithmOutput * vtkImprintFilter::GetImprintConnection ( )

◆ SetImprintData()

void vtkImprintFilter::SetImprintData ( vtkDataObject * imprint )

Specify the a second vtkPolyData input which defines the surface mesh with which to imprint the target (i.e., the first input).

◆ GetImprint()

vtkDataObject * vtkImprintFilter::GetImprint ( )

Specify the a second vtkPolyData input which defines the surface mesh with which to imprint the target (i.e., the first input).

◆ SetTolerance()

virtual void vtkImprintFilter::SetTolerance ( double )

virtual

Specify a projection tolerance which controls how close the imprint surface must be to the target to successfully imprint the surface.

This is an absolute value.

◆ GetTolerance()

virtual double vtkImprintFilter::GetTolerance ( )

virtual

Specify a projection tolerance which controls how close the imprint surface must be to the target to successfully imprint the surface.

This is an absolute value.

◆ SetMergeToleranceType()

virtual void vtkImprintFilter::SetMergeToleranceType ( int )

virtual

Specify a tolerance which is used to determine whether two points are considered coincident to one another.