ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected 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.
- Public Member Functions inherited from Kitware.VTK.vtkImplicitFunction
 vtkImplicitFunction (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkImplicitFunction ()
 *Undocumented Block
void FunctionGradient (IntPtr x, IntPtr g)
 Evaluate function gradient at position x-y-z and pass back vector. Point x[3] is transformed through transform (if provided).
double[] FunctionGradient (IntPtr x)
 Evaluate function gradient at position x-y-z and pass back vector. Point x[3] is transformed through transform (if provided).
double[] FunctionGradient (double x, double y, double z)
 Evaluate function gradient at position x-y-z and pass back vector. Point x[3] is transformed through transform (if provided).
double FunctionValue (IntPtr x)
 Evaluate function at position x-y-z and return value. Point x[3] is transformed through transform (if provided).
double FunctionValue (double x, double y, double z)
 Evaluate function at position x-y-z and return value. Point x[3] is transformed through transform (if provided).
override uint GetMTime ()
 Overload standard modified time function. If Transform is modified, then this object is modified as well.
virtual vtkAbstractTransform GetTransform ()
 Set/Get a transformation to apply to input points before executing the implicit function.
virtual void SetTransform (vtkAbstractTransform arg0)
 Set/Get a transformation to apply to input points before executing the implicit function.
virtual void SetTransform (IntPtr elements)
 Set/Get a transformation to apply to input points before executing the implicit function.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object).
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

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.
- Public Attributes inherited from Kitware.VTK.vtkImplicitFunction
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "8vtkPlane"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkImplicitFunction
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

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.

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 ( )
staticprivate

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.

Kitware.VTK.vtkPlane.vtkPlane ( )

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.

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

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.

new vtkPlane Kitware.VTK.vtkPlane.NewInstance ( )

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.

static new vtkPlane Kitware.VTK.vtkPlane.SafeDownCast ( vtkObjectBase  o)
static

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.


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: