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

vtkGenericCutter - cut a vtkGenericDataSet with an implicit function or scalar data More...

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

List of all members.

Public Member Functions

 vtkGenericCutter (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkGenericCutter ()
 Construct with user-specified implicit function; initial value of 0.0; and generating cut 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 GenerateCutScalarsOff ()
 If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.
virtual void GenerateCutScalarsOn ()
 If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.
void GenerateValues (int numContours, IntPtr range)
 Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.
void GenerateValues (int numContours, double rangeStart, double rangeEnd)
 Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.
virtual vtkImplicitFunction GetCutFunction ()
 Description Specify the implicit function to perform the cutting.
virtual int GetGenerateCutScalars ()
 If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.
virtual vtkIncrementalPointLocator GetLocator ()
 Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used.
override uint GetMTime ()
 Override GetMTime because we delegate to vtkContourValues and refer to vtkImplicitFunction.
int GetNumberOfContours ()
 Get the number of contours in the list of contour values.
double GetValue (int i)
 Get the ith contour value.
IntPtr GetValues ()
 Get a pointer to an array of contour values. There will be GetNumberOfContours() values in the list.
void GetValues (IntPtr contourValues)
 Fill a supplied list with contour values. There will be GetNumberOfContours() values in the list. Make sure you allocate enough memory to hold the list.
override int IsA (string type)
 Undocumented Block.
new vtkGenericCutter NewInstance ()
 Undocumented Block.
virtual void SetCutFunction (vtkImplicitFunction arg0)
 Description Specify the implicit function to perform the cutting.
virtual void SetGenerateCutScalars (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.
void SetLocator (vtkIncrementalPointLocator locator)
 Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used.
void SetNumberOfContours (int number)
 Set the number of contours to place into the list. You only really need to use this method to reduce list size. The method SetValue() will automatically increase list size as needed.
void SetValue (int i, double value)
 Set a particular contour value at contour number i. The index i ranges between 0<=i<NumberOfContours.

Static Public Member Functions

static new vtkGenericCutter New ()
 Construct with user-specified implicit function; initial value of 0.0; and generating cut scalars turned off.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkGenericCutter SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "16vtkGenericCutter"
 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 vtkGenericCutter_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkGenericCutter_CreateDefaultLocator_01 (HandleRef pThis)
static internal void vtkGenericCutter_GenerateCutScalarsOff_02 (HandleRef pThis)
static internal void vtkGenericCutter_GenerateCutScalarsOn_03 (HandleRef pThis)
static internal void vtkGenericCutter_GenerateValues_04 (HandleRef pThis, int numContours, IntPtr range)
static internal void vtkGenericCutter_GenerateValues_05 (HandleRef pThis, int numContours, double rangeStart, double rangeEnd)
static internal IntPtr vtkGenericCutter_GetCutFunction_06 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkGenericCutter_GetGenerateCutScalars_07 (HandleRef pThis)
static internal IntPtr vtkGenericCutter_GetLocator_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal uint vtkGenericCutter_GetMTime_09 (HandleRef pThis)
static internal int vtkGenericCutter_GetNumberOfContours_10 (HandleRef pThis)
static internal double vtkGenericCutter_GetValue_11 (HandleRef pThis, int i)
static internal IntPtr vtkGenericCutter_GetValues_12 (HandleRef pThis)
static internal void vtkGenericCutter_GetValues_13 (HandleRef pThis, IntPtr contourValues)
static internal int vtkGenericCutter_IsA_14 (HandleRef pThis, string type)
static internal int vtkGenericCutter_IsTypeOf_15 (string type)
static internal IntPtr vtkGenericCutter_NewInstance_17 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkGenericCutter_SafeDownCast_18 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkGenericCutter_SetCutFunction_19 (HandleRef pThis, HandleRef arg0)
static internal void vtkGenericCutter_SetGenerateCutScalars_20 (HandleRef pThis, int _arg)
static internal void vtkGenericCutter_SetLocator_21 (HandleRef pThis, HandleRef locator)
static internal void vtkGenericCutter_SetNumberOfContours_22 (HandleRef pThis, int number)
static internal void vtkGenericCutter_SetValue_23 (HandleRef pThis, int i, double value)

Static Private Member Functions

static vtkGenericCutter ()
 Automatically generated type registration mechanics.

Detailed Description

vtkGenericCutter - cut a vtkGenericDataSet with an implicit function or scalar data

Description vtkGenericCutter is a filter to cut through data using any subclass of vtkImplicitFunction. That is, a polygonal surface is created corresponding to the implicit function F(x,y,z) = value(s), where you can specify one or more values used to cut with.

In VTK, cutting means reducing a cell of dimension N to a cut surface of dimension N-1. For example, a tetrahedron when cut by a plane (i.e., vtkPlane implicit function) will generate triangles. (In comparison, clipping takes a N dimensional cell and creates N dimension primitives.)

vtkGenericCutter is generally used to "slice-through" a dataset, generating a surface that can be visualized. It is also possible to use vtkGenericCutter to do a form of volume rendering. vtkGenericCutter does this by generating multiple cut surfaces (usually planes) which are ordered (and rendered) from back-to-front. The surfaces are set translucent to give a volumetric rendering effect.

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.vtkGenericCutter.vtkGenericCutter ( ) [static, private]

Automatically generated type registration mechanics.

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

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

Construct with user-specified implicit function; initial value of 0.0; and generating cut 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.vtkGenericCutter.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.

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 this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.

void Kitware.VTK.vtkGenericCutter.GenerateValues ( int  numContours,
IntPtr  range 
)

Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.

void Kitware.VTK.vtkGenericCutter.GenerateValues ( int  numContours,
double  rangeStart,
double  rangeEnd 
)

Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.

Description Specify the implicit function to perform the cutting.

Here is the call graph for this function:

If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.

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.vtkGenericCutter.GetMTime ( ) [virtual]

Override GetMTime because we delegate to vtkContourValues and refer to vtkImplicitFunction.

Reimplemented from Kitware.VTK.vtkObject.

Get the number of contours in the list of contour values.

Get the ith contour value.

Get a pointer to an array of contour values. There will be GetNumberOfContours() values in the list.

void Kitware.VTK.vtkGenericCutter.GetValues ( IntPtr  contourValues)

Fill a supplied list with contour values. There will be GetNumberOfContours() values in the list. Make sure you allocate enough memory to hold the list.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Construct with user-specified implicit function; initial value of 0.0; and generating cut 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 to perform the cutting.

virtual void Kitware.VTK.vtkGenericCutter.SetGenerateCutScalars ( 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.

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

Set the number of contours to place into the list. You only really need to use this method to reduce list size. The method SetValue() will automatically increase list size as needed.

void Kitware.VTK.vtkGenericCutter.SetValue ( int  i,
double  value 
)

Set a particular contour value at contour number i. The index i ranges between 0<=i<NumberOfContours.

static internal void Kitware.VTK.vtkGenericCutter.vtkGenericCutter_CreateDefaultLocator_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkGenericCutter.vtkGenericCutter_GenerateCutScalarsOff_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkGenericCutter.vtkGenericCutter_GenerateCutScalarsOn_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkGenericCutter.vtkGenericCutter_GenerateValues_04 ( HandleRef  pThis,
int  numContours,
IntPtr  range 
) [private]
static internal void Kitware.VTK.vtkGenericCutter.vtkGenericCutter_GenerateValues_05 ( HandleRef  pThis,
int  numContours,
double  rangeStart,
double  rangeEnd 
) [private]
static internal IntPtr Kitware.VTK.vtkGenericCutter.vtkGenericCutter_GetCutFunction_06 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkGenericCutter.vtkGenericCutter_GetGenerateCutScalars_07 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkGenericCutter.vtkGenericCutter_GetLocator_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal uint Kitware.VTK.vtkGenericCutter.vtkGenericCutter_GetMTime_09 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkGenericCutter.vtkGenericCutter_GetNumberOfContours_10 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkGenericCutter.vtkGenericCutter_GetValue_11 ( HandleRef  pThis,
int  i 
) [private]
static internal IntPtr Kitware.VTK.vtkGenericCutter.vtkGenericCutter_GetValues_12 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkGenericCutter.vtkGenericCutter_GetValues_13 ( HandleRef  pThis,
IntPtr  contourValues 
) [private]
static internal int Kitware.VTK.vtkGenericCutter.vtkGenericCutter_IsA_14 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkGenericCutter.vtkGenericCutter_IsTypeOf_15 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkGenericCutter.vtkGenericCutter_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkGenericCutter.vtkGenericCutter_NewInstance_17 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkGenericCutter.vtkGenericCutter_SafeDownCast_18 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkGenericCutter.vtkGenericCutter_SetCutFunction_19 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkGenericCutter.vtkGenericCutter_SetGenerateCutScalars_20 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkGenericCutter.vtkGenericCutter_SetLocator_21 ( HandleRef  pThis,
HandleRef  locator 
) [private]
static internal void Kitware.VTK.vtkGenericCutter.vtkGenericCutter_SetNumberOfContours_22 ( HandleRef  pThis,
int  number 
) [private]
static internal void Kitware.VTK.vtkGenericCutter.vtkGenericCutter_SetValue_23 ( HandleRef  pThis,
int  i,
double  value 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkGenericCutter.MRClassNameKey = "16vtkGenericCutter" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.


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