ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkGenericClip Class Reference

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

Inheritance diagram for Kitware.VTK.vtkGenericClip:
[legend]
Collaboration diagram for Kitware.VTK.vtkGenericClip:
[legend]

List of all members.

Public Member Functions

 vtkGenericClip (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkGenericClip ()
 Construct with user-specified implicit function; InsideOut turned off; value set to 0.0; and generate clip scalars turned off.
void CreateDefaultLocator ()
 Create default locator. Used to create one when none is specified. The locator is used to merge coincident points.
virtual void GenerateClipScalarsOff ()
 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 GenerateClipScalarsOn ()
 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 GenerateClippedOutputOff ()
 Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.
virtual void GenerateClippedOutputOn ()
 Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.
virtual vtkImplicitFunction GetClipFunction ()
 Description 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.
vtkUnstructuredGrid GetClippedOutput ()
 Return the Clipped output.
virtual int GetGenerateClipScalars ()
 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 GetGenerateClippedOutput ()
 Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.
virtual string GetInputScalarsSelection ()
 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.
virtual int GetInsideOut ()
 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 vtkIncrementalPointLocator GetLocator ()
 Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used.
override uint GetMTime ()
 Return the mtime also considering the locator and clip function.
virtual double GetMergeTolerance ()
 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 GetMergeToleranceMaxValue ()
 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 GetMergeToleranceMinValue ()
 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 int GetNumberOfOutputs ()
 Return the Clipped output.
virtual double GetValue ()
 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 InsideOutOff ()
 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 InsideOutOn ()
 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.
override int IsA (string type)
 Undocumented Block.
new vtkGenericClip NewInstance ()
 Undocumented Block.
void SelectInputScalars (string fieldName)
 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.
virtual void SetClipFunction (vtkImplicitFunction arg0)
 Description 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 SetGenerateClipScalars (int _arg)
 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 SetGenerateClippedOutput (int _arg)
 Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.
virtual void SetInsideOut (int _arg)
 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.
void SetLocator (vtkIncrementalPointLocator locator)
 Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used.
virtual void SetMergeTolerance (double _arg)
 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 void SetValue (double _arg)
 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.

Static Public Member Functions

static new vtkGenericClip New ()
 Construct with user-specified implicit function; InsideOut turned off; value set to 0.0; and generate clip scalars turned off.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkGenericClip SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkGenericClip"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "14vtkGenericClip"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkGenericClip_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkGenericClip_CreateDefaultLocator_01 (HandleRef pThis)
static internal void vtkGenericClip_GenerateClipScalarsOff_02 (HandleRef pThis)
static internal void vtkGenericClip_GenerateClipScalarsOn_03 (HandleRef pThis)
static internal void vtkGenericClip_GenerateClippedOutputOff_04 (HandleRef pThis)
static internal void vtkGenericClip_GenerateClippedOutputOn_05 (HandleRef pThis)
static internal IntPtr vtkGenericClip_GetClipFunction_06 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkGenericClip_GetClippedOutput_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkGenericClip_GetGenerateClipScalars_08 (HandleRef pThis)
static internal int vtkGenericClip_GetGenerateClippedOutput_09 (HandleRef pThis)
static internal IntPtr vtkGenericClip_GetInputScalarsSelection_10 (HandleRef pThis)
static internal int vtkGenericClip_GetInsideOut_11 (HandleRef pThis)
static internal IntPtr vtkGenericClip_GetLocator_12 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal uint vtkGenericClip_GetMTime_13 (HandleRef pThis)
static internal double vtkGenericClip_GetMergeTolerance_14 (HandleRef pThis)
static internal double vtkGenericClip_GetMergeToleranceMaxValue_15 (HandleRef pThis)
static internal double vtkGenericClip_GetMergeToleranceMinValue_16 (HandleRef pThis)
static internal int vtkGenericClip_GetNumberOfOutputs_17 (HandleRef pThis)
static internal double vtkGenericClip_GetValue_18 (HandleRef pThis)
static internal void vtkGenericClip_InsideOutOff_19 (HandleRef pThis)
static internal void vtkGenericClip_InsideOutOn_20 (HandleRef pThis)
static internal int vtkGenericClip_IsA_21 (HandleRef pThis, string type)
static internal int vtkGenericClip_IsTypeOf_22 (string type)
static internal IntPtr vtkGenericClip_NewInstance_24 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkGenericClip_SafeDownCast_25 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkGenericClip_SelectInputScalars_26 (HandleRef pThis, string fieldName)
static internal void vtkGenericClip_SetClipFunction_27 (HandleRef pThis, HandleRef arg0)
static internal void vtkGenericClip_SetGenerateClipScalars_28 (HandleRef pThis, int _arg)
static internal void vtkGenericClip_SetGenerateClippedOutput_29 (HandleRef pThis, int _arg)
static internal void vtkGenericClip_SetInsideOut_30 (HandleRef pThis, int _arg)
static internal void vtkGenericClip_SetLocator_31 (HandleRef pThis, HandleRef locator)
static internal void vtkGenericClip_SetMergeTolerance_32 (HandleRef pThis, double _arg)
static internal void vtkGenericClip_SetValue_33 (HandleRef pThis, double _arg)

Static Private Member Functions

static vtkGenericClip ()
 Automatically generated type registration mechanics.

Detailed Description

vtkGenericClip - clip any dataset with an implicit function or scalar data

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


Constructor & Destructor Documentation

static Kitware.VTK.vtkGenericClip.vtkGenericClip ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkGenericClip.vtkGenericClip ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

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


Member Function Documentation

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

override void Kitware.VTK.vtkGenericClip.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkUnstructuredGridAlgorithm.

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

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

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.

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.

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

Here is the call graph for this function:

Return the Clipped output.

Here is the call graph for this function:

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

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.

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.

virtual int Kitware.VTK.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.

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

Here is the call graph for this function:

virtual double Kitware.VTK.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.

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.

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.

override uint Kitware.VTK.vtkGenericClip.GetMTime ( ) [virtual]

Return the mtime also considering the locator and clip function.

Reimplemented from Kitware.VTK.vtkObject.

Return the Clipped output.

virtual double Kitware.VTK.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 Kitware.VTK.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 Kitware.VTK.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.

override int Kitware.VTK.vtkGenericClip.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkUnstructuredGridAlgorithm.

static new int Kitware.VTK.vtkGenericClip.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkUnstructuredGridAlgorithm.

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

Reimplemented from Kitware.VTK.vtkUnstructuredGridAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkUnstructuredGridAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkUnstructuredGridAlgorithm.

Here is the call graph for this function:

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.

Description 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 Kitware.VTK.vtkGenericClip.SetGenerateClippedOutput ( int  _arg) [virtual]

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

virtual void Kitware.VTK.vtkGenericClip.SetGenerateClipScalars ( int  _arg) [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 Kitware.VTK.vtkGenericClip.SetInsideOut ( int  _arg) [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.

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

virtual void Kitware.VTK.vtkGenericClip.SetMergeTolerance ( double  _arg) [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 void Kitware.VTK.vtkGenericClip.SetValue ( double  _arg) [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.

static internal void Kitware.VTK.vtkGenericClip.vtkGenericClip_CreateDefaultLocator_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkGenericClip.vtkGenericClip_GenerateClippedOutputOff_04 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkGenericClip.vtkGenericClip_GenerateClippedOutputOn_05 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkGenericClip.vtkGenericClip_GenerateClipScalarsOff_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkGenericClip.vtkGenericClip_GenerateClipScalarsOn_03 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkGenericClip.vtkGenericClip_GetClipFunction_06 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkGenericClip.vtkGenericClip_GetClippedOutput_07 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkGenericClip.vtkGenericClip_GetGenerateClippedOutput_09 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkGenericClip.vtkGenericClip_GetGenerateClipScalars_08 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkGenericClip.vtkGenericClip_GetInputScalarsSelection_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkGenericClip.vtkGenericClip_GetInsideOut_11 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkGenericClip.vtkGenericClip_GetLocator_12 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal double Kitware.VTK.vtkGenericClip.vtkGenericClip_GetMergeTolerance_14 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkGenericClip.vtkGenericClip_GetMergeToleranceMaxValue_15 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkGenericClip.vtkGenericClip_GetMergeToleranceMinValue_16 ( HandleRef  pThis) [private]
static internal uint Kitware.VTK.vtkGenericClip.vtkGenericClip_GetMTime_13 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkGenericClip.vtkGenericClip_GetNumberOfOutputs_17 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkGenericClip.vtkGenericClip_GetValue_18 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkGenericClip.vtkGenericClip_InsideOutOff_19 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkGenericClip.vtkGenericClip_InsideOutOn_20 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkGenericClip.vtkGenericClip_IsA_21 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkGenericClip.vtkGenericClip_IsTypeOf_22 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkGenericClip.vtkGenericClip_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkGenericClip.vtkGenericClip_NewInstance_24 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkGenericClip.vtkGenericClip_SafeDownCast_25 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkGenericClip.vtkGenericClip_SelectInputScalars_26 ( HandleRef  pThis,
string  fieldName 
) [private]
static internal void Kitware.VTK.vtkGenericClip.vtkGenericClip_SetClipFunction_27 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkGenericClip.vtkGenericClip_SetGenerateClippedOutput_29 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkGenericClip.vtkGenericClip_SetGenerateClipScalars_28 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkGenericClip.vtkGenericClip_SetInsideOut_30 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkGenericClip.vtkGenericClip_SetLocator_31 ( HandleRef  pThis,
HandleRef  locator 
) [private]
static internal void Kitware.VTK.vtkGenericClip.vtkGenericClip_SetMergeTolerance_32 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkGenericClip.vtkGenericClip_SetValue_33 ( HandleRef  pThis,
double  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkGenericClip.MRClassNameKey = "14vtkGenericClip" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkUnstructuredGridAlgorithm.

new const string Kitware.VTK.vtkGenericClip.MRFullTypeName = "Kitware.VTK.vtkGenericClip"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkUnstructuredGridAlgorithm.


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