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

vtkPlane - perform various plane computations More...

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

List of all members.

Public Member Functions

 vtkPlane (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkPlane ()
 Description Construct plane passing through origin and normal to z-axis.
double DistanceToPlane (IntPtr x)
 Return the distance of a point x to a plane defined by n(x-p0) = 0. The normal n[3] must be magnitude=1.
override double EvaluateFunction (IntPtr x)
 Description Evaluate plane equation for point x[3].
new double EvaluateFunction (double x, double y, double z)
 Description Evaluate plane equation for point x[3].
override void EvaluateGradient (IntPtr x, IntPtr g)
 Description Evaluate function gradient at point x[3].
void GeneralizedProjectPoint (IntPtr x, IntPtr xproj)
 Description Project a point x onto plane defined by origin and normal. The projected point is returned in xproj. NOTE : normal does NOT have to have magnitude 1.
virtual double[] GetNormal ()
 Set/get plane normal. Plane is defined by point and normal.
virtual void GetNormal (IntPtr data)
 Set/get plane normal. Plane is defined by point and normal.
virtual double[] GetOrigin ()
 Set/get point through which plane passes. Plane is defined by point and normal.
virtual void GetOrigin (IntPtr data)
 Set/get point through which plane passes. Plane is defined by point and normal.
int IntersectWithLine (IntPtr p1, IntPtr p2, ref double t, IntPtr x)
 Given a line defined by the two points p1,p2; and a plane defined by the normal n and point p0, compute an intersection. The parametric coordinate along the line is returned in t, and the coordinates of intersection are returned in x. A zero is returned if the plane and line do not intersect between (0<=t<=1). If the plane and line are parallel, zero is returned and t is set to VTK_LARGE_DOUBLE.
override int IsA (string type)
 Description Construct plane passing through origin and normal to z-axis.
new vtkPlane NewInstance ()
 Description Construct plane passing through origin and normal to z-axis.
void ProjectPoint (IntPtr x, IntPtr xproj)
 Description Project a point x onto plane defined by origin and normal. The projected point is returned in xproj. NOTE : normal assumed to have magnitude 1.
void Push (double distance)
 Translate the plane in the direction of the normal by the distance specified. Negative values move the plane in the opposite direction.
virtual void SetNormal (double _arg1, double _arg2, double _arg3)
 Set/get plane normal. Plane is defined by point and normal.
virtual void SetNormal (IntPtr _arg)
 Set/get plane normal. Plane is defined by point and normal.
virtual void SetOrigin (double _arg1, double _arg2, double _arg3)
 Set/get point through which plane passes. Plane is defined by point and normal.
virtual void SetOrigin (IntPtr _arg)
 Set/get point through which plane passes. Plane is defined by point and normal.

Static Public Member Functions

static new vtkPlane New ()
 Description Construct plane passing through origin and normal to z-axis.
static double DistanceToPlane (IntPtr x, IntPtr n, IntPtr p0)
 Given a line defined by the two points p1,p2; and a plane defined by the normal n and point p0, compute an intersection. The parametric coordinate along the line is returned in t, and the coordinates of intersection are returned in x. A zero is returned if the plane and line do not intersect between (0<=t<=1). If the plane and line are parallel, zero is returned and t is set to VTK_LARGE_DOUBLE.
static double Evaluate (IntPtr normal, IntPtr origin, IntPtr x)
 Given a line defined by the two points p1,p2; and a plane defined by the normal n and point p0, compute an intersection. The parametric coordinate along the line is returned in t, and the coordinates of intersection are returned in x. A zero is returned if the plane and line do not intersect between (0<=t<=1). If the plane and line are parallel, zero is returned and t is set to VTK_LARGE_DOUBLE.
static void GeneralizedProjectPoint (IntPtr x, IntPtr origin, IntPtr normal, IntPtr xproj)
 Description Project a point x onto plane defined by origin and normal. The projected point is returned in xproj. NOTE : normal does NOT have to have magnitude 1.
static int IntersectWithLine (IntPtr p1, IntPtr p2, IntPtr n, IntPtr p0, ref double t, IntPtr x)
 Given a line defined by the two points p1,p2; and a plane defined by the normal n and point p0, compute an intersection. The parametric coordinate along the line is returned in t, and the coordinates of intersection are returned in x. A zero is returned if the plane and line do not intersect between (0<=t<=1). If the plane and line are parallel, zero is returned and t is set to VTK_LARGE_DOUBLE.
static new int IsTypeOf (string type)
 Description Construct plane passing through origin and normal to z-axis.
static void ProjectPoint (IntPtr x, IntPtr origin, IntPtr normal, IntPtr xproj)
 Description Project a point x onto plane defined by origin and normal. The projected point is returned in xproj. NOTE : normal assumed to have magnitude 1.
static new vtkPlane SafeDownCast (vtkObjectBase o)
 Description Construct plane passing through origin and normal to z-axis.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "8vtkPlane"
 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 vtkPlane_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal double vtkPlane_DistanceToPlane_01 (IntPtr x, IntPtr n, IntPtr p0)
static internal double vtkPlane_DistanceToPlane_02 (HandleRef pThis, IntPtr x)
static internal double vtkPlane_Evaluate_03 (IntPtr normal, IntPtr origin, IntPtr x)
static internal double vtkPlane_EvaluateFunction_04 (HandleRef pThis, IntPtr x)
static internal double vtkPlane_EvaluateFunction_05 (HandleRef pThis, double x, double y, double z)
static internal void vtkPlane_EvaluateGradient_06 (HandleRef pThis, IntPtr x, IntPtr g)
static internal void vtkPlane_GeneralizedProjectPoint_07 (IntPtr x, IntPtr origin, IntPtr normal, IntPtr xproj)
static internal void vtkPlane_GeneralizedProjectPoint_08 (HandleRef pThis, IntPtr x, IntPtr xproj)
static internal IntPtr vtkPlane_GetNormal_09 (HandleRef pThis)
static internal void vtkPlane_GetNormal_10 (HandleRef pThis, IntPtr data)
static internal IntPtr vtkPlane_GetOrigin_11 (HandleRef pThis)
static internal void vtkPlane_GetOrigin_12 (HandleRef pThis, IntPtr data)
static internal int vtkPlane_IntersectWithLine_13 (IntPtr p1, IntPtr p2, IntPtr n, IntPtr p0, ref double t, IntPtr x)
static internal int vtkPlane_IntersectWithLine_14 (HandleRef pThis, IntPtr p1, IntPtr p2, ref double t, IntPtr x)
static internal int vtkPlane_IsA_15 (HandleRef pThis, string type)
static internal int vtkPlane_IsTypeOf_16 (string type)
static internal IntPtr vtkPlane_NewInstance_18 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPlane_ProjectPoint_19 (IntPtr x, IntPtr origin, IntPtr normal, IntPtr xproj)
static internal void vtkPlane_ProjectPoint_20 (HandleRef pThis, IntPtr x, IntPtr xproj)
static internal void vtkPlane_Push_21 (HandleRef pThis, double distance)
static internal IntPtr vtkPlane_SafeDownCast_22 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPlane_SetNormal_23 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkPlane_SetNormal_24 (HandleRef pThis, IntPtr _arg)
static internal void vtkPlane_SetOrigin_25 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkPlane_SetOrigin_26 (HandleRef pThis, IntPtr _arg)

Static Private Member Functions

static vtkPlane ()
 Automatically generated type registration mechanics.

Detailed Description

vtkPlane - perform various plane computations

Description vtkPlane provides methods for various plane computations. These include projecting points onto a plane, evaluating the plane equation, and returning plane normal. vtkPlane is a concrete implementation of the abstract class vtkImplicitFunction.


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Description Construct plane passing through origin and normal to z-axis.


Member Function Documentation

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

static double Kitware.VTK.vtkPlane.DistanceToPlane ( IntPtr  x,
IntPtr  n,
IntPtr  p0 
) [static]

Given a line defined by the two points p1,p2; and a plane defined by the normal n and point p0, compute an intersection. The parametric coordinate along the line is returned in t, and the coordinates of intersection are returned in x. A zero is returned if the plane and line do not intersect between (0<=t<=1). If the plane and line are parallel, zero is returned and t is set to VTK_LARGE_DOUBLE.

Return the distance of a point x to a plane defined by n(x-p0) = 0. The normal n[3] must be magnitude=1.

static double Kitware.VTK.vtkPlane.Evaluate ( IntPtr  normal,
IntPtr  origin,
IntPtr  x 
) [static]

Given a line defined by the two points p1,p2; and a plane defined by the normal n and point p0, compute an intersection. The parametric coordinate along the line is returned in t, and the coordinates of intersection are returned in x. A zero is returned if the plane and line do not intersect between (0<=t<=1). If the plane and line are parallel, zero is returned and t is set to VTK_LARGE_DOUBLE.

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

Description Evaluate plane equation for point x[3].

Reimplemented from Kitware.VTK.vtkImplicitFunction.

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

Description Evaluate plane equation for point x[3].

Reimplemented from Kitware.VTK.vtkImplicitFunction.

override void Kitware.VTK.vtkPlane.EvaluateGradient ( IntPtr  x,
IntPtr  g 
) [virtual]

Description Evaluate function gradient at point x[3].

Reimplemented from Kitware.VTK.vtkImplicitFunction.

static void Kitware.VTK.vtkPlane.GeneralizedProjectPoint ( IntPtr  x,
IntPtr  origin,
IntPtr  normal,
IntPtr  xproj 
) [static]

Description Project a point x onto plane defined by origin and normal. The projected point is returned in xproj. NOTE : normal does NOT have to have magnitude 1.

void Kitware.VTK.vtkPlane.GeneralizedProjectPoint ( IntPtr  x,
IntPtr  xproj 
)

Description Project a point x onto plane defined by origin and normal. The projected point is returned in xproj. NOTE : normal does NOT have to have magnitude 1.

virtual double [] Kitware.VTK.vtkPlane.GetNormal ( ) [virtual]

Set/get plane normal. Plane is defined by point and normal.

virtual void Kitware.VTK.vtkPlane.GetNormal ( IntPtr  data) [virtual]

Set/get plane normal. Plane is defined by point and normal.

virtual double [] Kitware.VTK.vtkPlane.GetOrigin ( ) [virtual]

Set/get point through which plane passes. Plane is defined by point and normal.

virtual void Kitware.VTK.vtkPlane.GetOrigin ( IntPtr  data) [virtual]

Set/get point through which plane passes. Plane is defined by point and normal.

static int Kitware.VTK.vtkPlane.IntersectWithLine ( IntPtr  p1,
IntPtr  p2,
IntPtr  n,
IntPtr  p0,
ref double  t,
IntPtr  x 
) [static]

Given a line defined by the two points p1,p2; and a plane defined by the normal n and point p0, compute an intersection. The parametric coordinate along the line is returned in t, and the coordinates of intersection are returned in x. A zero is returned if the plane and line do not intersect between (0<=t<=1). If the plane and line are parallel, zero is returned and t is set to VTK_LARGE_DOUBLE.

int Kitware.VTK.vtkPlane.IntersectWithLine ( IntPtr  p1,
IntPtr  p2,
ref double  t,
IntPtr  x 
)

Given a line defined by the two points p1,p2; and a plane defined by the normal n and point p0, compute an intersection. The parametric coordinate along the line is returned in t, and the coordinates of intersection are returned in x. A zero is returned if the plane and line do not intersect between (0<=t<=1). If the plane and line are parallel, zero is returned and t is set to VTK_LARGE_DOUBLE.

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

Description Construct plane passing through origin and normal to z-axis.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

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

Description Construct plane passing through origin and normal to z-axis.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

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

Description Construct plane passing through origin and normal to z-axis.

Reimplemented from Kitware.VTK.vtkObject.

Description Construct plane passing through origin and normal to z-axis.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

static void Kitware.VTK.vtkPlane.ProjectPoint ( IntPtr  x,
IntPtr  origin,
IntPtr  normal,
IntPtr  xproj 
) [static]

Description Project a point x onto plane defined by origin and normal. The projected point is returned in xproj. NOTE : normal assumed to have magnitude 1.

void Kitware.VTK.vtkPlane.ProjectPoint ( IntPtr  x,
IntPtr  xproj 
)

Description Project a point x onto plane defined by origin and normal. The projected point is returned in xproj. NOTE : normal assumed to have magnitude 1.

void Kitware.VTK.vtkPlane.Push ( double  distance)

Translate the plane in the direction of the normal by the distance specified. Negative values move the plane in the opposite direction.

Description Construct plane passing through origin and normal to z-axis.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkPlane.SetNormal ( double  _arg1,
double  _arg2,
double  _arg3 
) [virtual]

Set/get plane normal. Plane is defined by point and normal.

virtual void Kitware.VTK.vtkPlane.SetNormal ( IntPtr  _arg) [virtual]

Set/get plane normal. Plane is defined by point and normal.

virtual void Kitware.VTK.vtkPlane.SetOrigin ( double  _arg1,
double  _arg2,
double  _arg3 
) [virtual]

Set/get point through which plane passes. Plane is defined by point and normal.

virtual void Kitware.VTK.vtkPlane.SetOrigin ( IntPtr  _arg) [virtual]

Set/get point through which plane passes. Plane is defined by point and normal.

static internal double Kitware.VTK.vtkPlane.vtkPlane_DistanceToPlane_01 ( IntPtr  x,
IntPtr  n,
IntPtr  p0 
) [private]
static internal double Kitware.VTK.vtkPlane.vtkPlane_DistanceToPlane_02 ( HandleRef  pThis,
IntPtr  x 
) [private]
static internal double Kitware.VTK.vtkPlane.vtkPlane_Evaluate_03 ( IntPtr  normal,
IntPtr  origin,
IntPtr  x 
) [private]
static internal double Kitware.VTK.vtkPlane.vtkPlane_EvaluateFunction_04 ( HandleRef  pThis,
IntPtr  x 
) [private]
static internal double Kitware.VTK.vtkPlane.vtkPlane_EvaluateFunction_05 ( HandleRef  pThis,
double  x,
double  y,
double  z 
) [private]
static internal void Kitware.VTK.vtkPlane.vtkPlane_EvaluateGradient_06 ( HandleRef  pThis,
IntPtr  x,
IntPtr  g 
) [private]
static internal void Kitware.VTK.vtkPlane.vtkPlane_GeneralizedProjectPoint_07 ( IntPtr  x,
IntPtr  origin,
IntPtr  normal,
IntPtr  xproj 
) [private]
static internal void Kitware.VTK.vtkPlane.vtkPlane_GeneralizedProjectPoint_08 ( HandleRef  pThis,
IntPtr  x,
IntPtr  xproj 
) [private]
static internal IntPtr Kitware.VTK.vtkPlane.vtkPlane_GetNormal_09 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlane.vtkPlane_GetNormal_10 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal IntPtr Kitware.VTK.vtkPlane.vtkPlane_GetOrigin_11 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkPlane.vtkPlane_GetOrigin_12 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal int Kitware.VTK.vtkPlane.vtkPlane_IntersectWithLine_13 ( IntPtr  p1,
IntPtr  p2,
IntPtr  n,
IntPtr  p0,
ref double  t,
IntPtr  x 
) [private]
static internal int Kitware.VTK.vtkPlane.vtkPlane_IntersectWithLine_14 ( HandleRef  pThis,
IntPtr  p1,
IntPtr  p2,
ref double  t,
IntPtr  x 
) [private]
static internal int Kitware.VTK.vtkPlane.vtkPlane_IsA_15 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkPlane.vtkPlane_IsTypeOf_16 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkPlane.vtkPlane_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPlane.vtkPlane_NewInstance_18 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkPlane.vtkPlane_ProjectPoint_19 ( IntPtr  x,
IntPtr  origin,
IntPtr  normal,
IntPtr  xproj 
) [private]
static internal void Kitware.VTK.vtkPlane.vtkPlane_ProjectPoint_20 ( HandleRef  pThis,
IntPtr  x,
IntPtr  xproj 
) [private]
static internal void Kitware.VTK.vtkPlane.vtkPlane_Push_21 ( HandleRef  pThis,
double  distance 
) [private]
static internal IntPtr Kitware.VTK.vtkPlane.vtkPlane_SafeDownCast_22 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkPlane.vtkPlane_SetNormal_23 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkPlane.vtkPlane_SetNormal_24 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkPlane.vtkPlane_SetOrigin_25 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkPlane.vtkPlane_SetOrigin_26 ( HandleRef  pThis,
IntPtr  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkPlane.MRClassNameKey = "8vtkPlane" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImplicitFunction.


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