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

vtkHyperOctreeCutter - Cut vtkHyperOctree with user-specified implicit function More...

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

List of all members.

Public Member Functions

 vtkHyperOctreeCutter (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkHyperOctreeCutter ()
 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.
virtual int GetSortBy ()
 Set the sorting order for the generated polydata. There are two possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem dependent. For most applications, the default order is fine (and faster).
string GetSortByAsString ()
 Return the sorting procedure as a descriptive character string.
virtual int GetSortByMaxValue ()
 Set the sorting order for the generated polydata. There are two possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem dependent. For most applications, the default order is fine (and faster).
virtual int GetSortByMinValue ()
 Set the sorting order for the generated polydata. There are two possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem dependent. For most applications, the default order is fine (and faster).
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 vtkHyperOctreeCutter 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.
virtual void SetSortBy (int _arg)
 Set the sorting order for the generated polydata. There are two possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem dependent. For most applications, the default order is fine (and faster).
void SetSortByToSortByCell ()
 Set the sorting order for the generated polydata. There are two possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem dependent. For most applications, the default order is fine (and faster).
void SetSortByToSortByValue ()
 Set the sorting order for the generated polydata. There are two possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem dependent. For most applications, the default order is fine (and faster).
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 vtkHyperOctreeCutter 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 vtkHyperOctreeCutter SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "20vtkHyperOctreeCutter"
 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 vtkHyperOctreeCutter_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkHyperOctreeCutter_CreateDefaultLocator_01 (HandleRef pThis)
static internal void vtkHyperOctreeCutter_GenerateCutScalarsOff_02 (HandleRef pThis)
static internal void vtkHyperOctreeCutter_GenerateCutScalarsOn_03 (HandleRef pThis)
static internal void vtkHyperOctreeCutter_GenerateValues_04 (HandleRef pThis, int numContours, IntPtr range)
static internal void vtkHyperOctreeCutter_GenerateValues_05 (HandleRef pThis, int numContours, double rangeStart, double rangeEnd)
static internal IntPtr vtkHyperOctreeCutter_GetCutFunction_06 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkHyperOctreeCutter_GetGenerateCutScalars_07 (HandleRef pThis)
static internal IntPtr vtkHyperOctreeCutter_GetLocator_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal uint vtkHyperOctreeCutter_GetMTime_09 (HandleRef pThis)
static internal int vtkHyperOctreeCutter_GetNumberOfContours_10 (HandleRef pThis)
static internal int vtkHyperOctreeCutter_GetSortBy_11 (HandleRef pThis)
static internal IntPtr vtkHyperOctreeCutter_GetSortByAsString_12 (HandleRef pThis)
static internal int vtkHyperOctreeCutter_GetSortByMaxValue_13 (HandleRef pThis)
static internal int vtkHyperOctreeCutter_GetSortByMinValue_14 (HandleRef pThis)
static internal double vtkHyperOctreeCutter_GetValue_15 (HandleRef pThis, int i)
static internal IntPtr vtkHyperOctreeCutter_GetValues_16 (HandleRef pThis)
static internal void vtkHyperOctreeCutter_GetValues_17 (HandleRef pThis, IntPtr contourValues)
static internal int vtkHyperOctreeCutter_IsA_18 (HandleRef pThis, string type)
static internal int vtkHyperOctreeCutter_IsTypeOf_19 (string type)
static internal IntPtr vtkHyperOctreeCutter_NewInstance_21 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkHyperOctreeCutter_SafeDownCast_22 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkHyperOctreeCutter_SetCutFunction_23 (HandleRef pThis, HandleRef arg0)
static internal void vtkHyperOctreeCutter_SetGenerateCutScalars_24 (HandleRef pThis, int _arg)
static internal void vtkHyperOctreeCutter_SetLocator_25 (HandleRef pThis, HandleRef locator)
static internal void vtkHyperOctreeCutter_SetNumberOfContours_26 (HandleRef pThis, int number)
static internal void vtkHyperOctreeCutter_SetSortBy_27 (HandleRef pThis, int _arg)
static internal void vtkHyperOctreeCutter_SetSortByToSortByCell_28 (HandleRef pThis)
static internal void vtkHyperOctreeCutter_SetSortByToSortByValue_29 (HandleRef pThis)
static internal void vtkHyperOctreeCutter_SetValue_30 (HandleRef pThis, int i, double value)

Static Private Member Functions

static vtkHyperOctreeCutter ()
 Automatically generated type registration mechanics.

Detailed Description

vtkHyperOctreeCutter - Cut vtkHyperOctree with user-specified implicit function

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

vtkHyperOctreeCutter is generally used to "slice-through" a dataset, generating a surface that can be visualized. It is also possible to use vtkHyperOctreeCutter to do a form of volume rendering. vtkHyperOctreeCutter 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.

Note that data can be cut using either 1) the scalar values associated with the dataset or 2) an implicit function associated with this class. By default, if an implicit function is set it is used to cut the data set, otherwise the dataset scalars are used to perform the cut.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

virtual int Kitware.VTK.vtkHyperOctreeCutter.GetSortBy ( ) [virtual]

Set the sorting order for the generated polydata. There are two possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem dependent. For most applications, the default order is fine (and faster).

Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses with vtkPolyData output, verts and lines have lower cell ids than triangles.

Return the sorting procedure as a descriptive character string.

Set the sorting order for the generated polydata. There are two possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem dependent. For most applications, the default order is fine (and faster).

Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses with vtkPolyData output, verts and lines have lower cell ids than triangles.

Set the sorting order for the generated polydata. There are two possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem dependent. For most applications, the default order is fine (and faster).

Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses with vtkPolyData output, verts and lines have lower cell ids than triangles.

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.vtkHyperOctreeCutter.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.vtkHyperOctreeCutter.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

static new int Kitware.VTK.vtkHyperOctreeCutter.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.vtkHyperOctreeCutter.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.

virtual void Kitware.VTK.vtkHyperOctreeCutter.SetSortBy ( int  _arg) [virtual]

Set the sorting order for the generated polydata. There are two possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem dependent. For most applications, the default order is fine (and faster).

Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses with vtkPolyData output, verts and lines have lower cell ids than triangles.

Set the sorting order for the generated polydata. There are two possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem dependent. For most applications, the default order is fine (and faster).

Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses with vtkPolyData output, verts and lines have lower cell ids than triangles.

Set the sorting order for the generated polydata. There are two possibilities: Sort by value = 0 - This is the most efficient sort. For each cell, all contour values are processed. This is the default. Sort by cell = 1 - For each contour value, all cells are processed. This order should be used if the extracted polygons must be rendered in a back-to-front or front-to-back order. This is very problem dependent. For most applications, the default order is fine (and faster).

Sort by cell is going to have a problem if the input has 2D and 3D cells. Cell data will be scrambled becauses with vtkPolyData output, verts and lines have lower cell ids than triangles.

void Kitware.VTK.vtkHyperOctreeCutter.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.vtkHyperOctreeCutter.vtkHyperOctreeCutter_CreateDefaultLocator_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_GenerateCutScalarsOff_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_GenerateCutScalarsOn_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_GenerateValues_04 ( HandleRef  pThis,
int  numContours,
IntPtr  range 
) [private]
static internal void Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_GenerateValues_05 ( HandleRef  pThis,
int  numContours,
double  rangeStart,
double  rangeEnd 
) [private]
static internal IntPtr Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_GetCutFunction_06 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_GetGenerateCutScalars_07 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_GetLocator_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal uint Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_GetMTime_09 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_GetNumberOfContours_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_GetSortBy_11 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_GetSortByAsString_12 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_GetSortByMaxValue_13 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_GetSortByMinValue_14 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_GetValue_15 ( HandleRef  pThis,
int  i 
) [private]
static internal IntPtr Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_GetValues_16 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_GetValues_17 ( HandleRef  pThis,
IntPtr  contourValues 
) [private]
static internal int Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_IsA_18 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_IsTypeOf_19 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_NewInstance_21 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_SafeDownCast_22 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_SetCutFunction_23 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_SetGenerateCutScalars_24 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_SetLocator_25 ( HandleRef  pThis,
HandleRef  locator 
) [private]
static internal void Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_SetNumberOfContours_26 ( HandleRef  pThis,
int  number 
) [private]
static internal void Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_SetSortBy_27 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_SetSortByToSortByCell_28 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_SetSortByToSortByValue_29 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkHyperOctreeCutter.vtkHyperOctreeCutter_SetValue_30 ( HandleRef  pThis,
int  i,
double  value 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkHyperOctreeCutter.MRClassNameKey = "20vtkHyperOctreeCutter" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.


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