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

vtkHull - produce an n-sided convex hull More...

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

List of all members.

Public Member Functions

 vtkHull (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkHull ()
 Undocumented Block.
void AddCubeEdgePlanes ()
 Add the 12 planes that represent the edges of a cube - halfway between the two connecting face planes - (1,1,0), (-1,-1,0), (-1,1,0), (1,-1,0), (0,1,1), (0,-1,-1), (0,1,-1), (0,-1,1), (1,0,1), (-1,0,-1), (1,0,-1), (-1,0,1)
void AddCubeFacePlanes ()
 Add the six planes that make up the faces of a cube - (1,0,0), (-1, 0, 0), (0,1,0), (0,-1,0), (0,0,1), (0,0,-1)
void AddCubeVertexPlanes ()
 Add the 8 planes that represent the vertices of a cube - the combination of the three face planes connecting to a vertex - (1,1,1), (1,1,-1), (1,-1,1), (1,-1,1), (-1,1,1), (-1,1,-1), (-1,-1,1), (-1,-1-1).
int AddPlane (double A, double B, double C)
 Add a plane to the current set of planes. It will be added at the end of the list, and an index that can later be used to set this plane's normal will be returned. The values A, B, C are from the plane equation Ax + By + Cz + D = 0. This vector does not have to have unit length (but it must have a non-zero length!). If a value 0 > i >= -NumberOfPlanes is returned, then the plane is parallel with a previously inserted plane, and |-i-1| is the index of the plane that was previously inserted. If a value i < -NumberOfPlanes is returned, then the plane normal is zero length.
int AddPlane (IntPtr plane)
 Add a plane to the current set of planes. It will be added at the end of the list, and an index that can later be used to set this plane's normal will be returned. The values A, B, C are from the plane equation Ax + By + Cz + D = 0. This vector does not have to have unit length (but it must have a non-zero length!). If a value 0 > i >= -NumberOfPlanes is returned, then the plane is parallel with a previously inserted plane, and |-i-1| is the index of the plane that was previously inserted. If a value i < -NumberOfPlanes is returned, then the plane normal is zero length.
int AddPlane (double A, double B, double C, double D)
 Variations of AddPlane()/SetPlane() that allow D to be set. These methods are used when GenerateHull() is used.
int AddPlane (IntPtr plane, double D)
 Variations of AddPlane()/SetPlane() that allow D to be set. These methods are used when GenerateHull() is used.
void AddRecursiveSpherePlanes (int level)
 Add the planes that represent the normals of the vertices of a polygonal sphere formed by recursively subdividing the triangles in an octahedron. Each triangle is subdivided by connecting the midpoints of the edges thus forming 4 smaller triangles. The level indicates how many subdivisions to do with a level of 0 used to add the 6 planes from the original octahedron, level 1 will add 18 planes, and so on.
void GenerateHull (vtkPolyData pd, IntPtr bounds)
 A special method that is used to generate a polyhedron directly from a set of n planes. The planes that are supplied by the user are not squeezed towards the input data (in fact the user need not specify an input). To use this method, you must provide an instance of vtkPolyData into which the points and cells defining the polyhedron are placed. You must also provide a bounding box where you expect the resulting polyhedron to lie. This can be a very generous fit, it's only used to create the initial polygons that are eventually clipped.
void GenerateHull (vtkPolyData pd, double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
 A special method that is used to generate a polyhedron directly from a set of n planes. The planes that are supplied by the user are not squeezed towards the input data (in fact the user need not specify an input). To use this method, you must provide an instance of vtkPolyData into which the points and cells defining the polyhedron are placed. You must also provide a bounding box where you expect the resulting polyhedron to lie. This can be a very generous fit, it's only used to create the initial polygons that are eventually clipped.
virtual int GetNumberOfPlanes ()
 Get the number of planes in the current set of planes.
override int IsA (string type)
 Undocumented Block.
new vtkHull NewInstance ()
 Undocumented Block.
void RemoveAllPlanes ()
 Remove all planes from the current set of planes.
void SetPlane (int i, double A, double B, double C)
 Set the normal values for plane i. This is a plane that was already added to the current set of planes with AddPlane(), and is now being modified. The values A, B, C are from the plane equation Ax + By + Cz + D = 0. This vector does not have to have unit length. Note that D is set to zero, except in the case of the method taking a vtkPlanes* argument, where it is set to the D value defined there.
void SetPlane (int i, IntPtr plane)
 Set the normal values for plane i. This is a plane that was already added to the current set of planes with AddPlane(), and is now being modified. The values A, B, C are from the plane equation Ax + By + Cz + D = 0. This vector does not have to have unit length. Note that D is set to zero, except in the case of the method taking a vtkPlanes* argument, where it is set to the D value defined there.
void SetPlane (int i, double A, double B, double C, double D)
 Variations of AddPlane()/SetPlane() that allow D to be set. These methods are used when GenerateHull() is used.
void SetPlane (int i, IntPtr plane, double D)
 Variations of AddPlane()/SetPlane() that allow D to be set. These methods are used when GenerateHull() is used.
void SetPlanes (vtkPlanes planes)
 Set all the planes at once using a vtkPlanes implicit function. This also sets the D value, so it can be used with GenerateHull().

Static Public Member Functions

static new vtkHull New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkHull SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "7vtkHull"
 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 vtkHull_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkHull_AddCubeEdgePlanes_01 (HandleRef pThis)
static internal void vtkHull_AddCubeFacePlanes_02 (HandleRef pThis)
static internal void vtkHull_AddCubeVertexPlanes_03 (HandleRef pThis)
static internal int vtkHull_AddPlane_04 (HandleRef pThis, double A, double B, double C)
static internal int vtkHull_AddPlane_05 (HandleRef pThis, IntPtr plane)
static internal int vtkHull_AddPlane_06 (HandleRef pThis, double A, double B, double C, double D)
static internal int vtkHull_AddPlane_07 (HandleRef pThis, IntPtr plane, double D)
static internal void vtkHull_AddRecursiveSpherePlanes_08 (HandleRef pThis, int level)
static internal void vtkHull_GenerateHull_09 (HandleRef pThis, HandleRef pd, IntPtr bounds)
static internal void vtkHull_GenerateHull_10 (HandleRef pThis, HandleRef pd, double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
static internal int vtkHull_GetNumberOfPlanes_11 (HandleRef pThis)
static internal int vtkHull_IsA_12 (HandleRef pThis, string type)
static internal int vtkHull_IsTypeOf_13 (string type)
static internal IntPtr vtkHull_NewInstance_15 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkHull_RemoveAllPlanes_16 (HandleRef pThis)
static internal IntPtr vtkHull_SafeDownCast_17 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkHull_SetPlane_18 (HandleRef pThis, int i, double A, double B, double C)
static internal void vtkHull_SetPlane_19 (HandleRef pThis, int i, IntPtr plane)
static internal void vtkHull_SetPlane_20 (HandleRef pThis, int i, double A, double B, double C, double D)
static internal void vtkHull_SetPlane_21 (HandleRef pThis, int i, IntPtr plane, double D)
static internal void vtkHull_SetPlanes_22 (HandleRef pThis, HandleRef planes)

Static Private Member Functions

static vtkHull ()
 Automatically generated type registration mechanics.

Detailed Description

vtkHull - produce an n-sided convex hull

Description vtkHull is a filter which will produce an n-sided convex hull given a set of n planes. (The convex hull bounds the input polygonal data.) The hull is generated by squeezing the planes towards the input vtkPolyData, until the planes just touch the vtkPolyData. Then, the resulting planes are used to generate a polyhedron (i.e., hull) that is represented by triangles.

The n planes can be defined in a number of ways including 1) manually specifying each plane; 2) choosing the six face planes of the input's bounding box; 3) choosing the eight vertex planes of the input's bounding box; 4) choosing the twelve edge planes of the input's bounding box; and/or 5) using a recursively subdivided octahedron. Note that when specifying planes, the plane normals should point outside of the convex region.

The output of this filter can be used in combination with vtkLODActor to represent a levels-of-detail in the LOD hierarchy. Another use of this class is to manually specify the planes, and then generate the polyhedron from the planes (without squeezing the planes towards the input). The method GenerateHull() is used to do this.


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

Add the 12 planes that represent the edges of a cube - halfway between the two connecting face planes - (1,1,0), (-1,-1,0), (-1,1,0), (1,-1,0), (0,1,1), (0,-1,-1), (0,1,-1), (0,-1,1), (1,0,1), (-1,0,-1), (1,0,-1), (-1,0,1)

Add the six planes that make up the faces of a cube - (1,0,0), (-1, 0, 0), (0,1,0), (0,-1,0), (0,0,1), (0,0,-1)

Add the 8 planes that represent the vertices of a cube - the combination of the three face planes connecting to a vertex - (1,1,1), (1,1,-1), (1,-1,1), (1,-1,1), (-1,1,1), (-1,1,-1), (-1,-1,1), (-1,-1-1).

int Kitware.VTK.vtkHull.AddPlane ( double  A,
double  B,
double  C 
)

Add a plane to the current set of planes. It will be added at the end of the list, and an index that can later be used to set this plane's normal will be returned. The values A, B, C are from the plane equation Ax + By + Cz + D = 0. This vector does not have to have unit length (but it must have a non-zero length!). If a value 0 > i >= -NumberOfPlanes is returned, then the plane is parallel with a previously inserted plane, and |-i-1| is the index of the plane that was previously inserted. If a value i < -NumberOfPlanes is returned, then the plane normal is zero length.

int Kitware.VTK.vtkHull.AddPlane ( IntPtr  plane)

Add a plane to the current set of planes. It will be added at the end of the list, and an index that can later be used to set this plane's normal will be returned. The values A, B, C are from the plane equation Ax + By + Cz + D = 0. This vector does not have to have unit length (but it must have a non-zero length!). If a value 0 > i >= -NumberOfPlanes is returned, then the plane is parallel with a previously inserted plane, and |-i-1| is the index of the plane that was previously inserted. If a value i < -NumberOfPlanes is returned, then the plane normal is zero length.

int Kitware.VTK.vtkHull.AddPlane ( double  A,
double  B,
double  C,
double  D 
)

Variations of AddPlane()/SetPlane() that allow D to be set. These methods are used when GenerateHull() is used.

int Kitware.VTK.vtkHull.AddPlane ( IntPtr  plane,
double  D 
)

Variations of AddPlane()/SetPlane() that allow D to be set. These methods are used when GenerateHull() is used.

Add the planes that represent the normals of the vertices of a polygonal sphere formed by recursively subdividing the triangles in an octahedron. Each triangle is subdivided by connecting the midpoints of the edges thus forming 4 smaller triangles. The level indicates how many subdivisions to do with a level of 0 used to add the 6 planes from the original octahedron, level 1 will add 18 planes, and so on.

override void Kitware.VTK.vtkHull.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.

void Kitware.VTK.vtkHull.GenerateHull ( vtkPolyData  pd,
IntPtr  bounds 
)

A special method that is used to generate a polyhedron directly from a set of n planes. The planes that are supplied by the user are not squeezed towards the input data (in fact the user need not specify an input). To use this method, you must provide an instance of vtkPolyData into which the points and cells defining the polyhedron are placed. You must also provide a bounding box where you expect the resulting polyhedron to lie. This can be a very generous fit, it's only used to create the initial polygons that are eventually clipped.

void Kitware.VTK.vtkHull.GenerateHull ( vtkPolyData  pd,
double  xmin,
double  xmax,
double  ymin,
double  ymax,
double  zmin,
double  zmax 
)

A special method that is used to generate a polyhedron directly from a set of n planes. The planes that are supplied by the user are not squeezed towards the input data (in fact the user need not specify an input). To use this method, you must provide an instance of vtkPolyData into which the points and cells defining the polyhedron are placed. You must also provide a bounding box where you expect the resulting polyhedron to lie. This can be a very generous fit, it's only used to create the initial polygons that are eventually clipped.

virtual int Kitware.VTK.vtkHull.GetNumberOfPlanes ( ) [virtual]

Get the number of planes in the current set of planes.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

static new vtkHull Kitware.VTK.vtkHull.New ( ) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Remove all planes from the current set of planes.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Here is the call graph for this function:

void Kitware.VTK.vtkHull.SetPlane ( int  i,
double  A,
double  B,
double  C 
)

Set the normal values for plane i. This is a plane that was already added to the current set of planes with AddPlane(), and is now being modified. The values A, B, C are from the plane equation Ax + By + Cz + D = 0. This vector does not have to have unit length. Note that D is set to zero, except in the case of the method taking a vtkPlanes* argument, where it is set to the D value defined there.

void Kitware.VTK.vtkHull.SetPlane ( int  i,
IntPtr  plane 
)

Set the normal values for plane i. This is a plane that was already added to the current set of planes with AddPlane(), and is now being modified. The values A, B, C are from the plane equation Ax + By + Cz + D = 0. This vector does not have to have unit length. Note that D is set to zero, except in the case of the method taking a vtkPlanes* argument, where it is set to the D value defined there.

void Kitware.VTK.vtkHull.SetPlane ( int  i,
double  A,
double  B,
double  C,
double  D 
)

Variations of AddPlane()/SetPlane() that allow D to be set. These methods are used when GenerateHull() is used.

void Kitware.VTK.vtkHull.SetPlane ( int  i,
IntPtr  plane,
double  D 
)

Variations of AddPlane()/SetPlane() that allow D to be set. These methods are used when GenerateHull() is used.

Set all the planes at once using a vtkPlanes implicit function. This also sets the D value, so it can be used with GenerateHull().

static internal void Kitware.VTK.vtkHull.vtkHull_AddCubeEdgePlanes_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkHull.vtkHull_AddCubeFacePlanes_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkHull.vtkHull_AddCubeVertexPlanes_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHull.vtkHull_AddPlane_04 ( HandleRef  pThis,
double  A,
double  B,
double  C 
) [private]
static internal int Kitware.VTK.vtkHull.vtkHull_AddPlane_05 ( HandleRef  pThis,
IntPtr  plane 
) [private]
static internal int Kitware.VTK.vtkHull.vtkHull_AddPlane_06 ( HandleRef  pThis,
double  A,
double  B,
double  C,
double  D 
) [private]
static internal int Kitware.VTK.vtkHull.vtkHull_AddPlane_07 ( HandleRef  pThis,
IntPtr  plane,
double  D 
) [private]
static internal void Kitware.VTK.vtkHull.vtkHull_AddRecursiveSpherePlanes_08 ( HandleRef  pThis,
int  level 
) [private]
static internal void Kitware.VTK.vtkHull.vtkHull_GenerateHull_09 ( HandleRef  pThis,
HandleRef  pd,
IntPtr  bounds 
) [private]
static internal void Kitware.VTK.vtkHull.vtkHull_GenerateHull_10 ( HandleRef  pThis,
HandleRef  pd,
double  xmin,
double  xmax,
double  ymin,
double  ymax,
double  zmin,
double  zmax 
) [private]
static internal int Kitware.VTK.vtkHull.vtkHull_GetNumberOfPlanes_11 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkHull.vtkHull_IsA_12 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkHull.vtkHull_IsTypeOf_13 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkHull.vtkHull_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkHull.vtkHull_NewInstance_15 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkHull.vtkHull_RemoveAllPlanes_16 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkHull.vtkHull_SafeDownCast_17 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkHull.vtkHull_SetPlane_18 ( HandleRef  pThis,
int  i,
double  A,
double  B,
double  C 
) [private]
static internal void Kitware.VTK.vtkHull.vtkHull_SetPlane_19 ( HandleRef  pThis,
int  i,
IntPtr  plane 
) [private]
static internal void Kitware.VTK.vtkHull.vtkHull_SetPlane_20 ( HandleRef  pThis,
int  i,
double  A,
double  B,
double  C,
double  D 
) [private]
static internal void Kitware.VTK.vtkHull.vtkHull_SetPlane_21 ( HandleRef  pThis,
int  i,
IntPtr  plane,
double  D 
) [private]
static internal void Kitware.VTK.vtkHull.vtkHull_SetPlanes_22 ( HandleRef  pThis,
HandleRef  planes 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkHull.MRClassNameKey = "7vtkHull" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.


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