vtkAreaPicker - Picks props behind a selection rectangle on a viewport. More...

Inheritance diagram for Kitware.VTK.vtkAreaPicker:

Collaboration diagram for Kitware.VTK.vtkAreaPicker:

Public Member Functions
	vtkAreaPicker (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkAreaPicker ()
	*Undocumented Block
virtual int	AreaPick (double x0, double y0, double x1, double y1, vtkRenderer renderer)
	Perform pick operation in volume behind the given screen coordinates. Props intersecting the selection frustum will be accessible via GetProp3D. GetPlanes returns a vtkImplicitFunciton suitable for vtkExtractGeometry.
virtual vtkPoints	GetClipPoints ()
	Return eight points that define the selection frustum.
virtual vtkDataSet	GetDataSet ()
	Get a pointer to the dataset that was picked (if any). If nothing was picked then NULL is returned.
virtual vtkPlanes	GetFrustum ()
	Return the six planes that define the selection frustum. The implicit function defined by the planes evaluates to negative inside and positive outside.
virtual vtkAbstractMapper3D	GetMapper ()
	Return mapper that was picked (if any).
vtkProp3DCollection	GetProp3Ds ()
	Return a collection of all the prop 3D's that were intersected by the pick ray. This collection is not sorted.
override int	IsA (string type)
	*Undocumented Block
new vtkAreaPicker	NewInstance ()
	*Undocumented Block
virtual int	Pick ()
	Perform an AreaPick within the default screen rectangle and renderer.
override int	Pick (double x0, double y0, double arg2, vtkRenderer renderer)
	Perform pick operation in volume behind the given screen coordinate. This makes a thin frustum around the selected pixel. Note: this ignores Z in order to pick everying in a volume from z=0 to z=1.
void	SetPickCoords (double x0, double y0, double x1, double y1)
	Set the default screen rectangle to pick in.
void	SetRenderer (vtkRenderer arg0)
	Set the default renderer to pick on.
Public Member Functions inherited from Kitware.VTK.vtkAbstractPropPicker
	vtkAbstractPropPicker (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
virtual vtkActor	GetActor ()
	Return the vtkActor that has been picked. If NULL, no actor was picked.
virtual vtkActor2D	GetActor2D ()
	Return the vtkActor2D that has been picked. If NULL, no actor2D was picked.
virtual vtkAssembly	GetAssembly ()
	Return the vtkAssembly that has been picked. If NULL, no assembly was picked. (Note: the returned assembly is the first node in the assembly path. If the path is one node long, then the assembly and the prop are the same, assuming that the first node is a vtkAssembly.)
virtual vtkAssemblyPath	GetPath ()
	Return the vtkAssemblyPath that has been picked. The assembly path lists all the vtkProps that form an assembly. If no assembly is present, then the assembly path will have one node (which is the picked prop). The set method is used internally to set the path. (Note: the structure of an assembly path is a collection of vtkAssemblyNode, each node pointing to a vtkProp and (possibly) a transformation matrix.)
virtual vtkProp3D	GetProp3D ()
	Return the vtkProp that has been picked. If NULL, no vtkProp3D was picked.
virtual vtkPropAssembly	GetPropAssembly ()
	Return the vtkPropAssembly that has been picked. If NULL, no prop assembly was picked. (Note: the returned prop assembly is the first node in the assembly path. If the path is one node long, then the prop assembly and the prop are the same, assuming that the first node is a vtkPropAssembly.)
virtual vtkProp	GetViewProp ()
	Return the vtkProp that has been picked. If NULL, nothing was picked. If anything at all was picked, this method will return something.
virtual vtkVolume	GetVolume ()
	Return the vtkVolume that has been picked. If NULL, no volume was picked.
virtual void	SetPath (vtkAssemblyPath arg0)
	Return the vtkAssemblyPath that has been picked. The assembly path lists all the vtkProps that form an assembly. If no assembly is present, then the assembly path will have one node (which is the picked prop). The set method is used internally to set the path. (Note: the structure of an assembly path is a collection of vtkAssemblyNode, each node pointing to a vtkProp and (possibly) a transformation matrix.)
Public Member Functions inherited from Kitware.VTK.vtkAbstractPicker
	vtkAbstractPicker (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
void	AddPickList (vtkProp arg0)
	Add an actor to the pick list.
void	DeletePickList (vtkProp arg0)
	Delete an actor from the pick list.
virtual int	GetPickFromList ()
	Use these methods to control whether to limit the picking to this list (rather than renderer's actors). Make sure that the pick list contains actors that referred to by the picker's renderer.
vtkPropCollection	GetPickList ()
	Return the list of actors in the PickList.
virtual double[]	GetPickPosition ()
	Return position in global coordinates of pick point.
virtual void	GetPickPosition (IntPtr data)
	Return position in global coordinates of pick point.
virtual vtkRenderer	GetRenderer ()
	Get the renderer in which pick event occurred.
virtual double[]	GetSelectionPoint ()
	Get the selection point in screen (pixel) coordinates. The third value is related to z-buffer depth. (Normally should be =0.)
virtual void	GetSelectionPoint (IntPtr data)
	Get the selection point in screen (pixel) coordinates. The third value is related to z-buffer depth. (Normally should be =0.)
void	InitializePickList ()
	Initialize list of actors in pick list.
int	Pick (IntPtr selectionPt, vtkRenderer ren)
	provided. Normally the first two values for the selection point are x-y pixel coordinate, and the third value is =0. Return non-zero if something was successfully picked.
virtual void	PickFromListOff ()
	Use these methods to control whether to limit the picking to this list (rather than renderer's actors). Make sure that the pick list contains actors that referred to by the picker's renderer.
virtual void	PickFromListOn ()
	Use these methods to control whether to limit the picking to this list (rather than renderer's actors). Make sure that the pick list contains actors that referred to by the picker's renderer.
virtual void	SetPickFromList (int _arg)
	Use these methods to control whether to limit the picking to this list (rather than renderer's actors). Make sure that the pick list contains actors that referred to by the picker's renderer.
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.
virtual uint	GetMTime ()
	Return this object's modified time.
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 vtkAreaPicker	New ()
	*Undocumented Block
static new int	IsTypeOf (string type)
	*Undocumented Block
static new vtkAreaPicker	SafeDownCast (vtkObjectBase o)
	*Undocumented Block

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

Detailed Description

vtkAreaPicker - Picks props behind a selection rectangle on a viewport.

Description The vtkAreaPicker picks all vtkProp3Ds that lie behind the screen space rectangle from x0,y0 and x1,y1. The selection is based upon the bounding box of the prop and is thus not exact.

Like vtkPicker, a pick results in a list of Prop3Ds because many props may lie within the pick frustum. You can also get an AssemblyPath, which in this case is defined to be the path to the one particular prop in the Prop3D list that lies nearest to the near plane.

This picker also returns the selection frustum, defined as either a vtkPlanes, or a set of eight corner vertices in world space. The vtkPlanes version is an ImplicitFunction, which is suitable for use with the vtkExtractGeometry. The six frustum planes are in order: left, right, bottom, top, near, far

Because this picker picks everything within a volume, the world pick point result is ill-defined. Therefore if you ask this class for the world pick position, you will get the centroid of the pick frustum. This may be outside of all props in the prop list.

vtkInteractorStyleRubberBandPick, vtkExtractSelectedFrustum.

Constructor & Destructor Documentation

static Kitware.VTK.vtkAreaPicker.vtkAreaPicker ( )

staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkAreaPicker.vtkAreaPicker ( )

*Undocumented Block

Member Function Documentation

virtual int Kitware.VTK.vtkAreaPicker.AreaPick	(	double	x0,
		double	y0,
		double	x1,
		double	y1,
		vtkRenderer	renderer
	)

virtual

Perform pick operation in volume behind the given screen coordinates. Props intersecting the selection frustum will be accessible via GetProp3D. GetPlanes returns a vtkImplicitFunciton suitable for vtkExtractGeometry.

Reimplemented in Kitware.VTK.vtkRenderedAreaPicker.

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

Reimplemented in Kitware.VTK.vtkRenderedAreaPicker.

virtual vtkPoints Kitware.VTK.vtkAreaPicker.GetClipPoints ( )

virtual

Return eight points that define the selection frustum.

Here is the call graph for this function:

virtual vtkDataSet Kitware.VTK.vtkAreaPicker.GetDataSet ( )

virtual

Get a pointer to the dataset that was picked (if any). If nothing was picked then NULL is returned.

Here is the call graph for this function:

virtual vtkPlanes Kitware.VTK.vtkAreaPicker.GetFrustum ( )

virtual

Return the six planes that define the selection frustum. The implicit function defined by the planes evaluates to negative inside and positive outside.

Here is the call graph for this function:

virtual vtkAbstractMapper3D Kitware.VTK.vtkAreaPicker.GetMapper ( )

virtual

Return mapper that was picked (if any).

Here is the call graph for this function:

vtkProp3DCollection Kitware.VTK.vtkAreaPicker.GetProp3Ds ( )

Return a collection of all the prop 3D's that were intersected by the pick ray. This collection is not sorted.

Here is the call graph for this function:

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

virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkAbstractPropPicker.

Reimplemented in Kitware.VTK.vtkRenderedAreaPicker.

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

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkAbstractPropPicker.

Reimplemented in Kitware.VTK.vtkRenderedAreaPicker.

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

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkRenderedAreaPicker.

new vtkAreaPicker Kitware.VTK.vtkAreaPicker.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkAbstractPropPicker.

Reimplemented in Kitware.VTK.vtkRenderedAreaPicker.

virtual int Kitware.VTK.vtkAreaPicker.Pick ( )

virtual

Perform an AreaPick within the default screen rectangle and renderer.

override int Kitware.VTK.vtkAreaPicker.Pick	(	double	x0,
		double	y0,
		double	arg2,
		vtkRenderer	renderer
	)

virtual

Perform pick operation in volume behind the given screen coordinate. This makes a thin frustum around the selected pixel. Note: this ignores Z in order to pick everying in a volume from z=0 to z=1.

Reimplemented from Kitware.VTK.vtkAbstractPicker.

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

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkAbstractPropPicker.

Reimplemented in Kitware.VTK.vtkRenderedAreaPicker.

Here is the call graph for this function: