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

Inheritance diagram for Kitware.VTK.vtkPlanes:

Collaboration diagram for Kitware.VTK.vtkPlanes:

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.
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 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.
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 = "9vtkPlanes"
	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	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 ( )

staticprivate

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.

Kitware.VTK.vtkPlanes.vtkPlanes ( )

*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.

virtual vtkDataArray Kitware.VTK.vtkPlanes.GetNormals ( )

virtual

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:

int Kitware.VTK.vtkPlanes.GetNumberOfPlanes ( )

Return the number of planes in the set of planes.

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

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.

virtual vtkPoints Kitware.VTK.vtkPlanes.GetPoints ( )

virtual

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.

new vtkPlanes Kitware.VTK.vtkPlanes.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkImplicitFunction.

Reimplemented in Kitware.VTK.vtkPlanesIntersection.

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

static

*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.

void Kitware.VTK.vtkPlanes.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 Kitware.VTK.vtkPlanes.SetPoints ( vtkPoints arg0 )

virtual

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