vtkSelectEnclosedPoints Class Reference

mark points as to whether they are inside a closed surface More...

#include <vtkSelectEnclosedPoints.h>

Inheritance diagram for vtkSelectEnclosedPoints:

Collaboration diagram for vtkSelectEnclosedPoints:

Public Member Functions
int	IsInside (vtkIdType inputPtId)
	Query an input point id as to whether it is inside or outside.
void	SetSurfaceData (vtkPolyData *pd)
	Set the surface to be used to test for containment.
void	SetSurfaceConnection (vtkAlgorithmOutput *algOutput)
	Set the surface to be used to test for containment.
vtkPolyData *	GetSurface ()
	Return a pointer to the enclosing surface.
vtkPolyData *	GetSurface (vtkInformationVector *sourceInfo)
	Return a pointer to the enclosing surface.
virtual void	SetInsideOut (vtkTypeBool)
	By default, points inside the surface are marked inside or sent to the output.
virtual void	InsideOutOn ()
	By default, points inside the surface are marked inside or sent to the output.
virtual void	InsideOutOff ()
	By default, points inside the surface are marked inside or sent to the output.
virtual vtkTypeBool	GetInsideOut ()
	By default, points inside the surface are marked inside or sent to the output.
virtual void	SetCheckSurface (vtkTypeBool)
	Specify whether to check the surface for closure.
virtual void	CheckSurfaceOn ()
	Specify whether to check the surface for closure.
virtual void	CheckSurfaceOff ()
	Specify whether to check the surface for closure.
virtual vtkTypeBool	GetCheckSurface ()
	Specify whether to check the surface for closure.
virtual void	SetTolerance (double)
	Specify the tolerance on the intersection.
virtual double	GetTolerance ()
	Specify the tolerance on the intersection.
void	Initialize (vtkPolyData *surface)
	This is a backdoor that can be used to test many points for containment.
int	IsInsideSurface (double x[3])
	This is a backdoor that can be used to test many points for containment.
int	IsInsideSurface (double x, double y, double z)
	This is a backdoor that can be used to test many points for containment.
void	Complete ()
	This is a backdoor that can be used to test many points for containment.
Public Member Functions inherited from vtkDataSetAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkDataSetAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkDataObject *	GetInput ()
	Get the input data object.
vtkPolyData *	GetPolyDataOutput ()
	Get the output as vtkPolyData.
vtkStructuredPoints *	GetStructuredPointsOutput ()
	Get the output as vtkStructuredPoints.
vtkImageData *	GetImageDataOutput ()
	Get the output as vtkStructuredPoints.
vtkStructuredGrid *	GetStructuredGridOutput ()
	Get the output as vtkStructuredGrid.
vtkUnstructuredGrid *	GetUnstructuredGridOutput ()
	Get the output as vtkUnstructuredGrid.
vtkRectilinearGrid *	GetRectilinearGridOutput ()
	Get the output as vtkRectilinearGrid.
vtkTypeBool	ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
	see vtkAlgorithm for details
vtkDataSet *	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkDataSet *	GetOutput (int)
	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	SetInputData (vtkDataSet *)
	Assign a data object as input.
void	SetInputData (int, vtkDataSet *)
	Assign a data object as input.
void	AddInputData (vtkDataObject *)
	Assign a data object as input.
void	AddInputData (vtkDataSet *)
	Assign a data object as input.
void	AddInputData (int, vtkDataSet *)
	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 vtkSelectEnclosedPoints *	New ()
	Instantiate this class.
static int	IsInsideSurface (double x[3], vtkPolyData *surface, double bds[6], double length, double tol, vtkAbstractCellLocator *locator, vtkIdList *cellIds, vtkGenericCell *genCell, vtkIntersectionCounter &counter, vtkRandomPool *poole=nullptr, vtkIdType seqIdx=0)
	A static method for determining whether a point is inside a surface.
static int	IsSurfaceClosed (vtkPolyData *surface)
	A static method for determining whether a surface is closed.
Static Public Member Functions inherited from vtkDataSetAlgorithm
static vtkDataSetAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkDataSetAlgorithm *	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
	vtkSelectEnclosedPoints ()
	~vtkSelectEnclosedPoints () override
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	This is called within ProcessRequest when a request asks the algorithm to do its work.
int	FillInputPortInformation (int, vtkInformation *) override
	Fill the input port information objects for this algorithm.
void	ReportReferences (vtkGarbageCollector *) override
Protected Member Functions inherited from vtkDataSetAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkDataSetAlgorithm ()
	~vtkDataSetAlgorithm () override=default
virtual int	RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	This is called within ProcessRequest when a request asks the algorithm to create empty output data objects.
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	This is called within ProcessRequest when a request asks for Information.
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for.
virtual int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	This is called within ProcessRequest when a request asks the algorithm to do its work.
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.
vtkDataObject *	GetInput (int port)
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
vtkTypeBool	CheckSurface
vtkTypeBool	InsideOut
double	Tolerance
vtkUnsignedCharArray *	InsideOutsideArray
vtkStaticCellLocator *	CellLocator
vtkIdList *	CellIds
vtkGenericCell *	Cell
vtkPolyData *	Surface
double	Bounds [6]
double	Length
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
typedef vtkDataSetAlgorithm	Superclass
	Standard methods for type information and printing.
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for type information and printing.
static vtkSelectEnclosedPoints *	SafeDownCast (vtkObjectBase *o)
	Standard methods for type information and printing.
virtual vtkTypeBool	IsA (const char *type)
	Standard methods for type information and printing.
vtkSelectEnclosedPoints *	NewInstance () const
	Standard methods for type information and printing.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for type information and printing.
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for type information and printing.

Additional Inherited Members
Public Types inherited from vtkDataSetAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...
typedef vtkObject	Superclass
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

mark points as to whether they are inside a closed surface

vtkSelectEnclosedPoints is a filter that evaluates all the input points to determine whether they are in an enclosed surface. The filter produces a (0,1) mask (in the form of a vtkDataArray) that indicates whether points are outside (mask value=0) or inside (mask value=1) a provided surface. (The name of the output vtkDataArray is "SelectedPoints".)

After running the filter, it is possible to query it as to whether a point is inside/outside by invoking the IsInside(ptId) method.

Warning

The filter assumes that the surface is closed and manifold. A boolean flag can be set to force the filter to first check whether this is true. If false, all points will be marked outside. Note that if this check is not performed and the surface is not closed, the results are undefined.

This filter produces and output data array, but does not modify the input dataset. If you wish to extract cells or points, various threshold filters are available (i.e., threshold the output array). Also, see the filter vtkExtractEnclosedPoints which operates on point clouds.

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

vtkMaskPoints vtkExtractEnclosedPoints

Online Examples:

Game

CellsInsideObject

PointInsideObject

Definition at line 102 of file vtkSelectEnclosedPoints.h.

Member Typedef Documentation

Superclass

typedef vtkDataSetAlgorithm vtkSelectEnclosedPoints::Superclass

Standard methods for type information and printing.

Definition at line 109 of file vtkSelectEnclosedPoints.h.

Constructor & Destructor Documentation

vtkSelectEnclosedPoints()

vtkSelectEnclosedPoints::vtkSelectEnclosedPoints ( )

protected

~vtkSelectEnclosedPoints()

vtkSelectEnclosedPoints::~vtkSelectEnclosedPoints ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

Standard methods for type information and printing.

IsA()

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

virtual

Standard methods for type information and printing.

Reimplemented from vtkDataSetAlgorithm.

SafeDownCast()

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

static

Standard methods for type information and printing.

NewInstanceInternal()

virtual vtkObjectBase * vtkSelectEnclosedPoints::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for type information and printing.

Reimplemented from vtkDataSetAlgorithm.

NewInstance()

vtkSelectEnclosedPoints * vtkSelectEnclosedPoints::NewInstance

(

)

const

Standard methods for type information and printing.

PrintSelf()

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

overridevirtual

Standard methods for type information and printing.

Reimplemented from vtkDataSetAlgorithm.

New()

static vtkSelectEnclosedPoints * vtkSelectEnclosedPoints::New ( )

static

Instantiate this class.

SetSurfaceData()

void vtkSelectEnclosedPoints::SetSurfaceData

(

vtkPolyData *

pd

)

Set the surface to be used to test for containment.

Two methods are provided: one directly for vtkPolyData, and one for the output of a filter.

SetSurfaceConnection()

void vtkSelectEnclosedPoints::SetSurfaceConnection

(

vtkAlgorithmOutput *

algOutput

)

Set the surface to be used to test for containment.

Two methods are provided: one directly for vtkPolyData, and one for the output of a filter.

GetSurface() [1/2]

vtkPolyData * vtkSelectEnclosedPoints::GetSurface

(

)

Return a pointer to the enclosing surface.

GetSurface() [2/2]

vtkPolyData * vtkSelectEnclosedPoints::GetSurface

(

vtkInformationVector *

sourceInfo

)

Return a pointer to the enclosing surface.

SetInsideOut()

virtual void vtkSelectEnclosedPoints::SetInsideOut ( vtkTypeBool  )

virtual

By default, points inside the surface are marked inside or sent to the output.

If InsideOut is on, then the points outside the surface are marked inside.

InsideOutOn()

virtual void vtkSelectEnclosedPoints::InsideOutOn ( )

virtual

By default, points inside the surface are marked inside or sent to the output.

If InsideOut is on, then the points outside the surface are marked inside.

InsideOutOff()

virtual void vtkSelectEnclosedPoints::InsideOutOff ( )

virtual

By default, points inside the surface are marked inside or sent to the output.

If InsideOut is on, then the points outside the surface are marked inside.

GetInsideOut()

virtual vtkTypeBool vtkSelectEnclosedPoints::GetInsideOut ( )

virtual

By default, points inside the surface are marked inside or sent to the output.

If InsideOut is on, then the points outside the surface are marked inside.

SetCheckSurface()

virtual void vtkSelectEnclosedPoints::SetCheckSurface ( vtkTypeBool  )

virtual

Specify whether to check the surface for closure.

If on, then the algorithm first checks to see if the surface is closed and manifold.

CheckSurfaceOn()

virtual void vtkSelectEnclosedPoints::CheckSurfaceOn ( )

virtual

Specify whether to check the surface for closure.

If on, then the algorithm first checks to see if the surface is closed and manifold.

CheckSurfaceOff()

virtual void vtkSelectEnclosedPoints::CheckSurfaceOff ( )

virtual

Specify whether to check the surface for closure.

If on, then the algorithm first checks to see if the surface is closed and manifold.

GetCheckSurface()

virtual vtkTypeBool vtkSelectEnclosedPoints::GetCheckSurface ( )

virtual

Specify whether to check the surface for closure.

If on, then the algorithm first checks to see if the surface is closed and manifold.

IsInside()

int vtkSelectEnclosedPoints::IsInside

(

vtkIdType

inputPtId

)

Query an input point id as to whether it is inside or outside.

Note that the result requires that the filter execute first.

SetTolerance()

virtual void vtkSelectEnclosedPoints::SetTolerance ( double  )

virtual

Specify the tolerance on the intersection.

The tolerance is expressed as a fraction of the diagonal of the bounding box of the enclosing surface.

GetTolerance()

virtual double vtkSelectEnclosedPoints::GetTolerance ( )

virtual

Specify the tolerance on the intersection.

The tolerance is expressed as a fraction of the diagonal of the bounding box of the enclosing surface.

Initialize()

void vtkSelectEnclosedPoints::Initialize

(

vtkPolyData *

surface

)

This is a backdoor that can be used to test many points for containment.

First initialize the instance, then repeated calls to IsInsideSurface() can be used without rebuilding the search structures. The Complete() method releases memory.

IsInsideSurface() [1/3]

int vtkSelectEnclosedPoints::IsInsideSurface

(

double

x[3]

)

This is a backdoor that can be used to test many points for containment.

First initialize the instance, then repeated calls to IsInsideSurface() can be used without rebuilding the search structures. The Complete() method releases memory.

IsInsideSurface() [2/3]

int vtkSelectEnclosedPoints::IsInsideSurface	(	double	x,
		double	y,
		double	z
	)

This is a backdoor that can be used to test many points for containment.

First initialize the instance, then repeated calls to IsInsideSurface() can be used without rebuilding the search structures. The Complete() method releases memory.

Complete()

void vtkSelectEnclosedPoints::Complete

(

)

This is a backdoor that can be used to test many points for containment.

First initialize the instance, then repeated calls to IsInsideSurface() can be used without rebuilding the search structures. The Complete() method releases memory.

IsInsideSurface() [3/3]

static int vtkSelectEnclosedPoints::IsInsideSurface ( double  x[3], vtkPolyData *  surface, double  bds[6], double  length, double  tol, vtkAbstractCellLocator *  locator, vtkIdList *  cellIds, vtkGenericCell *  genCell, vtkIntersectionCounter &  counter, vtkRandomPool *  poole = nullptr, vtkIdType  seqIdx = 0  )

static

A static method for determining whether a point is inside a surface.

This is the heart of the algorithm and is thread safe. The user must provide an input point x, the enclosing surface, the bounds of the enclosing surface, the diagonal length of the enclosing surface, an intersection tolerance, a cell locator for the surface, and two working objects (cellIds, genCell) to support computation. Finally, in threaded execution, generating random numbers is hard, so a precomputed random sequence can be provided with an index into the sequence.

IsSurfaceClosed()

static int vtkSelectEnclosedPoints::IsSurfaceClosed ( vtkPolyData *  surface )

static

A static method for determining whether a surface is closed.

Provide as input a vtkPolyData. The method returns >0 is the surface is closed and manifold.

RequestData()

int vtkSelectEnclosedPoints::RequestData ( vtkInformation *  , vtkInformationVector **  , vtkInformationVector *    )

overrideprotectedvirtual

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

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

Reimplemented from vtkDataSetAlgorithm.

FillInputPortInformation()

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

overrideprotectedvirtual

Fill the input port information objects for this algorithm.

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

Reimplemented from vtkDataSetAlgorithm.

ReportReferences()

void vtkSelectEnclosedPoints::ReportReferences ( vtkGarbageCollector *  )

overrideprotectedvirtual

Reimplemented from vtkAlgorithm.

Member Data Documentation

CheckSurface

vtkTypeBool vtkSelectEnclosedPoints::CheckSurface

protected

Definition at line 209 of file vtkSelectEnclosedPoints.h.

InsideOut

vtkTypeBool vtkSelectEnclosedPoints::InsideOut

protected

Definition at line 210 of file vtkSelectEnclosedPoints.h.

Tolerance

double vtkSelectEnclosedPoints::Tolerance

protected

Definition at line 211 of file vtkSelectEnclosedPoints.h.

InsideOutsideArray

vtkUnsignedCharArray* vtkSelectEnclosedPoints::InsideOutsideArray

protected

Definition at line 213 of file vtkSelectEnclosedPoints.h.

CellLocator

vtkStaticCellLocator* vtkSelectEnclosedPoints::CellLocator

protected

Definition at line 216 of file vtkSelectEnclosedPoints.h.

CellIds

vtkIdList* vtkSelectEnclosedPoints::CellIds

protected

Definition at line 217 of file vtkSelectEnclosedPoints.h.

Cell

vtkGenericCell* vtkSelectEnclosedPoints::Cell

protected

Definition at line 218 of file vtkSelectEnclosedPoints.h.

Surface

vtkPolyData* vtkSelectEnclosedPoints::Surface

protected

Definition at line 219 of file vtkSelectEnclosedPoints.h.

Bounds

double vtkSelectEnclosedPoints::Bounds[6]

protected

Definition at line 220 of file vtkSelectEnclosedPoints.h.

Length

double vtkSelectEnclosedPoints::Length

protected

Definition at line 221 of file vtkSelectEnclosedPoints.h.

---

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

• Filters/Modeling/vtkSelectEnclosedPoints.h