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

vtkPlanes - implicit function for convex set of planes More...

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

List of all members.

Public Member Functions

 vtkPlanes (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkPlanes ()
 Undocumented Block.
override double EvaluateFunction (IntPtr x)
 Description Evaluate plane equations. Return smallest absolute value.
new double EvaluateFunction (double x, double y, double z)
 Description Evaluate plane equations. Return smallest absolute value.
override void EvaluateGradient (IntPtr x, IntPtr n)
 Description Evaluate planes gradient.
virtual vtkDataArray GetNormals ()
 Specify a list of normal vectors for the planes. There is a one-to-one correspondence between plane points and plane normals.
int GetNumberOfPlanes ()
 Return the number of planes in the set of planes.
vtkPlane GetPlane (int i)
 Create and return a pointer to a vtkPlane object at the ith position. Asking for a plane outside the allowable range returns NULL. This method always returns the same object. Use GetPlane(int i, vtkPlane *plane) instead.
void GetPlane (int i, vtkPlane plane)
 Create and return a pointer to a vtkPlane object at the ith position. Asking for a plane outside the allowable range returns NULL. This method always returns the same object. Use GetPlane(int i, vtkPlane *plane) instead.
virtual vtkPoints GetPoints ()
 Specify a list of points defining points through which the planes pass.
override int IsA (string type)
 Undocumented Block.
new vtkPlanes NewInstance ()
 Undocumented Block.
void SetBounds (IntPtr bounds)
 An alternative method to specify six planes defined by a bounding box. The bounding box is a six-vector defined as (xmin,xmax,ymin,ymax,zmin,zmax). It defines six planes orthogonal to the x-y-z coordinate axes.
void SetBounds (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
 An alternative method to specify six planes defined by a bounding box. The bounding box is a six-vector defined as (xmin,xmax,ymin,ymax,zmin,zmax). It defines six planes orthogonal to the x-y-z coordinate axes.
void SetFrustumPlanes (IntPtr planes)
 An alternative method to specify six planes defined by the camera view frustrum. See vtkCamera::GetFrustumPlanes() documentation.
void SetNormals (vtkDataArray normals)
 Specify a list of normal vectors for the planes. There is a one-to-one correspondence between plane points and plane normals.
virtual void SetPoints (vtkPoints arg0)
 Specify a list of points defining points through which the planes pass.

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "9vtkPlanes"
 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 vtkPlanes_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal double vtkPlanes_EvaluateFunction_01 (HandleRef pThis, IntPtr x)
static internal double vtkPlanes_EvaluateFunction_02 (HandleRef pThis, double x, double y, double z)
static internal void vtkPlanes_EvaluateGradient_03 (HandleRef pThis, IntPtr x, IntPtr n)
static internal IntPtr vtkPlanes_GetNormals_04 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkPlanes_GetNumberOfPlanes_05 (HandleRef pThis)
static internal IntPtr vtkPlanes_GetPlane_06 (HandleRef pThis, int i, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPlanes_GetPlane_07 (HandleRef pThis, int i, HandleRef plane)
static internal IntPtr vtkPlanes_GetPoints_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkPlanes_IsA_09 (HandleRef pThis, string type)
static internal int vtkPlanes_IsTypeOf_10 (string type)
static internal IntPtr vtkPlanes_NewInstance_12 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkPlanes_SafeDownCast_13 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPlanes_SetBounds_14 (HandleRef pThis, IntPtr bounds)
static internal void vtkPlanes_SetBounds_15 (HandleRef pThis, double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
static internal void vtkPlanes_SetFrustumPlanes_16 (HandleRef pThis, IntPtr planes)
static internal void vtkPlanes_SetNormals_17 (HandleRef pThis, HandleRef normals)
static internal void vtkPlanes_SetPoints_18 (HandleRef pThis, HandleRef arg0)

Static Private Member Functions

static vtkPlanes ()
 Automatically generated type registration mechanics.

Detailed Description

vtkPlanes - implicit function for convex set of planes

Description vtkPlanes computes the implicit function and function gradient for a set of planes. The planes must define a convex space.

The function value is the closest first order distance of a point to the convex region defined by the planes. The function gradient is the plane normal at the function value. Note that the normals must point outside of the convex region. Thus, a negative function value means that a point is inside the convex region.

There are several methods to define the set of planes. The most general is to supply an instance of vtkPoints and an instance of vtkDataArray. (The points define a point on the plane, and the normals corresponding plane normals.) Two other specialized ways are to 1) supply six planes defining the view frustrum of a camera, and 2) provide a bounding box.


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

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

Reimplemented in Kitware.VTK.vtkPlanesIntersection.

override double Kitware.VTK.vtkPlanes.EvaluateFunction ( IntPtr  x) [virtual]

Description Evaluate plane equations. Return smallest absolute value.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

new double Kitware.VTK.vtkPlanes.EvaluateFunction ( double  x,
double  y,
double  z 
)

Description Evaluate plane equations. Return smallest absolute value.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

override void Kitware.VTK.vtkPlanes.EvaluateGradient ( IntPtr  x,
IntPtr  n 
) [virtual]

Description Evaluate planes gradient.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

Specify a list of normal vectors for the planes. There is a one-to-one correspondence between plane points and plane normals.

Here is the call graph for this function:

Return the number of planes in the set of planes.

Create and return a pointer to a vtkPlane object at the ith position. Asking for a plane outside the allowable range returns NULL. This method always returns the same object. Use GetPlane(int i, vtkPlane *plane) instead.

Here is the call graph for this function:

void Kitware.VTK.vtkPlanes.GetPlane ( int  i,
vtkPlane  plane 
)

Create and return a pointer to a vtkPlane object at the ith position. Asking for a plane outside the allowable range returns NULL. This method always returns the same object. Use GetPlane(int i, vtkPlane *plane) instead.

Specify a list of points defining points through which the planes pass.

Here is the call graph for this function:

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

Reimplemented in Kitware.VTK.vtkPlanesIntersection.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

Reimplemented in Kitware.VTK.vtkPlanesIntersection.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkPlanesIntersection.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

Reimplemented in Kitware.VTK.vtkPlanesIntersection.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

Reimplemented in Kitware.VTK.vtkPlanesIntersection.

Here is the call graph for this function:

void Kitware.VTK.vtkPlanes.SetBounds ( IntPtr  bounds)

An alternative method to specify six planes defined by a bounding box. The bounding box is a six-vector defined as (xmin,xmax,ymin,ymax,zmin,zmax). It defines six planes orthogonal to the x-y-z coordinate axes.

void Kitware.VTK.vtkPlanes.SetBounds ( double  xmin,
double  xmax,
double  ymin,
double  ymax,
double  zmin,
double  zmax 
)

An alternative method to specify six planes defined by a bounding box. The bounding box is a six-vector defined as (xmin,xmax,ymin,ymax,zmin,zmax). It defines six planes orthogonal to the x-y-z coordinate axes.

void Kitware.VTK.vtkPlanes.SetFrustumPlanes ( IntPtr  planes)

An alternative method to specify six planes defined by the camera view frustrum. See vtkCamera::GetFrustumPlanes() documentation.

Specify a list of normal vectors for the planes. There is a one-to-one correspondence between plane points and plane normals.

virtual void Kitware.VTK.vtkPlanes.SetPoints ( vtkPoints  arg0) [virtual]

Specify a list of points defining points through which the planes pass.

static internal double Kitware.VTK.vtkPlanes.vtkPlanes_EvaluateFunction_01 ( HandleRef  pThis,
IntPtr  x 
) [private]
static internal double Kitware.VTK.vtkPlanes.vtkPlanes_EvaluateFunction_02 ( HandleRef  pThis,
double  x,
double  y,
double  z 
) [private]
static internal void Kitware.VTK.vtkPlanes.vtkPlanes_EvaluateGradient_03 ( HandleRef  pThis,
IntPtr  x,
IntPtr  n 
) [private]
static internal IntPtr Kitware.VTK.vtkPlanes.vtkPlanes_GetNormals_04 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkPlanes.vtkPlanes_GetNumberOfPlanes_05 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkPlanes.vtkPlanes_GetPlane_06 ( HandleRef  pThis,
int  i,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkPlanes.vtkPlanes_GetPlane_07 ( HandleRef  pThis,
int  i,
HandleRef  plane 
) [private]
static internal IntPtr Kitware.VTK.vtkPlanes.vtkPlanes_GetPoints_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkPlanes.vtkPlanes_IsA_09 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkPlanes.vtkPlanes_IsTypeOf_10 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkPlanes.vtkPlanes_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPlanes.vtkPlanes_NewInstance_12 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPlanes.vtkPlanes_SafeDownCast_13 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkPlanes.vtkPlanes_SetBounds_14 ( HandleRef  pThis,
IntPtr  bounds 
) [private]
static internal void Kitware.VTK.vtkPlanes.vtkPlanes_SetBounds_15 ( HandleRef  pThis,
double  xmin,
double  xmax,
double  ymin,
double  ymax,
double  zmin,
double  zmax 
) [private]
static internal void Kitware.VTK.vtkPlanes.vtkPlanes_SetFrustumPlanes_16 ( HandleRef  pThis,
IntPtr  planes 
) [private]
static internal void Kitware.VTK.vtkPlanes.vtkPlanes_SetNormals_17 ( HandleRef  pThis,
HandleRef  normals 
) [private]
static internal void Kitware.VTK.vtkPlanes.vtkPlanes_SetPoints_18 ( HandleRef  pThis,
HandleRef  arg0 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkPlanes.MRClassNameKey = "9vtkPlanes" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

Reimplemented in Kitware.VTK.vtkPlanesIntersection.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

Reimplemented in Kitware.VTK.vtkPlanesIntersection.


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