vtkBox - implicit function for a bounding box More...

Inheritance diagram for Kitware.VTK.vtkBox:

Collaboration diagram for Kitware.VTK.vtkBox:

Public Member Functions
	vtkBox (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkBox ()
	Description Construct box with center at (0,0,0) and each side of length 1.0.
void	AddBounds (IntPtr bounds)
	A special method that allows union set operation on bounding boxes. Start with a SetBounds(). Subsequent AddBounds() methods are union set operations on the original bounds. Retrieve the final bounds with a GetBounds() method.
override double	EvaluateFunction (IntPtr x)
	Description Evaluate box defined by the two points (pMin,pMax).
new double	EvaluateFunction (double x, double y, double z)
	Description Evaluate box defined by the two points (pMin,pMax).
override void	EvaluateGradient (IntPtr x, IntPtr n)
	Description Evaluate the gradient of the box.
void	GetBounds (ref double xMin, ref double xMax, ref double yMin, ref double yMax, ref double zMin, ref double zMax)
	Set / get the bounding box using various methods.
void	GetBounds (IntPtr bounds)
	Set / get the bounding box using various methods.
IntPtr	GetBounds ()
	Set / get the bounding box using various methods.
void	GetXMax (IntPtr p)
	Set / get the bounding box using various methods.
void	GetXMax (ref double x, ref double y, ref double z)
	Set / get the bounding box using various methods.
void	GetXMin (IntPtr p)
	Set / get the bounding box using various methods.
void	GetXMin (ref double x, ref double y, ref double z)
	Set / get the bounding box using various methods.
override int	IsA (string type)
	*Undocumented Block
new vtkBox	NewInstance ()
	*Undocumented Block
void	SetBounds (double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)
	Set / get the bounding box using various methods.
void	SetBounds (IntPtr bounds)
	Set / get the bounding box using various methods.
void	SetXMax (IntPtr p)
	Intersect a line with the box. Give the endpoints of the line in p1 and p2. The parameteric distances from p1 to the entry and exit points are returned in t1 and t2, where t1 and t2 are clamped to the range [0,1]. The entry and exit planes are returned in plane1 and plane2 where integers (0, 1, 2, 3, 4, 5) stand for the (xmin, xmax, ymin, ymax, zmin, zmax) planes respectively, and a value of -1 means that no intersection occurred. The actual intersection coordinates are stored in x1 and x2, which can be set to NULL of you do not need them to be returned. The function return value will be zero if the line is wholly outside of the box.
void	SetXMax (double x, double y, double z)
	Set / get the bounding box using various methods.
void	SetXMin (IntPtr p)
	Intersect a line with the box. Give the endpoints of the line in p1 and p2. The parameteric distances from p1 to the entry and exit points are returned in t1 and t2, where t1 and t2 are clamped to the range [0,1]. The entry and exit planes are returned in plane1 and plane2 where integers (0, 1, 2, 3, 4, 5) stand for the (xmin, xmax, ymin, ymax, zmin, zmax) planes respectively, and a value of -1 means that no intersection occurred. The actual intersection coordinates are stored in x1 and x2, which can be set to NULL of you do not need them to be returned. The function return value will be zero if the line is wholly outside of the box.
void	SetXMin (double x, double y, double z)
	Set / get the bounding box using various methods.
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 vtkBox	New ()
	Description Construct box with center at (0,0,0) and each side of length 1.0.
static sbyte	IntersectBox (IntPtr bounds, IntPtr origin, IntPtr dir, IntPtr coord, ref double t)
	Bounding box intersection modified from Graphics Gems Vol I. The method returns a non-zero value if the bounding box is hit. Origin[3] starts the ray, dir[3] is the vector components of the ray in the x-y-z directions, coord[3] is the location of hit, and t is the parametric coordinate along line. (Notes: the intersection ray dir[3] is NOT normalized. Valid intersections will only occur between 0<=t<=1.)
static int	IntersectWithLine (IntPtr bounds, IntPtr p1, IntPtr p2, ref double t1, ref double t2, IntPtr x1, IntPtr x2, ref int plane1, ref int plane2)
	Intersect a line with the box. Give the endpoints of the line in p1 and p2. The parameteric distances from p1 to the entry and exit points are returned in t1 and t2, where t1 and t2 are clamped to the range [0,1]. The entry and exit planes are returned in plane1 and plane2 where integers (0, 1, 2, 3, 4, 5) stand for the (xmin, xmax, ymin, ymax, zmin, zmax) planes respectively, and a value of -1 means that no intersection occurred. The actual intersection coordinates are stored in x1 and x2, which can be set to NULL of you do not need them to be returned. The function return value will be zero if the line is wholly outside of the box.
static new int	IsTypeOf (string type)
	*Undocumented Block
static new vtkBox	SafeDownCast (vtkObjectBase o)
	*Undocumented Block

Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkBox"
	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 = "6vtkBox"
	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	vtkBox ()
	Automatically generated type registration mechanics.

Detailed Description

vtkBox - implicit function for a bounding box

Description vtkBox computes the implicit function and/or gradient for a axis-aligned bounding box. (The superclasses transform can be used to modify this orientation.) Each side of the box is orthogonal to all other sides meeting along shared edges and all faces are orthogonal to the x-y-z coordinate axes. (If you wish to orient this box differently, recall that the superclass vtkImplicitFunction supports a transformation matrix.) vtkCube is a concrete implementation of vtkImplicitFunction.

vtkCubeSource vtkImplicitFunction

Constructor & Destructor Documentation

static Kitware.VTK.vtkBox.vtkBox ( )

staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkBox.vtkBox ( )

Description Construct box with center at (0,0,0) and each side of length 1.0.

Member Function Documentation

void Kitware.VTK.vtkBox.AddBounds ( IntPtr bounds )

A special method that allows union set operation on bounding boxes. Start with a SetBounds(). Subsequent AddBounds() methods are union set operations on the original bounds. Retrieve the final bounds with a GetBounds() method.

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

override double Kitware.VTK.vtkBox.EvaluateFunction ( IntPtr x )

virtual

Description Evaluate box defined by the two points (pMin,pMax).

Reimplemented from Kitware.VTK.vtkImplicitFunction.

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

Description Evaluate box defined by the two points (pMin,pMax).

Reimplemented from Kitware.VTK.vtkImplicitFunction.

override void Kitware.VTK.vtkBox.EvaluateGradient	(	IntPtr	x,
		IntPtr	n
	)

virtual

Description Evaluate the gradient of the box.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

void Kitware.VTK.vtkBox.GetBounds	(	ref double	xMin,
		ref double	xMax,
		ref double	yMin,
		ref double	yMax,
		ref double	zMin,
		ref double	zMax
	)

Set / get the bounding box using various methods.

void Kitware.VTK.vtkBox.GetBounds ( IntPtr bounds )

Set / get the bounding box using various methods.

IntPtr Kitware.VTK.vtkBox.GetBounds ( )

Set / get the bounding box using various methods.

void Kitware.VTK.vtkBox.GetXMax ( IntPtr p )

Set / get the bounding box using various methods.

void Kitware.VTK.vtkBox.GetXMax	(	ref double	x,
		ref double	y,
		ref double	z
	)

Set / get the bounding box using various methods.

void Kitware.VTK.vtkBox.GetXMin ( IntPtr p )

Set / get the bounding box using various methods.

void Kitware.VTK.vtkBox.GetXMin	(	ref double	x,
		ref double	y,
		ref double	z
	)

Set / get the bounding box using various methods.

static sbyte Kitware.VTK.vtkBox.IntersectBox	(	IntPtr	bounds,
		IntPtr	origin,
		IntPtr	dir,
		IntPtr	coord,
		ref double	t
	)

static

Bounding box intersection modified from Graphics Gems Vol I. The method returns a non-zero value if the bounding box is hit. Origin[3] starts the ray, dir[3] is the vector components of the ray in the x-y-z directions, coord[3] is the location of hit, and t is the parametric coordinate along line. (Notes: the intersection ray dir[3] is NOT normalized. Valid intersections will only occur between 0<=t<=1.)

static int Kitware.VTK.vtkBox.IntersectWithLine	(	IntPtr	bounds,
		IntPtr	p1,
		IntPtr	p2,
		ref double	t1,
		ref double	t2,
		IntPtr	x1,
		IntPtr	x2,
		ref int	plane1,
		ref int	plane2
	)

static

Intersect a line with the box. Give the endpoints of the line in p1 and p2. The parameteric distances from p1 to the entry and exit points are returned in t1 and t2, where t1 and t2 are clamped to the range [0,1]. The entry and exit planes are returned in plane1 and plane2 where integers (0, 1, 2, 3, 4, 5) stand for the (xmin, xmax, ymin, ymax, zmin, zmax) planes respectively, and a value of -1 means that no intersection occurred. The actual intersection coordinates are stored in x1 and x2, which can be set to NULL of you do not need them to be returned. The function return value will be zero if the line is wholly outside of the box.

override int Kitware.VTK.vtkBox.IsA ( string type )

virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkImplicitFunction.

static new int Kitware.VTK.vtkBox.IsTypeOf ( string type )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkImplicitFunction.

static new vtkBox Kitware.VTK.vtkBox.New ( )

static

Description Construct box with center at (0,0,0) and each side of length 1.0.

Reimplemented from Kitware.VTK.vtkObject.

new vtkBox Kitware.VTK.vtkBox.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkImplicitFunction.

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

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkImplicitFunction.

Here is the call graph for this function:

void Kitware.VTK.vtkBox.SetBounds	(	double	xMin,
		double	xMax,
		double	yMin,
		double	yMax,
		double	zMin,
		double	zMax
	)

Set / get the bounding box using various methods.

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

Set / get the bounding box using various methods.

void Kitware.VTK.vtkBox.SetXMax ( IntPtr p )

Intersect a line with the box. Give the endpoints of the line in p1 and p2. The parameteric distances from p1 to the entry and exit points are returned in t1 and t2, where t1 and t2 are clamped to the range [0,1]. The entry and exit planes are returned in plane1 and plane2 where integers (0, 1, 2, 3, 4, 5) stand for the (xmin, xmax, ymin, ymax, zmin, zmax) planes respectively, and a value of -1 means that no intersection occurred. The actual intersection coordinates are stored in x1 and x2, which can be set to NULL of you do not need them to be returned. The function return value will be zero if the line is wholly outside of the box.

void Kitware.VTK.vtkBox.SetXMax	(	double	x,
		double	y,
		double	z
	)

Set / get the bounding box using various methods.

void Kitware.VTK.vtkBox.SetXMin ( IntPtr p )

Intersect a line with the box. Give the endpoints of the line in p1 and p2. The parameteric distances from p1 to the entry and exit points are returned in t1 and t2, where t1 and t2 are clamped to the range [0,1]. The entry and exit planes are returned in plane1 and plane2 where integers (0, 1, 2, 3, 4, 5) stand for the (xmin, xmax, ymin, ymax, zmin, zmax) planes respectively, and a value of -1 means that no intersection occurred. The actual intersection coordinates are stored in x1 and x2, which can be set to NULL of you do not need them to be returned. The function return value will be zero if the line is wholly outside of the box.