vtkGenericClip Class Reference

clip any dataset with an implicit function or scalar data More...

#include <vtkGenericClip.h>

Inheritance diagram for vtkGenericClip:

Collaboration diagram for vtkGenericClip:

Public Types
typedef vtkUnstructuredGridAlgorithm	Superclass
Public Types inherited from vtkUnstructuredGridAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkGenericClip *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	CreateDefaultLocator ()
unsigned long	GetMTime ()
virtual void	SetValue (double)
virtual double	GetValue ()
virtual void	SetInsideOut (int)
virtual int	GetInsideOut ()
virtual void	InsideOutOn ()
virtual void	InsideOutOff ()
virtual void	SetClipFunction (vtkImplicitFunction *)
virtual vtkImplicitFunction *	GetClipFunction ()
virtual void	SetGenerateClipScalars (int)
virtual int	GetGenerateClipScalars ()
virtual void	GenerateClipScalarsOn ()
virtual void	GenerateClipScalarsOff ()
virtual void	SetGenerateClippedOutput (int)
virtual int	GetGenerateClippedOutput ()
virtual void	GenerateClippedOutputOn ()
virtual void	GenerateClippedOutputOff ()
virtual void	SetMergeTolerance (double)
virtual double	GetMergeTolerance ()
vtkUnstructuredGrid *	GetClippedOutput ()
virtual int	GetNumberOfOutputs ()
void	SetLocator (vtkIncrementalPointLocator *locator)
virtual vtkIncrementalPointLocator *	GetLocator ()
virtual char *	GetInputScalarsSelection ()
void	SelectInputScalars (const char *fieldName)
Public Member Functions inherited from vtkUnstructuredGridAlgorithm
vtkUnstructuredGridAlgorithm *	NewInstance () const
vtkDataObject *	GetInput (int port)
vtkDataObject *	GetInput ()
vtkUnstructuredGrid *	GetUnstructuredGridInput (int port)
vtkUnstructuredGrid *	GetOutput ()
vtkUnstructuredGrid *	GetOutput (int)
virtual void	SetOutput (vtkDataObject *d)
virtual int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void	SetInputData (vtkDataObject *)
void	SetInputData (int, vtkDataObject *)
void	AddInputData (vtkDataObject *)
void	AddInputData (int, vtkDataObject *)
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
int	HasExecutive ()
vtkExecutive *	GetExecutive ()
virtual void	SetExecutive (vtkExecutive *executive)
virtual int	ModifyRequest (vtkInformation *request, int when)
vtkInformation *	GetInputPortInformation (int port)
vtkInformation *	GetOutputPortInformation (int port)
int	GetNumberOfInputPorts ()
int	GetNumberOfOutputPorts ()
void	UpdateProgress (double amount)
vtkInformation *	GetInputArrayInformation (int idx)
void	RemoveAllInputs ()
vtkDataObject *	GetOutputDataObject (int port)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	RemoveInputConnection (int port, int idx)
virtual void	RemoveAllInputConnections (int port)
int	GetNumberOfInputConnections (int port)
int	GetTotalNumberOfInputConnections ()
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
vtkExecutive *	GetInputExecutive (int port, int index)
vtkInformation *	GetInputInformation (int port, int index)
vtkInformation *	GetOutputInformation (int port)
virtual void	UpdateInformation ()
virtual void	UpdateDataObject ()
virtual void	PropagateUpdateExtent ()
virtual void	UpdateWholeExtent ()
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
int	SetUpdateExtentToWholeExtent (int port)
int	SetUpdateExtentToWholeExtent ()
void	SetUpdateExtent (int port, int extent[6])
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
virtual void	SetAbortExecute (int)
virtual int	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual void	SetProgress (double)
virtual double	GetProgress ()
void	SetProgressText (const char *ptext)
virtual char *	GetProgressText ()
virtual unsigned long	GetErrorCode ()
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObject *	GetInputDataObject (int port, int connection)
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
virtual void	SetInputDataObject (int port, vtkDataObject *data)
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
vtkAlgorithm *	GetInputAlgorithm ()
vtkExecutive *	GetInputExecutive ()
vtkInformation *	GetInputInformation ()
virtual void	Update (int port)
virtual void	Update ()
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int extent[6])
int *	GetUpdateExtent ()
int *	GetUpdateExtent (int port)
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int extent[6])
void	GetUpdateExtent (int port, int extent[6])
int	GetUpdatePiece ()
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
virtual vtkProgressObserver *	GetProgressObserver ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkGenericClip *	SafeDownCast (vtkObjectBase *o)
static vtkGenericClip *	New ()
Static Public Member Functions inherited from vtkUnstructuredGridAlgorithm
static vtkUnstructuredGridAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkUnstructuredGridAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
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 ()
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkGenericClip (vtkImplicitFunction *cf=NULL)
	~vtkGenericClip ()
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int	FillInputPortInformation (int, vtkInformation *)
virtual void	SetInputScalarsSelection (const char *)
Protected Member Functions inherited from vtkUnstructuredGridAlgorithm
	vtkUnstructuredGridAlgorithm ()
	~vtkUnstructuredGridAlgorithm ()
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm ()
virtual void	SetNumberOfInputPorts (int n)
virtual void	SetNumberOfOutputPorts (int n)
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutive *	CreateDefaultExecutive ()
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	SetNumberOfInputConnections (int port, int n)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
void	SetInputDataInternal (int port, vtkDataObject *input)
void	AddInputDataInternal (int port, vtkDataObject *input)
virtual void	SetErrorCode (unsigned long)
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkImplicitFunction *	ClipFunction
vtkIncrementalPointLocator *	Locator
int	InsideOut
double	Value
int	GenerateClipScalars
int	GenerateClippedOutput
double	MergeTolerance
char *	InputScalarsSelection
vtkPointData *	InternalPD
vtkPointData *	SecondaryPD
vtkCellData *	SecondaryCD
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

clip any dataset with an implicit function or scalar data

vtkGenericClip is a filter that any type of dataset using either any subclass of vtkImplicitFunction, or the input scalar data. Clipping means that it actually "cuts" through the cells of the dataset, returning everything inside of the specified implicit function (or greater than the scalar value) including "pieces" of a cell. (Compare this with vtkExtractGeometry, which pulls out entire, uncut cells.) The output of this filter is an unstructured grid.

To use this filter, you must decide if you will be clipping with an implicit function, or whether you will be using the input scalar data. If you want to clip with an implicit function, you must: 1) define an implicit function 2) set it with the SetClipFunction method 3) apply the GenerateClipScalarsOn method If a ClipFunction is not specified, or GenerateClipScalars is off (the default), then the input's scalar data will be used to clip the polydata.

You can also specify a scalar value, which is used to decide what is inside and outside of the implicit function. You can also reverse the sense of what inside/outside is by setting the InsideOut instance variable. (The clipping algorithm proceeds by computing an implicit function value or using the input scalar data for each point in the dataset. This is compared to the scalar value to determine inside/outside.)

This filter can be configured to compute a second output. The second output is the part of the cell that is clipped away. Set the GenerateClippedData boolean on if you wish to access this output data.

This filter has been implemented to operate on generic datasets, rather than the typical vtkDataSet (and subclasses). vtkGenericDataSet is a more complex cousin of vtkDataSet, typically consisting of nonlinear, higher-order cells. To process this type of data, generic cells are automatically tessellated into linear cells prior to isocontouring.

See also

vtkClipDataSet vtkClipPolyData vtkClipVolume vtkImplicitFunction vtkGenericDataSet

Tests:

vtkGenericClip (Tests)

Definition at line 75 of file vtkGenericClip.h.

Member Typedef Documentation

typedef vtkUnstructuredGridAlgorithm vtkGenericClip::Superclass

Definition at line 78 of file vtkGenericClip.h.

Constructor & Destructor Documentation

vtkGenericClip::vtkGenericClip ( vtkImplicitFunction *  cf = NULL )

protected

vtkGenericClip::~vtkGenericClip ( )

protected

Member Function Documentation

static int vtkGenericClip::IsTypeOf ( const char *  type )

static

virtual int vtkGenericClip::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 vtkUnstructuredGridAlgorithm.

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

static

virtual vtkObjectBase* vtkGenericClip::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkUnstructuredGridAlgorithm.

vtkGenericClip* vtkGenericClip::NewInstance

(

)

const

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

virtual

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

static vtkGenericClip* vtkGenericClip::New ( )

static

Construct with user-specified implicit function; InsideOut turned off; value set to 0.0; and generate clip scalars turned off.

virtual void vtkGenericClip::SetValue ( double  )

virtual

Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars). The default value is 0.0.

virtual double vtkGenericClip::GetValue ( )

virtual

Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars). The default value is 0.0.

virtual void vtkGenericClip::SetInsideOut ( int  )

virtual

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off by default.

virtual int vtkGenericClip::GetInsideOut ( )

virtual

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off by default.

virtual void vtkGenericClip::InsideOutOn ( )

virtual

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off by default.

virtual void vtkGenericClip::InsideOutOff ( )

virtual

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off by default.

virtual void vtkGenericClip::SetClipFunction ( vtkImplicitFunction *  )

virtual

Specify the implicit function with which to perform the clipping. If you do not define an implicit function, then the selected input scalar data will be used for clipping.

virtual vtkImplicitFunction* vtkGenericClip::GetClipFunction ( )

virtual

Specify the implicit function with which to perform the clipping. If you do not define an implicit function, then the selected input scalar data will be used for clipping.

virtual void vtkGenericClip::SetGenerateClipScalars ( int  )

virtual

If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not provide an implicit function an error will be reported.

virtual int vtkGenericClip::GetGenerateClipScalars ( )

virtual

If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not provide an implicit function an error will be reported.

virtual void vtkGenericClip::GenerateClipScalarsOn ( )

virtual

If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not provide an implicit function an error will be reported.

virtual void vtkGenericClip::GenerateClipScalarsOff ( )

virtual

If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not provide an implicit function an error will be reported.

virtual void vtkGenericClip::SetGenerateClippedOutput ( int  )

virtual

Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.

virtual int vtkGenericClip::GetGenerateClippedOutput ( )

virtual

Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.

virtual void vtkGenericClip::GenerateClippedOutputOn ( )

virtual

Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.

virtual void vtkGenericClip::GenerateClippedOutputOff ( )

virtual

Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.

virtual void vtkGenericClip::SetMergeTolerance ( double  )

virtual

Set the tolerance for merging clip intersection points that are near the vertices of cells. This tolerance is used to prevent the generation of degenerate primitives. Note that only 3D cells actually use this instance variable.

virtual double vtkGenericClip::GetMergeTolerance ( )

virtual

Set the tolerance for merging clip intersection points that are near the vertices of cells. This tolerance is used to prevent the generation of degenerate primitives. Note that only 3D cells actually use this instance variable.

vtkUnstructuredGrid* vtkGenericClip::GetClippedOutput

(

)

Return the Clipped output.

virtual int vtkGenericClip::GetNumberOfOutputs ( )

virtual

Return the Clipped output.

void vtkGenericClip::SetLocator

(

vtkIncrementalPointLocator *

locator

)

Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used.

virtual vtkIncrementalPointLocator* vtkGenericClip::GetLocator ( )

virtual

Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used.

void vtkGenericClip::CreateDefaultLocator

(

)

Create default locator. Used to create one when none is specified. The locator is used to merge coincident points.

unsigned long vtkGenericClip::GetMTime ( )

virtual

Return the mtime also considering the locator and clip function.

Reimplemented from vtkObject.

virtual char* vtkGenericClip::GetInputScalarsSelection ( )

virtual

If you want to clip by an arbitrary array, then set its name here. By default this in NULL and the filter will use the active scalar array.

void vtkGenericClip::SelectInputScalars ( const char *  fieldName )

inline

If you want to clip by an arbitrary array, then set its name here. By default this in NULL and the filter will use the active scalar array.

Definition at line 163 of file vtkGenericClip.h.

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

protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkUnstructuredGridAlgorithm.

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

protectedvirtual

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

virtual void vtkGenericClip::SetInputScalarsSelection ( const char *  )

protectedvirtual

Member Data Documentation

vtkImplicitFunction* vtkGenericClip::ClipFunction

protected

Definition at line 174 of file vtkGenericClip.h.

vtkIncrementalPointLocator* vtkGenericClip::Locator

protected

Definition at line 176 of file vtkGenericClip.h.

int vtkGenericClip::InsideOut

protected

Definition at line 177 of file vtkGenericClip.h.

double vtkGenericClip::Value

protected

Definition at line 178 of file vtkGenericClip.h.

int vtkGenericClip::GenerateClipScalars

protected

Definition at line 179 of file vtkGenericClip.h.

int vtkGenericClip::GenerateClippedOutput

protected

Definition at line 181 of file vtkGenericClip.h.

double vtkGenericClip::MergeTolerance

protected

Definition at line 182 of file vtkGenericClip.h.

char* vtkGenericClip::InputScalarsSelection

protected

Definition at line 184 of file vtkGenericClip.h.

vtkPointData* vtkGenericClip::InternalPD

protected

Definition at line 185 of file vtkGenericClip.h.

vtkPointData* vtkGenericClip::SecondaryPD

protected

Definition at line 189 of file vtkGenericClip.h.

vtkCellData* vtkGenericClip::SecondaryCD

protected

Definition at line 190 of file vtkGenericClip.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Filters/Generic/vtkGenericClip.h