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

vtkPlanesIntersection - A vtkPlanesIntersection object is a vtkPlanes object that can compute whether the arbitrary convex region bounded by it's planes intersects an axis-aligned box. More...

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

List of all members.

Public Member Functions

 vtkPlanesIntersection (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkPlanesIntersection ()
 *Undocumented Block
int GetNumRegionVertices ()
 It helps if you know the vertices of the convex region. If you don't, we will calculate them. Region vertices are 3-tuples.
int GetRegionVertices (IntPtr v, int nvertices)
 It helps if you know the vertices of the convex region. If you don't, we will calculate them. Region vertices are 3-tuples.
int IntersectsRegion (vtkPoints R)
 Return 1 if the axis aligned box defined by R intersects the region defined by the planes, or 0 otherwise.
override int IsA (string type)
 *Undocumented Block
new vtkPlanesIntersection NewInstance ()
 *Undocumented Block
void SetRegionVertices (vtkPoints pts)
 It helps if you know the vertices of the convex region. If you don't, we will calculate them. Region vertices are 3-tuples.
void SetRegionVertices (IntPtr v, int nvertices)
 It helps if you know the vertices of the convex region. If you don't, we will calculate them. Region vertices are 3-tuples.
- Public Member Functions inherited from Kitware.VTK.vtkPlanes
 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.
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 vtkPlanesIntersection New ()
 *Undocumented Block
static vtkPlanesIntersection Convert3DCell (vtkCell cell)
 Another convenience function provided by this class, returns the vtkPlanesIntersection object representing a 3D cell. The point IDs for each face must be given in counter-clockwise order from the outside of the cell.
static new int IsTypeOf (string type)
 *Undocumented Block
static int PolygonIntersectsBBox (IntPtr bounds, vtkPoints pts)
 A convenience function provided by this class, returns 1 if the polygon defined in pts intersects the bounding box defined in bounds, 0 otherwise.
static new vtkPlanesIntersection SafeDownCast (vtkObjectBase o)
 *Undocumented Block

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkPlanesIntersection"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkPlanes
- 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 = "21vtkPlanesIntersection"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkPlanes
- 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 vtkPlanesIntersection ()
 Automatically generated type registration mechanics.

Detailed Description

vtkPlanesIntersection - A vtkPlanesIntersection object is a vtkPlanes object that can compute whether the arbitrary convex region bounded by it's planes intersects an axis-aligned box.

Description A subclass of vtkPlanes, this class determines whether it intersects an axis aligned box. This is motivated by the need to intersect the axis aligned region of a spacial decomposition of volume data with various other regions. It uses the algorithm from Graphics Gems IV, page 81.

Caveat An instance of vtkPlanes can be redefined by changing the planes, but this subclass then will not know if the region vertices are up to date. (Region vertices can be specified in SetRegionVertices or computed by the subclass.) So Delete and recreate if you want to change the set of planes.


Constructor & Destructor Documentation

static Kitware.VTK.vtkPlanesIntersection.vtkPlanesIntersection ( )
staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkPlanesIntersection.vtkPlanesIntersection ( )

*Undocumented Block


Member Function Documentation

static vtkPlanesIntersection Kitware.VTK.vtkPlanesIntersection.Convert3DCell ( vtkCell  cell)
static

Another convenience function provided by this class, returns the vtkPlanesIntersection object representing a 3D cell. The point IDs for each face must be given in counter-clockwise order from the outside of the cell.

Here is the call graph for this function:

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

int Kitware.VTK.vtkPlanesIntersection.GetNumRegionVertices ( )

It helps if you know the vertices of the convex region. If you don't, we will calculate them. Region vertices are 3-tuples.

int Kitware.VTK.vtkPlanesIntersection.GetRegionVertices ( IntPtr  v,
int  nvertices 
)

It helps if you know the vertices of the convex region. If you don't, we will calculate them. Region vertices are 3-tuples.

int Kitware.VTK.vtkPlanesIntersection.IntersectsRegion ( vtkPoints  R)

Return 1 if the axis aligned box defined by R intersects the region defined by the planes, or 0 otherwise.

override int Kitware.VTK.vtkPlanesIntersection.IsA ( string  type)
virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPlanes.

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

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPlanes.

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

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPlanes.

new vtkPlanesIntersection Kitware.VTK.vtkPlanesIntersection.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPlanes.

static int Kitware.VTK.vtkPlanesIntersection.PolygonIntersectsBBox ( IntPtr  bounds,
vtkPoints  pts 
)
static

A convenience function provided by this class, returns 1 if the polygon defined in pts intersects the bounding box defined in bounds, 0 otherwise.

The points must define a planar polygon.

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

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPlanes.

Here is the call graph for this function:

void Kitware.VTK.vtkPlanesIntersection.SetRegionVertices ( vtkPoints  pts)

It helps if you know the vertices of the convex region. If you don't, we will calculate them. Region vertices are 3-tuples.

void Kitware.VTK.vtkPlanesIntersection.SetRegionVertices ( IntPtr  v,
int  nvertices 
)

It helps if you know the vertices of the convex region. If you don't, we will calculate them. Region vertices are 3-tuples.


Member Data Documentation

new readonly string Kitware.VTK.vtkPlanesIntersection.MRClassNameKey = "21vtkPlanesIntersection"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPlanes.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPlanes.


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