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.vtkClipPolyData Class Reference

vtkClipPolyData - clip polygonal data with user-specified implicit function or input scalar data More...

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

List of all members.

Public Member Functions

 vtkClipPolyData (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkClipPolyData ()
 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 input scalar data will be used for clipping.
vtkPolyData GetClippedOutput ()
 Return the Clipped output.
vtkAlgorithmOutput GetClippedOutputPort ()
 Return the output port (a vtkAlgorithmOutput) of 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 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 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 vtkClipPolyData NewInstance ()
 Undocumented Block.
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 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 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 vtkClipPolyData 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 vtkClipPolyData SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "15vtkClipPolyData"
 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 vtkClipPolyData_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkClipPolyData_CreateDefaultLocator_01 (HandleRef pThis)
static internal void vtkClipPolyData_GenerateClipScalarsOff_02 (HandleRef pThis)
static internal void vtkClipPolyData_GenerateClipScalarsOn_03 (HandleRef pThis)
static internal void vtkClipPolyData_GenerateClippedOutputOff_04 (HandleRef pThis)
static internal void vtkClipPolyData_GenerateClippedOutputOn_05 (HandleRef pThis)
static internal IntPtr vtkClipPolyData_GetClipFunction_06 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkClipPolyData_GetClippedOutput_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkClipPolyData_GetClippedOutputPort_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkClipPolyData_GetGenerateClipScalars_09 (HandleRef pThis)
static internal int vtkClipPolyData_GetGenerateClippedOutput_10 (HandleRef pThis)
static internal int vtkClipPolyData_GetInsideOut_11 (HandleRef pThis)
static internal IntPtr vtkClipPolyData_GetLocator_12 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal uint vtkClipPolyData_GetMTime_13 (HandleRef pThis)
static internal double vtkClipPolyData_GetValue_14 (HandleRef pThis)
static internal void vtkClipPolyData_InsideOutOff_15 (HandleRef pThis)
static internal void vtkClipPolyData_InsideOutOn_16 (HandleRef pThis)
static internal int vtkClipPolyData_IsA_17 (HandleRef pThis, string type)
static internal int vtkClipPolyData_IsTypeOf_18 (string type)
static internal IntPtr vtkClipPolyData_NewInstance_20 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkClipPolyData_SafeDownCast_21 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkClipPolyData_SetClipFunction_22 (HandleRef pThis, HandleRef arg0)
static internal void vtkClipPolyData_SetGenerateClipScalars_23 (HandleRef pThis, int _arg)
static internal void vtkClipPolyData_SetGenerateClippedOutput_24 (HandleRef pThis, int _arg)
static internal void vtkClipPolyData_SetInsideOut_25 (HandleRef pThis, int _arg)
static internal void vtkClipPolyData_SetLocator_26 (HandleRef pThis, HandleRef locator)
static internal void vtkClipPolyData_SetValue_27 (HandleRef pThis, double _arg)

Static Private Member Functions

static vtkClipPolyData ()
 Automatically generated type registration mechanics.

Detailed Description

vtkClipPolyData - clip polygonal data with user-specified implicit function or input scalar data

Description vtkClipPolyData is a filter that clips polygonal data 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 polygonal data.

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 cutting 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 polygonal data that is clipped away. Set the GenerateClippedData boolean on if you wish to access this output data.


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

Kitware.VTK.vtkClipPolyData.vtkClipPolyData ( 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.vtkClipPolyData.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.vtkPolyDataAlgorithm.

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 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:

Return the output port (a vtkAlgorithmOutput) of 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.

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

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

Return the mtime also considering the locator and clip function.

Reimplemented from Kitware.VTK.vtkObject.

virtual double Kitware.VTK.vtkClipPolyData.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.vtkClipPolyData.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.vtkClipPolyData.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.vtkClipPolyData.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

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

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Here is the call graph for this function:

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

virtual void Kitware.VTK.vtkClipPolyData.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.vtkClipPolyData.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.vtkClipPolyData.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.vtkClipPolyData.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.vtkClipPolyData.vtkClipPolyData_CreateDefaultLocator_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkClipPolyData.vtkClipPolyData_GenerateClippedOutputOff_04 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkClipPolyData.vtkClipPolyData_GenerateClippedOutputOn_05 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkClipPolyData.vtkClipPolyData_GenerateClipScalarsOff_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkClipPolyData.vtkClipPolyData_GenerateClipScalarsOn_03 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkClipPolyData.vtkClipPolyData_GetClipFunction_06 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkClipPolyData.vtkClipPolyData_GetClippedOutput_07 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkClipPolyData.vtkClipPolyData_GetClippedOutputPort_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkClipPolyData.vtkClipPolyData_GetGenerateClippedOutput_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkClipPolyData.vtkClipPolyData_GetGenerateClipScalars_09 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkClipPolyData.vtkClipPolyData_GetInsideOut_11 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkClipPolyData.vtkClipPolyData_GetLocator_12 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal uint Kitware.VTK.vtkClipPolyData.vtkClipPolyData_GetMTime_13 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkClipPolyData.vtkClipPolyData_GetValue_14 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkClipPolyData.vtkClipPolyData_InsideOutOff_15 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkClipPolyData.vtkClipPolyData_InsideOutOn_16 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkClipPolyData.vtkClipPolyData_IsA_17 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkClipPolyData.vtkClipPolyData_IsTypeOf_18 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkClipPolyData.vtkClipPolyData_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkClipPolyData.vtkClipPolyData_NewInstance_20 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkClipPolyData.vtkClipPolyData_SafeDownCast_21 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkClipPolyData.vtkClipPolyData_SetClipFunction_22 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkClipPolyData.vtkClipPolyData_SetGenerateClippedOutput_24 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkClipPolyData.vtkClipPolyData_SetGenerateClipScalars_23 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkClipPolyData.vtkClipPolyData_SetInsideOut_25 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkClipPolyData.vtkClipPolyData_SetLocator_26 ( HandleRef  pThis,
HandleRef  locator 
) [private]
static internal void Kitware.VTK.vtkClipPolyData.vtkClipPolyData_SetValue_27 ( HandleRef  pThis,
double  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkClipPolyData.MRClassNameKey = "15vtkClipPolyData" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.


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