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

vtkAbstractPropPicker - abstract API for pickers that can pick an instance of vtkProp More...

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

List of all members.

Public Member Functions

 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.
override int IsA (string type)
 *Undocumented Block
new vtkAbstractPropPicker NewInstance ()
 *Undocumented Block
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.
virtual int Pick (double selectionX, double selectionY, double selectionZ, vtkRenderer renderer)
 Perform pick operation with selection point 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.
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 int IsTypeOf (string type)
 *Undocumented Block
static new vtkAbstractPropPicker SafeDownCast (vtkObjectBase o)
 *Undocumented Block

Public Attributes

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

Detailed Description

vtkAbstractPropPicker - abstract API for pickers that can pick an instance of vtkProp

Description vtkAbstractPropPicker is an abstract superclass for pickers that can pick an instance of vtkProp. Some pickers, like vtkWorldPointPicker (not a subclass of this class), cannot identify the prop that is picked. Subclasses of vtkAbstractPropPicker return a prop in the form of a vtkAssemblyPath when a pick is invoked. Note that an vtkAssemblyPath contain a list of vtkAssemblyNodes, each of which in turn contains a reference to a vtkProp and a 4x4 transformation matrix. The path fully describes the entire pick path, so you can pick assemblies or portions of assemblies, or just grab the tail end of the vtkAssemblyPath (which is the picked prop).


Constructor & Destructor Documentation

static Kitware.VTK.vtkAbstractPropPicker.vtkAbstractPropPicker ( )
staticprivate

Automatically generated type registration mechanics.

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

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


Member Function Documentation

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

Reimplemented in Kitware.VTK.vtkAreaPicker, Kitware.VTK.vtkCellPicker, Kitware.VTK.vtkPicker, Kitware.VTK.vtkVolumePicker, Kitware.VTK.vtkRenderedAreaPicker, Kitware.VTK.vtkPropPicker, and Kitware.VTK.vtkPointPicker.

virtual vtkActor Kitware.VTK.vtkAbstractPropPicker.GetActor ( )
virtual

Return the vtkActor that has been picked. If NULL, no actor was picked.

Here is the call graph for this function:

virtual vtkActor2D Kitware.VTK.vtkAbstractPropPicker.GetActor2D ( )
virtual

Return the vtkActor2D that has been picked. If NULL, no actor2D was picked.

Here is the call graph for this function:

virtual vtkAssembly Kitware.VTK.vtkAbstractPropPicker.GetAssembly ( )
virtual

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

Here is the call graph for this function:

virtual vtkAssemblyPath Kitware.VTK.vtkAbstractPropPicker.GetPath ( )
virtual

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

Here is the call graph for this function:

virtual vtkProp3D Kitware.VTK.vtkAbstractPropPicker.GetProp3D ( )
virtual

Return the vtkProp that has been picked. If NULL, no vtkProp3D was picked.

Here is the call graph for this function:

virtual vtkPropAssembly Kitware.VTK.vtkAbstractPropPicker.GetPropAssembly ( )
virtual

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

Here is the call graph for this function:

virtual vtkProp Kitware.VTK.vtkAbstractPropPicker.GetViewProp ( )
virtual

Return the vtkProp that has been picked. If NULL, nothing was picked. If anything at all was picked, this method will return something.

Here is the call graph for this function:

virtual vtkVolume Kitware.VTK.vtkAbstractPropPicker.GetVolume ( )
virtual

Return the vtkVolume that has been picked. If NULL, no volume was picked.

Here is the call graph for this function:

override int Kitware.VTK.vtkAbstractPropPicker.IsA ( string  type)
virtual
static new int Kitware.VTK.vtkAbstractPropPicker.IsTypeOf ( string  type)
static
new vtkAbstractPropPicker Kitware.VTK.vtkAbstractPropPicker.NewInstance ( )
static new vtkAbstractPropPicker Kitware.VTK.vtkAbstractPropPicker.SafeDownCast ( vtkObjectBase  o)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkAbstractPicker.

Reimplemented in Kitware.VTK.vtkCellPicker, Kitware.VTK.vtkPicker, Kitware.VTK.vtkAreaPicker, Kitware.VTK.vtkVolumePicker, Kitware.VTK.vtkPropPicker, Kitware.VTK.vtkRenderedAreaPicker, and Kitware.VTK.vtkPointPicker.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkAbstractPropPicker.SetPath ( vtkAssemblyPath  arg0)
virtual

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


Member Data Documentation

new readonly string Kitware.VTK.vtkAbstractPropPicker.MRClassNameKey = "21vtkAbstractPropPicker"
static
new const string Kitware.VTK.vtkAbstractPropPicker.MRFullTypeName = "Kitware.VTK.vtkAbstractPropPicker"

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