vtkTrimmedExtrusionFilter Class Reference

extrude polygonal data trimmed by a second input surface More...

#include <vtkTrimmedExtrusionFilter.h>

Inheritance diagram for vtkTrimmedExtrusionFilter:

Collaboration diagram for vtkTrimmedExtrusionFilter:

Public Types
enum	ExtrusionStrategy { BOUNDARY_EDGES = 0 , ALL_EDGES = 1 }
enum	CappingStrategy { INTERSECTION = 0 , MINIMUM_DISTANCE = 1 , MAXIMUM_DISTANCE = 2 , AVERAGE_DISTANCE = 3 }
typedef vtkPolyDataAlgorithm	Superclass
Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkTrimmedExtrusionFilter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	SetExtrusionDirection (double, double, double)
	Set/Get the extrusion direction.
virtual void	SetExtrusionDirection (double[3])
	Set/Get the extrusion direction.
virtual double *	GetExtrusionDirection ()
	Set/Get the extrusion direction.
virtual void	GetExtrusionDirection (double data[3])
	Set/Get the extrusion direction.
void	SetTrimSurfaceData (vtkPolyData *pd)
	Specify the surface which trims the surface.
void	SetTrimSurfaceConnection (vtkAlgorithmOutput *algOutput)
	Specify the surface which trims the surface.
vtkPolyData *	GetTrimSurface ()
	Return a pointer to the enclosing surface.
vtkPolyData *	GetTrimSurface (vtkInformationVector *sourceInfo)
	Return a pointer to the enclosing surface.
virtual void	SetCapping (int)
	Turn on/off the capping of the extruded skirt.
virtual int	GetCapping ()
	Turn on/off the capping of the extruded skirt.
virtual void	CappingOn ()
	Turn on/off the capping of the extruded skirt.
virtual void	CappingOff ()
	Turn on/off the capping of the extruded skirt.
virtual void	SetExtrusionStrategy (int)
	Specify a strategy for extrusion.
virtual int	GetExtrusionStrategy ()
	Specify a strategy for extrusion.
void	SetExtrusionStrategyToBoundaryEdges ()
	Specify a strategy for extrusion.
void	SetExtrusionStrategyToAllEdges ()
	Specify a strategy for extrusion.
virtual void	SetCappingStrategy (int)
	Specify a strategy for capping.
virtual int	GetCappingStrategy ()
	Specify a strategy for capping.
void	SetCappingStrategyToIntersection ()
	Specify a strategy for capping.
void	SetCappingStrategyToMinimumDistance ()
	Specify a strategy for capping.
void	SetCappingStrategyToMaximumDistance ()
	Specify a strategy for capping.
void	SetCappingStrategyToAverageDistance ()
	Specify a strategy for capping.
void	SetLocator (vtkAbstractCellLocator *locator)
	Specify a cell locator.
virtual vtkAbstractCellLocator *	GetLocator ()
	Specify a cell locator.
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.
int	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	SetProgress (double)
	SetProgress is deprecated.
void	UpdateProgress (double amount)
	Update the progress of the process object.
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 int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual 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 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.
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.
void	Register (vtkObjectBase *o) override
	Participate in garbage collection.
void	UnRegister (vtkObjectBase *o) 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	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 void	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual void	Update ()
	Bring this algorithm's outputs up-to-date.
virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports.
virtual int	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.
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
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.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkTrimmedExtrusionFilter *	SafeDownCast (vtkObjectBase *o)
static vtkTrimmedExtrusionFilter *	New ()
	Create object with extrusion direction (0,0,1) and capping on.
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 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 (int 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 int	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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkTrimmedExtrusionFilter ()
	~vtkTrimmedExtrusionFilter () override
void	AdjustPoints (vtkPolyData *mesh, vtkIdType numPts, vtkIdType numCells, unsigned char *hots, vtkPoints *newPts)
void	ExtrudeEdges (vtkPolyData *input, vtkPolyData *output, vtkIdType numPts, vtkIdType numCells)
vtkIdType	GetNeighborCount (vtkPolyData *mesh, vtkIdType inCellId, vtkIdType p1, vtkIdType p2, vtkIdList *cellIds)
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	This is called by the superclass.
int	FillInputPortInformation (int, vtkInformation *) override
	Fill the input port information objects for this algorithm.
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.
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
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 assocition 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 *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
int	Capping
double	ExtrusionDirection [3]
int	ExtrusionStrategy
int	CappingStrategy
vtkAbstractCellLocator *	Locator
Protected Attributes inherited from vtkAlgorithm
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
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
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 vtkExecutive *	DefaultExecutivePrototype

Detailed Description

extrude polygonal data trimmed by a second input surface

vtkTrimmedExtrusionFilter is a modeling filter. It takes polygonal data as input and generates polygonal data on output. The input dataset is swept along a specified direction forming a "skirt" from the boundary edges 2D primitives (i.e., edges used by only one polygon); and/or from vertices and lines. The extent of the sweeping is limited by a second input: defined where the sweep intersects a user-specified surface.

Capping of the extrusion can be enabled. In this case the input, generating primitive is copied inplace as well as to the end of the extrusion skirt. (See warnings below on what happens if the intersecting sweep does not intersect, or partially intersects the trim surface.)

Note that this filter operates in two fundamentally different modes based on the extrusion strategy. If the strategy is BOUNDARY_EDGES, then only the boundary edges of the input's 2D primitives are extruded (verts and lines are extruded to generate lines and quads). However, if the extrusions strategy is ALL_EDGES, then every edge of the 2D primitives is used to sweep out a quadrilateral polygon (again verts and lines are swept to produce lines and quads).

Warning

The extrusion direction is assumed to define an infinite line. The intersection with the trim surface is along a ray from the - to + direction, however only the first intersection is taken.

Some polygonal objects have no free edges (e.g., sphere). When swept, this will result in two separate surfaces if capping is on and BOUNDARY_EDGES enabled, or no surface if capping is off and BOUNDARY_EDGES is enabled.

If all the extrusion lines emanating from an extruding primitive do not intersect the trim surface, then no output for that primitive will be generated. In extreme cases, it it possible that no output whatsoever will be generated by the filter.

This class has been threaded with vtkSMPTools. Using TBB or other non-sequential type (set in the CMake variable VTK_SMP_IMPLEMENTATION_TYPE) may improve performance significantly.

See also

vtkLinearExtrusionFilter vtkRotationalExtrusionFilter

Definition at line 72 of file vtkTrimmedExtrusionFilter.h.

Member Typedef Documentation

Superclass

typedef vtkPolyDataAlgorithm vtkTrimmedExtrusionFilter::Superclass

Definition at line 75 of file vtkTrimmedExtrusionFilter.h.

Member Enumeration Documentation

ExtrusionStrategy

enum vtkTrimmedExtrusionFilter::ExtrusionStrategy

Enumerator
BOUNDARY_EDGES
ALL_EDGES

Definition at line 121 of file vtkTrimmedExtrusionFilter.h.

CappingStrategy

enum vtkTrimmedExtrusionFilter::CappingStrategy

Enumerator
INTERSECTION
MINIMUM_DISTANCE
MAXIMUM_DISTANCE
AVERAGE_DISTANCE

Definition at line 144 of file vtkTrimmedExtrusionFilter.h.

Constructor & Destructor Documentation

vtkTrimmedExtrusionFilter()

vtkTrimmedExtrusionFilter::vtkTrimmedExtrusionFilter ( )

protected

~vtkTrimmedExtrusionFilter()

vtkTrimmedExtrusionFilter::~vtkTrimmedExtrusionFilter ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

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

virtual

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

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

Reimplemented from vtkPolyDataAlgorithm.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkTrimmedExtrusionFilter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

NewInstance()

vtkTrimmedExtrusionFilter * vtkTrimmedExtrusionFilter::NewInstance

(

)

const

PrintSelf()

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

overridevirtual

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

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

Reimplemented from vtkPolyDataAlgorithm.

New()

static vtkTrimmedExtrusionFilter * vtkTrimmedExtrusionFilter::New ( )

static

Create object with extrusion direction (0,0,1) and capping on.

SetExtrusionDirection() [1/2]

virtual void vtkTrimmedExtrusionFilter::SetExtrusionDirection ( double  , double  , double    )

virtual

Set/Get the extrusion direction.

SetExtrusionDirection() [2/2]

virtual void vtkTrimmedExtrusionFilter::SetExtrusionDirection ( double  [3] )

virtual

Set/Get the extrusion direction.

GetExtrusionDirection() [1/2]

virtual double * vtkTrimmedExtrusionFilter::GetExtrusionDirection ( )

virtual

Set/Get the extrusion direction.

GetExtrusionDirection() [2/2]

virtual void vtkTrimmedExtrusionFilter::GetExtrusionDirection ( double  data[3] )

virtual

Set/Get the extrusion direction.

SetTrimSurfaceData()

void vtkTrimmedExtrusionFilter::SetTrimSurfaceData

(

vtkPolyData *

pd

)

Specify the surface which trims the surface.

Note that the method SetTrimSurfaceData does not connect the pipeline. The algorithm will work on the input data as it is without updating the producer of the data. The method SetTrimSurfaceConnection connects the pipeline.

SetTrimSurfaceConnection()

void vtkTrimmedExtrusionFilter::SetTrimSurfaceConnection

(

vtkAlgorithmOutput *

algOutput

)

Specify the surface which trims the surface.

Note that the method SetTrimSurfaceData does not connect the pipeline. The algorithm will work on the input data as it is without updating the producer of the data. The method SetTrimSurfaceConnection connects the pipeline.

GetTrimSurface() [1/2]

vtkPolyData * vtkTrimmedExtrusionFilter::GetTrimSurface

(

)

Return a pointer to the enclosing surface.

GetTrimSurface() [2/2]

vtkPolyData * vtkTrimmedExtrusionFilter::GetTrimSurface

(

vtkInformationVector *

sourceInfo

)

Return a pointer to the enclosing surface.

SetCapping()

virtual void vtkTrimmedExtrusionFilter::SetCapping ( int  )

virtual

Turn on/off the capping of the extruded skirt.

GetCapping()

virtual int vtkTrimmedExtrusionFilter::GetCapping ( )

virtual

Turn on/off the capping of the extruded skirt.

CappingOn()

virtual void vtkTrimmedExtrusionFilter::CappingOn ( )

virtual

Turn on/off the capping of the extruded skirt.

CappingOff()

virtual void vtkTrimmedExtrusionFilter::CappingOff ( )

virtual

Turn on/off the capping of the extruded skirt.

SetExtrusionStrategy()

virtual void vtkTrimmedExtrusionFilter::SetExtrusionStrategy ( int  )

virtual

Specify a strategy for extrusion.

If the strategy is set to "BOUNDARY_EDGES" then the boundary edges of the input polygons and triangle strips are swept. (A boundary edge is an edge used by only one 2D primitive, e.g., polygon or triangle.) Alternatively, all edges can be swept. (This is particularly useful when only sinple disconnected polygons exist in the input and so boundary calculation can be avoided.) By default boundary edges are extruded.

GetExtrusionStrategy()

virtual int vtkTrimmedExtrusionFilter::GetExtrusionStrategy ( )

virtual

Specify a strategy for extrusion.

If the strategy is set to "BOUNDARY_EDGES" then the boundary edges of the input polygons and triangle strips are swept. (A boundary edge is an edge used by only one 2D primitive, e.g., polygon or triangle.) Alternatively, all edges can be swept. (This is particularly useful when only sinple disconnected polygons exist in the input and so boundary calculation can be avoided.) By default boundary edges are extruded.

SetExtrusionStrategyToBoundaryEdges()

void vtkTrimmedExtrusionFilter::SetExtrusionStrategyToBoundaryEdges ( )

inline

Specify a strategy for extrusion.

If the strategy is set to "BOUNDARY_EDGES" then the boundary edges of the input polygons and triangle strips are swept. (A boundary edge is an edge used by only one 2D primitive, e.g., polygon or triangle.) Alternatively, all edges can be swept. (This is particularly useful when only sinple disconnected polygons exist in the input and so boundary calculation can be avoided.) By default boundary edges are extruded.

Definition at line 139 of file vtkTrimmedExtrusionFilter.h.

SetExtrusionStrategyToAllEdges()

void vtkTrimmedExtrusionFilter::SetExtrusionStrategyToAllEdges ( )

inline

Specify a strategy for extrusion.

If the strategy is set to "BOUNDARY_EDGES" then the boundary edges of the input polygons and triangle strips are swept. (A boundary edge is an edge used by only one 2D primitive, e.g., polygon or triangle.) Alternatively, all edges can be swept. (This is particularly useful when only sinple disconnected polygons exist in the input and so boundary calculation can be avoided.) By default boundary edges are extruded.

Definition at line 140 of file vtkTrimmedExtrusionFilter.h.

SetCappingStrategy()

virtual void vtkTrimmedExtrusionFilter::SetCappingStrategy ( int  )

virtual

Specify a strategy for capping.

By default the points of the cap polygons are located where the extrusion intersects the capping surface. However, to preserve planarity, or to place the capping surface at the average/minimum/maximum distance of extrusion, different strategies can be used. By default the average distance is used.

Note if none of the extrusion rays intersect the trim surface, then capping is not performed, nor is an extrusion skirt sent to the output. Also note that if the capping strategy is set to INTERSECTION, and one of the extrusion rays of the generating primitive does not intersect the trim surface, then no output will be generated for that primitive. However if any other capping strategy is used, capping will succeed if at least one extrusion ray strikes the trim surface (although missed extrusion ray intersections will not factor into the determination of final cap location).

Finally, note that any capping strategy other than INTERSECTION may produce more points than expected because the output primitives may have to be "split apart" to satisy the capping constraint.

GetCappingStrategy()

virtual int vtkTrimmedExtrusionFilter::GetCappingStrategy ( )

virtual

Specify a strategy for capping.

By default the points of the cap polygons are located where the extrusion intersects the capping surface. However, to preserve planarity, or to place the capping surface at the average/minimum/maximum distance of extrusion, different strategies can be used. By default the average distance is used.

Note if none of the extrusion rays intersect the trim surface, then capping is not performed, nor is an extrusion skirt sent to the output. Also note that if the capping strategy is set to INTERSECTION, and one of the extrusion rays of the generating primitive does not intersect the trim surface, then no output will be generated for that primitive. However if any other capping strategy is used, capping will succeed if at least one extrusion ray strikes the trim surface (although missed extrusion ray intersections will not factor into the determination of final cap location).

Finally, note that any capping strategy other than INTERSECTION may produce more points than expected because the output primitives may have to be "split apart" to satisy the capping constraint.

SetCappingStrategyToIntersection()

void vtkTrimmedExtrusionFilter::SetCappingStrategyToIntersection ( )

inline

Specify a strategy for capping.

By default the points of the cap polygons are located where the extrusion intersects the capping surface. However, to preserve planarity, or to place the capping surface at the average/minimum/maximum distance of extrusion, different strategies can be used. By default the average distance is used.

Note if none of the extrusion rays intersect the trim surface, then capping is not performed, nor is an extrusion skirt sent to the output. Also note that if the capping strategy is set to INTERSECTION, and one of the extrusion rays of the generating primitive does not intersect the trim surface, then no output will be generated for that primitive. However if any other capping strategy is used, capping will succeed if at least one extrusion ray strikes the trim surface (although missed extrusion ray intersections will not factor into the determination of final cap location).

Finally, note that any capping strategy other than INTERSECTION may produce more points than expected because the output primitives may have to be "split apart" to satisy the capping constraint.

Definition at line 176 of file vtkTrimmedExtrusionFilter.h.

SetCappingStrategyToMinimumDistance()

void vtkTrimmedExtrusionFilter::SetCappingStrategyToMinimumDistance ( )

inline

Specify a strategy for capping.

By default the points of the cap polygons are located where the extrusion intersects the capping surface. However, to preserve planarity, or to place the capping surface at the average/minimum/maximum distance of extrusion, different strategies can be used. By default the average distance is used.

Note if none of the extrusion rays intersect the trim surface, then capping is not performed, nor is an extrusion skirt sent to the output. Also note that if the capping strategy is set to INTERSECTION, and one of the extrusion rays of the generating primitive does not intersect the trim surface, then no output will be generated for that primitive. However if any other capping strategy is used, capping will succeed if at least one extrusion ray strikes the trim surface (although missed extrusion ray intersections will not factor into the determination of final cap location).

Finally, note that any capping strategy other than INTERSECTION may produce more points than expected because the output primitives may have to be "split apart" to satisy the capping constraint.

Definition at line 177 of file vtkTrimmedExtrusionFilter.h.

SetCappingStrategyToMaximumDistance()

void vtkTrimmedExtrusionFilter::SetCappingStrategyToMaximumDistance ( )

inline

Specify a strategy for capping.

By default the points of the cap polygons are located where the extrusion intersects the capping surface. However, to preserve planarity, or to place the capping surface at the average/minimum/maximum distance of extrusion, different strategies can be used. By default the average distance is used.

Note if none of the extrusion rays intersect the trim surface, then capping is not performed, nor is an extrusion skirt sent to the output. Also note that if the capping strategy is set to INTERSECTION, and one of the extrusion rays of the generating primitive does not intersect the trim surface, then no output will be generated for that primitive. However if any other capping strategy is used, capping will succeed if at least one extrusion ray strikes the trim surface (although missed extrusion ray intersections will not factor into the determination of final cap location).

Finally, note that any capping strategy other than INTERSECTION may produce more points than expected because the output primitives may have to be "split apart" to satisy the capping constraint.

Definition at line 178 of file vtkTrimmedExtrusionFilter.h.

SetCappingStrategyToAverageDistance()

void vtkTrimmedExtrusionFilter::SetCappingStrategyToAverageDistance ( )

inline

Specify a strategy for capping.

By default the points of the cap polygons are located where the extrusion intersects the capping surface. However, to preserve planarity, or to place the capping surface at the average/minimum/maximum distance of extrusion, different strategies can be used. By default the average distance is used.

Note if none of the extrusion rays intersect the trim surface, then capping is not performed, nor is an extrusion skirt sent to the output. Also note that if the capping strategy is set to INTERSECTION, and one of the extrusion rays of the generating primitive does not intersect the trim surface, then no output will be generated for that primitive. However if any other capping strategy is used, capping will succeed if at least one extrusion ray strikes the trim surface (although missed extrusion ray intersections will not factor into the determination of final cap location).

Finally, note that any capping strategy other than INTERSECTION may produce more points than expected because the output primitives may have to be "split apart" to satisy the capping constraint.

Definition at line 179 of file vtkTrimmedExtrusionFilter.h.

SetLocator()

void vtkTrimmedExtrusionFilter::SetLocator

(

vtkAbstractCellLocator *

locator

)

Specify a cell locator.

By default a vtkStaticCellLocator is used. The locator performs efficient searches to intersect cells.

GetLocator()

virtual vtkAbstractCellLocator * vtkTrimmedExtrusionFilter::GetLocator ( )

virtual

Specify a cell locator.

By default a vtkStaticCellLocator is used. The locator performs efficient searches to intersect cells.

AdjustPoints()

void vtkTrimmedExtrusionFilter::AdjustPoints ( vtkPolyData *  mesh, vtkIdType  numPts, vtkIdType  numCells, unsigned char *  hots, vtkPoints *  newPts  )

protected

ExtrudeEdges()

void vtkTrimmedExtrusionFilter::ExtrudeEdges ( vtkPolyData *  input, vtkPolyData *  output, vtkIdType  numPts, vtkIdType  numCells  )

protected

GetNeighborCount()

vtkIdType vtkTrimmedExtrusionFilter::GetNeighborCount ( vtkPolyData *  mesh, vtkIdType  inCellId, vtkIdType  p1, vtkIdType  p2, vtkIdList *  cellIds  )

protected

RequestData()

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

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

FillInputPortInformation()

int vtkTrimmedExtrusionFilter::FillInputPortInformation ( int  port, vtkInformation *  info  )

overrideprotectedvirtual

Fill the input port information objects for this algorithm.

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

Reimplemented from vtkPolyDataAlgorithm.

Member Data Documentation

Capping

int vtkTrimmedExtrusionFilter::Capping

protected

Definition at line 195 of file vtkTrimmedExtrusionFilter.h.

ExtrusionDirection

double vtkTrimmedExtrusionFilter::ExtrusionDirection[3]

protected

Definition at line 196 of file vtkTrimmedExtrusionFilter.h.

ExtrusionStrategy

int vtkTrimmedExtrusionFilter::ExtrusionStrategy

protected

Definition at line 197 of file vtkTrimmedExtrusionFilter.h.

CappingStrategy

int vtkTrimmedExtrusionFilter::CappingStrategy

protected

Definition at line 198 of file vtkTrimmedExtrusionFilter.h.

Locator

vtkAbstractCellLocator* vtkTrimmedExtrusionFilter::Locator

protected

Definition at line 199 of file vtkTrimmedExtrusionFilter.h.

---

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

• Filters/Modeling/vtkTrimmedExtrusionFilter.h