VTK
|
clip any dataset with an implicit function or scalar data More...
#include <vtkGenericClip.h>
Inherits vtkUnstructuredGridAlgorithm.
Public Types | |
typedef vtkUnstructuredGridAlgorithm | 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) |
Static Public Member Functions | |
static int | IsTypeOf (const char *type) |
static vtkGenericClip * | SafeDownCast (vtkObjectBase *o) |
static vtkGenericClip * | 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 Attributes | |
vtkImplicitFunction * | ClipFunction |
vtkIncrementalPointLocator * | Locator |
int | InsideOut |
double | Value |
int | GenerateClipScalars |
int | GenerateClippedOutput |
double | MergeTolerance |
char * | InputScalarsSelection |
vtkPointData * | InternalPD |
vtkPointData * | SecondaryPD |
vtkCellData * | SecondaryCD |
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.
Definition at line 75 of file vtkGenericClip.h.
typedef vtkUnstructuredGridAlgorithm vtkGenericClip::Superclass |
Definition at line 78 of file vtkGenericClip.h.
|
protected |
|
protected |
|
static |
|
virtual |
|
static |
|
protectedvirtual |
vtkGenericClip* vtkGenericClip::NewInstance | ( | ) | const |
void vtkGenericClip::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
static |
Construct with user-specified implicit function; InsideOut turned off; value set to 0.0; and generate clip scalars turned off.
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.
|
virtual |
Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.
|
virtual |
Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.
|
virtual |
Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.
|
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 |
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 |
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 |
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 | ( | ) |
Return the mtime also considering the locator and clip function.
|
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.
|
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.
|
protected |
|
protected |
|
protectedvirtual |
|
protected |
Definition at line 174 of file vtkGenericClip.h.
|
protected |
Definition at line 176 of file vtkGenericClip.h.
|
protected |
Definition at line 177 of file vtkGenericClip.h.
|
protected |
Definition at line 178 of file vtkGenericClip.h.
|
protected |
Definition at line 179 of file vtkGenericClip.h.
|
protected |
Definition at line 181 of file vtkGenericClip.h.
|
protected |
Definition at line 182 of file vtkGenericClip.h.
|
protected |
Definition at line 184 of file vtkGenericClip.h.
|
protected |
Definition at line 185 of file vtkGenericClip.h.
|
protected |
Definition at line 189 of file vtkGenericClip.h.
|
protected |
Definition at line 190 of file vtkGenericClip.h.