ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkCellPicker Class Reference

vtkCellPicker - ray-cast cell picker for all kinds of Prop3Ds More...

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

List of all members.

Public Member Functions

 vtkCellPicker (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkCellPicker ()
 Undocumented Block.
void AddLocator (vtkAbstractCellLocator locator)
 Add a locator for one of the data sets that will be included in the scene. You must set up the locator with exactly the same data set that was input to the mapper of one or more of the actors in the scene. As well, you must either build the locator before doing the pick, or you must turn on LazyEvaluation in the locator to make it build itself on the first pick. Note that if you try to add the same locator to the picker twice, the second addition will be ignored.
virtual int[] GetCellIJK ()
 Get the structured coordinates of the cell at the PickPosition. Only valid for image actors and volumes with vtkImageData. Combine this with the PCoords to get the position within the cell.
virtual void GetCellIJK (ref int _arg1, ref int _arg2, ref int _arg3)
 Get the structured coordinates of the cell at the PickPosition. Only valid for image actors and volumes with vtkImageData. Combine this with the PCoords to get the position within the cell.
virtual void GetCellIJK (IntPtr _arg)
 Get the structured coordinates of the cell at the PickPosition. Only valid for image actors and volumes with vtkImageData. Combine this with the PCoords to get the position within the cell.
virtual int GetCellId ()
 Get the id of the picked cell. If CellId = -1, nothing was picked.
virtual int GetClippingPlaneId ()
 Get the index of the clipping plane that was intersected during the pick. This will be set regardless of whether PickClippingPlanes is On, all that is required is that the pick intersected a clipping plane of the Prop3D that was picked. The result will be -1 if the Prop3D that was picked has no clipping planes, or if the ray didn't intersect the planes.
virtual double[] GetMapperNormal ()
 Return the normal of the surface at the PickPosition in mapper coordinates. The result is undefined if no prop was picked.
virtual void GetMapperNormal (ref double _arg1, ref double _arg2, ref double _arg3)
 Return the normal of the surface at the PickPosition in mapper coordinates. The result is undefined if no prop was picked.
virtual void GetMapperNormal (IntPtr _arg)
 Return the normal of the surface at the PickPosition in mapper coordinates. The result is undefined if no prop was picked.
virtual double[] GetPCoords ()
 Get the parametric coordinates of the picked cell. Only valid if a prop was picked. The PCoords can be used to compute the weights that are needed to interpolate data values within the cell.
virtual void GetPCoords (ref double _arg1, ref double _arg2, ref double _arg3)
 Get the parametric coordinates of the picked cell. Only valid if a prop was picked. The PCoords can be used to compute the weights that are needed to interpolate data values within the cell.
virtual void GetPCoords (IntPtr _arg)
 Get the parametric coordinates of the picked cell. Only valid if a prop was picked. The PCoords can be used to compute the weights that are needed to interpolate data values within the cell.
virtual int GetPickClippingPlanes ()
 The PickClippingPlanes setting controls how clipping planes are handled by the pick. If it is On, then the clipping planes become pickable objects, even though they are usually invisible. This means that if the pick ray intersects a clipping plane before it hits anything else, the pick will stop at that clipping plane. The GetProp3D() and GetMapper() methods will return the Prop3D and Mapper that the clipping plane belongs to. The GetClippingPlaneId() method will return the index of the clipping plane so that you can retrieve it from the mapper, or -1 if no clipping plane was picked. The picking of vtkImageActors is not influenced by this setting, since they have no clipping planes.
virtual double[] GetPickNormal ()
 Return the normal of the picked surface at the PickPosition. If no surface was picked, then a vector pointing back at the camera is returned.
virtual void GetPickNormal (IntPtr data)
 Return the normal of the picked surface at the PickPosition. If no surface was picked, then a vector pointing back at the camera is returned.
virtual int GetPickTextureData ()
 If this is "On" and if the picked prop has a texture, then the data returned by GetDataSet() will be the texture's data instead of the mapper's data. The GetPointId(), GetCellId(), GetPCoords() etc. will all return information for use with the texture's data. If the picked prop does not have any texture, then GetDataSet() will return the mapper's data instead and GetPointId() etc. will return information related to the mapper's data. The default value of PickTextureData is "Off".
virtual int[] GetPointIJK ()
 Get the structured coordinates of the point at the PickPosition. Only valid for image actors and volumes with vtkImageData.
virtual void GetPointIJK (ref int _arg1, ref int _arg2, ref int _arg3)
 Get the structured coordinates of the point at the PickPosition. Only valid for image actors and volumes with vtkImageData.
virtual void GetPointIJK (IntPtr _arg)
 Get the structured coordinates of the point at the PickPosition. Only valid for image actors and volumes with vtkImageData.
virtual int GetPointId ()
 Get the id of the picked point. If PointId = -1, nothing was picked. This point will be a member of any cell that is picked.
virtual int GetSubId ()
 Get the subId of the picked cell. This is useful, for example, if the data is made of triangle strips. If SubId = -1, nothing was picked.
vtkTexture GetTexture ()
 Get the texture that was picked. This will always be set if the picked prop has a texture, and will always be null otherwise.
virtual int GetUseVolumeGradientOpacity ()
 Use the product of the scalar and gradient opacity functions when computing the opacity isovalue, instead of just using the scalar opacity. This parameter is only relevant to volume picking and is off by default.
virtual double GetVolumeOpacityIsovalue ()
 Set the opacity isovalue to use for defining volume surfaces. The pick will occur at the location along the pick ray where the opacity of the volume is equal to this isovalue. If you want to do the pick based on an actual data isovalue rather than the opacity, then pass the data value through the scalar opacity function before using this method.
override int IsA (string type)
 Undocumented Block.
new vtkCellPicker NewInstance ()
 Undocumented Block.
override int Pick (double selectionX, double selectionY, double selectionZ, vtkRenderer renderer)
 Perform pick operation with selection point provided. Normally the first two values are the (x,y) pixel coordinates for the pick, and the third value is z=0. The return value will be non-zero if something was successfully picked.
virtual void PickClippingPlanesOff ()
 The PickClippingPlanes setting controls how clipping planes are handled by the pick. If it is On, then the clipping planes become pickable objects, even though they are usually invisible. This means that if the pick ray intersects a clipping plane before it hits anything else, the pick will stop at that clipping plane. The GetProp3D() and GetMapper() methods will return the Prop3D and Mapper that the clipping plane belongs to. The GetClippingPlaneId() method will return the index of the clipping plane so that you can retrieve it from the mapper, or -1 if no clipping plane was picked. The picking of vtkImageActors is not influenced by this setting, since they have no clipping planes.
virtual void PickClippingPlanesOn ()
 The PickClippingPlanes setting controls how clipping planes are handled by the pick. If it is On, then the clipping planes become pickable objects, even though they are usually invisible. This means that if the pick ray intersects a clipping plane before it hits anything else, the pick will stop at that clipping plane. The GetProp3D() and GetMapper() methods will return the Prop3D and Mapper that the clipping plane belongs to. The GetClippingPlaneId() method will return the index of the clipping plane so that you can retrieve it from the mapper, or -1 if no clipping plane was picked. The picking of vtkImageActors is not influenced by this setting, since they have no clipping planes.
virtual void PickTextureDataOff ()
 If this is "On" and if the picked prop has a texture, then the data returned by GetDataSet() will be the texture's data instead of the mapper's data. The GetPointId(), GetCellId(), GetPCoords() etc. will all return information for use with the texture's data. If the picked prop does not have any texture, then GetDataSet() will return the mapper's data instead and GetPointId() etc. will return information related to the mapper's data. The default value of PickTextureData is "Off".
virtual void PickTextureDataOn ()
 If this is "On" and if the picked prop has a texture, then the data returned by GetDataSet() will be the texture's data instead of the mapper's data. The GetPointId(), GetCellId(), GetPCoords() etc. will all return information for use with the texture's data. If the picked prop does not have any texture, then GetDataSet() will return the mapper's data instead and GetPointId() etc. will return information related to the mapper's data. The default value of PickTextureData is "Off".
void RemoveAllLocators ()
 Remove all locators associated with this picker.
void RemoveLocator (vtkAbstractCellLocator locator)
 Remove a locator that was previously added. If you try to remove a nonexistent locator, then nothing will happen and no errors will be raised.
virtual void SetPickClippingPlanes (int _arg)
 The PickClippingPlanes setting controls how clipping planes are handled by the pick. If it is On, then the clipping planes become pickable objects, even though they are usually invisible. This means that if the pick ray intersects a clipping plane before it hits anything else, the pick will stop at that clipping plane. The GetProp3D() and GetMapper() methods will return the Prop3D and Mapper that the clipping plane belongs to. The GetClippingPlaneId() method will return the index of the clipping plane so that you can retrieve it from the mapper, or -1 if no clipping plane was picked. The picking of vtkImageActors is not influenced by this setting, since they have no clipping planes.
virtual void SetPickTextureData (int _arg)
 If this is "On" and if the picked prop has a texture, then the data returned by GetDataSet() will be the texture's data instead of the mapper's data. The GetPointId(), GetCellId(), GetPCoords() etc. will all return information for use with the texture's data. If the picked prop does not have any texture, then GetDataSet() will return the mapper's data instead and GetPointId() etc. will return information related to the mapper's data. The default value of PickTextureData is "Off".
virtual void SetUseVolumeGradientOpacity (int _arg)
 Use the product of the scalar and gradient opacity functions when computing the opacity isovalue, instead of just using the scalar opacity. This parameter is only relevant to volume picking and is off by default.
virtual void SetVolumeOpacityIsovalue (double _arg)
 Set the opacity isovalue to use for defining volume surfaces. The pick will occur at the location along the pick ray where the opacity of the volume is equal to this isovalue. If you want to do the pick based on an actual data isovalue rather than the opacity, then pass the data value through the scalar opacity function before using this method.
virtual void UseVolumeGradientOpacityOff ()
 Use the product of the scalar and gradient opacity functions when computing the opacity isovalue, instead of just using the scalar opacity. This parameter is only relevant to volume picking and is off by default.
virtual void UseVolumeGradientOpacityOn ()
 Use the product of the scalar and gradient opacity functions when computing the opacity isovalue, instead of just using the scalar opacity. This parameter is only relevant to volume picking and is off by default.

Static Public Member Functions

static new vtkCellPicker New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkCellPicker SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkCellPicker"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "13vtkCellPicker"
 Automatically generated type registration mechanics.

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.

Private Member Functions

static internal IntPtr vtkCellPicker_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCellPicker_AddLocator_01 (HandleRef pThis, HandleRef locator)
static internal IntPtr vtkCellPicker_GetCellIJK_02 (HandleRef pThis)
static internal void vtkCellPicker_GetCellIJK_03 (HandleRef pThis, ref int _arg1, ref int _arg2, ref int _arg3)
static internal void vtkCellPicker_GetCellIJK_04 (HandleRef pThis, IntPtr _arg)
static internal int vtkCellPicker_GetCellId_05 (HandleRef pThis)
static internal int vtkCellPicker_GetClippingPlaneId_06 (HandleRef pThis)
static internal IntPtr vtkCellPicker_GetMapperNormal_07 (HandleRef pThis)
static internal void vtkCellPicker_GetMapperNormal_08 (HandleRef pThis, ref double _arg1, ref double _arg2, ref double _arg3)
static internal void vtkCellPicker_GetMapperNormal_09 (HandleRef pThis, IntPtr _arg)
static internal IntPtr vtkCellPicker_GetPCoords_10 (HandleRef pThis)
static internal void vtkCellPicker_GetPCoords_11 (HandleRef pThis, ref double _arg1, ref double _arg2, ref double _arg3)
static internal void vtkCellPicker_GetPCoords_12 (HandleRef pThis, IntPtr _arg)
static internal int vtkCellPicker_GetPickClippingPlanes_13 (HandleRef pThis)
static internal IntPtr vtkCellPicker_GetPickNormal_14 (HandleRef pThis)
static internal void vtkCellPicker_GetPickNormal_15 (HandleRef pThis, IntPtr data)
static internal int vtkCellPicker_GetPickTextureData_16 (HandleRef pThis)
static internal IntPtr vtkCellPicker_GetPointIJK_17 (HandleRef pThis)
static internal void vtkCellPicker_GetPointIJK_18 (HandleRef pThis, ref int _arg1, ref int _arg2, ref int _arg3)
static internal void vtkCellPicker_GetPointIJK_19 (HandleRef pThis, IntPtr _arg)
static internal int vtkCellPicker_GetPointId_20 (HandleRef pThis)
static internal int vtkCellPicker_GetSubId_21 (HandleRef pThis)
static internal IntPtr vtkCellPicker_GetTexture_22 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkCellPicker_GetUseVolumeGradientOpacity_23 (HandleRef pThis)
static internal double vtkCellPicker_GetVolumeOpacityIsovalue_24 (HandleRef pThis)
static internal int vtkCellPicker_IsA_25 (HandleRef pThis, string type)
static internal int vtkCellPicker_IsTypeOf_26 (string type)
static internal IntPtr vtkCellPicker_NewInstance_28 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkCellPicker_Pick_29 (HandleRef pThis, double selectionX, double selectionY, double selectionZ, HandleRef renderer)
static internal void vtkCellPicker_PickClippingPlanesOff_30 (HandleRef pThis)
static internal void vtkCellPicker_PickClippingPlanesOn_31 (HandleRef pThis)
static internal void vtkCellPicker_PickTextureDataOff_32 (HandleRef pThis)
static internal void vtkCellPicker_PickTextureDataOn_33 (HandleRef pThis)
static internal void vtkCellPicker_RemoveAllLocators_34 (HandleRef pThis)
static internal void vtkCellPicker_RemoveLocator_35 (HandleRef pThis, HandleRef locator)
static internal IntPtr vtkCellPicker_SafeDownCast_36 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCellPicker_SetPickClippingPlanes_37 (HandleRef pThis, int _arg)
static internal void vtkCellPicker_SetPickTextureData_38 (HandleRef pThis, int _arg)
static internal void vtkCellPicker_SetUseVolumeGradientOpacity_39 (HandleRef pThis, int _arg)
static internal void vtkCellPicker_SetVolumeOpacityIsovalue_40 (HandleRef pThis, double _arg)
static internal void vtkCellPicker_UseVolumeGradientOpacityOff_41 (HandleRef pThis)
static internal void vtkCellPicker_UseVolumeGradientOpacityOn_42 (HandleRef pThis)

Static Private Member Functions

static vtkCellPicker ()
 Automatically generated type registration mechanics.

Detailed Description

vtkCellPicker - ray-cast cell picker for all kinds of Prop3Ds

Description vtkCellPicker will shoot a ray into a 3D scene and return information about the first object that the ray hits. It works for all Prop3Ds. For vtkVolume objects, it shoots a ray into the volume and returns the point where the ray intersects an isosurface of a chosen opacity. For vtkImageActor objects, it intersects the ray with the displayed slice. For vtkActor objects, it intersects the actor's polygons. If the object's mapper has ClippingPlanes, then it takes the clipping into account, and will return the Id of the clipping plane that was intersected. For all prop types, it returns point and cell information, plus the normal of the surface that was intersected at the pick position. For volumes and images, it also returns (i,j,k) coordinates for the point and the cell that were picked.

Thanks This class was contributed to VTK by David Gobbi on behalf of Atamai Inc., as an enhancement to the original vtkCellPicker.

vtkPicker vtkPointPicker vtkVolumePicker


Constructor & Destructor Documentation

static Kitware.VTK.vtkCellPicker.vtkCellPicker ( ) [static, private]

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

Add a locator for one of the data sets that will be included in the scene. You must set up the locator with exactly the same data set that was input to the mapper of one or more of the actors in the scene. As well, you must either build the locator before doing the pick, or you must turn on LazyEvaluation in the locator to make it build itself on the first pick. Note that if you try to add the same locator to the picker twice, the second addition will be ignored.

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

Reimplemented in Kitware.VTK.vtkVolumePicker.

virtual int Kitware.VTK.vtkCellPicker.GetCellId ( ) [virtual]

Get the id of the picked cell. If CellId = -1, nothing was picked.

virtual int [] Kitware.VTK.vtkCellPicker.GetCellIJK ( ) [virtual]

Get the structured coordinates of the cell at the PickPosition. Only valid for image actors and volumes with vtkImageData. Combine this with the PCoords to get the position within the cell.

virtual void Kitware.VTK.vtkCellPicker.GetCellIJK ( ref int  _arg1,
ref int  _arg2,
ref int  _arg3 
) [virtual]

Get the structured coordinates of the cell at the PickPosition. Only valid for image actors and volumes with vtkImageData. Combine this with the PCoords to get the position within the cell.

virtual void Kitware.VTK.vtkCellPicker.GetCellIJK ( IntPtr  _arg) [virtual]

Get the structured coordinates of the cell at the PickPosition. Only valid for image actors and volumes with vtkImageData. Combine this with the PCoords to get the position within the cell.

Get the index of the clipping plane that was intersected during the pick. This will be set regardless of whether PickClippingPlanes is On, all that is required is that the pick intersected a clipping plane of the Prop3D that was picked. The result will be -1 if the Prop3D that was picked has no clipping planes, or if the ray didn't intersect the planes.

virtual double [] Kitware.VTK.vtkCellPicker.GetMapperNormal ( ) [virtual]

Return the normal of the surface at the PickPosition in mapper coordinates. The result is undefined if no prop was picked.

virtual void Kitware.VTK.vtkCellPicker.GetMapperNormal ( ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [virtual]

Return the normal of the surface at the PickPosition in mapper coordinates. The result is undefined if no prop was picked.

virtual void Kitware.VTK.vtkCellPicker.GetMapperNormal ( IntPtr  _arg) [virtual]

Return the normal of the surface at the PickPosition in mapper coordinates. The result is undefined if no prop was picked.

virtual double [] Kitware.VTK.vtkCellPicker.GetPCoords ( ) [virtual]

Get the parametric coordinates of the picked cell. Only valid if a prop was picked. The PCoords can be used to compute the weights that are needed to interpolate data values within the cell.

virtual void Kitware.VTK.vtkCellPicker.GetPCoords ( ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [virtual]

Get the parametric coordinates of the picked cell. Only valid if a prop was picked. The PCoords can be used to compute the weights that are needed to interpolate data values within the cell.

virtual void Kitware.VTK.vtkCellPicker.GetPCoords ( IntPtr  _arg) [virtual]

Get the parametric coordinates of the picked cell. Only valid if a prop was picked. The PCoords can be used to compute the weights that are needed to interpolate data values within the cell.

The PickClippingPlanes setting controls how clipping planes are handled by the pick. If it is On, then the clipping planes become pickable objects, even though they are usually invisible. This means that if the pick ray intersects a clipping plane before it hits anything else, the pick will stop at that clipping plane. The GetProp3D() and GetMapper() methods will return the Prop3D and Mapper that the clipping plane belongs to. The GetClippingPlaneId() method will return the index of the clipping plane so that you can retrieve it from the mapper, or -1 if no clipping plane was picked. The picking of vtkImageActors is not influenced by this setting, since they have no clipping planes.

virtual double [] Kitware.VTK.vtkCellPicker.GetPickNormal ( ) [virtual]

Return the normal of the picked surface at the PickPosition. If no surface was picked, then a vector pointing back at the camera is returned.

virtual void Kitware.VTK.vtkCellPicker.GetPickNormal ( IntPtr  data) [virtual]

Return the normal of the picked surface at the PickPosition. If no surface was picked, then a vector pointing back at the camera is returned.

If this is "On" and if the picked prop has a texture, then the data returned by GetDataSet() will be the texture's data instead of the mapper's data. The GetPointId(), GetCellId(), GetPCoords() etc. will all return information for use with the texture's data. If the picked prop does not have any texture, then GetDataSet() will return the mapper's data instead and GetPointId() etc. will return information related to the mapper's data. The default value of PickTextureData is "Off".

virtual int Kitware.VTK.vtkCellPicker.GetPointId ( ) [virtual]

Get the id of the picked point. If PointId = -1, nothing was picked. This point will be a member of any cell that is picked.

virtual int [] Kitware.VTK.vtkCellPicker.GetPointIJK ( ) [virtual]

Get the structured coordinates of the point at the PickPosition. Only valid for image actors and volumes with vtkImageData.

virtual void Kitware.VTK.vtkCellPicker.GetPointIJK ( ref int  _arg1,
ref int  _arg2,
ref int  _arg3 
) [virtual]

Get the structured coordinates of the point at the PickPosition. Only valid for image actors and volumes with vtkImageData.

virtual void Kitware.VTK.vtkCellPicker.GetPointIJK ( IntPtr  _arg) [virtual]

Get the structured coordinates of the point at the PickPosition. Only valid for image actors and volumes with vtkImageData.

virtual int Kitware.VTK.vtkCellPicker.GetSubId ( ) [virtual]

Get the subId of the picked cell. This is useful, for example, if the data is made of triangle strips. If SubId = -1, nothing was picked.

Get the texture that was picked. This will always be set if the picked prop has a texture, and will always be null otherwise.

Here is the call graph for this function:

Use the product of the scalar and gradient opacity functions when computing the opacity isovalue, instead of just using the scalar opacity. This parameter is only relevant to volume picking and is off by default.

Set the opacity isovalue to use for defining volume surfaces. The pick will occur at the location along the pick ray where the opacity of the volume is equal to this isovalue. If you want to do the pick based on an actual data isovalue rather than the opacity, then pass the data value through the scalar opacity function before using this method.

override int Kitware.VTK.vtkCellPicker.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPicker.

Reimplemented in Kitware.VTK.vtkVolumePicker.

static new int Kitware.VTK.vtkCellPicker.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPicker.

Reimplemented in Kitware.VTK.vtkVolumePicker.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPicker.

Reimplemented in Kitware.VTK.vtkVolumePicker.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPicker.

Reimplemented in Kitware.VTK.vtkVolumePicker.

override int Kitware.VTK.vtkCellPicker.Pick ( double  selectionX,
double  selectionY,
double  selectionZ,
vtkRenderer  renderer 
) [virtual]

Perform pick operation with selection point provided. Normally the first two values are the (x,y) pixel coordinates for the pick, and the third value is z=0. The return value will be non-zero if something was successfully picked.

Reimplemented from Kitware.VTK.vtkPicker.

The PickClippingPlanes setting controls how clipping planes are handled by the pick. If it is On, then the clipping planes become pickable objects, even though they are usually invisible. This means that if the pick ray intersects a clipping plane before it hits anything else, the pick will stop at that clipping plane. The GetProp3D() and GetMapper() methods will return the Prop3D and Mapper that the clipping plane belongs to. The GetClippingPlaneId() method will return the index of the clipping plane so that you can retrieve it from the mapper, or -1 if no clipping plane was picked. The picking of vtkImageActors is not influenced by this setting, since they have no clipping planes.

The PickClippingPlanes setting controls how clipping planes are handled by the pick. If it is On, then the clipping planes become pickable objects, even though they are usually invisible. This means that if the pick ray intersects a clipping plane before it hits anything else, the pick will stop at that clipping plane. The GetProp3D() and GetMapper() methods will return the Prop3D and Mapper that the clipping plane belongs to. The GetClippingPlaneId() method will return the index of the clipping plane so that you can retrieve it from the mapper, or -1 if no clipping plane was picked. The picking of vtkImageActors is not influenced by this setting, since they have no clipping planes.

If this is "On" and if the picked prop has a texture, then the data returned by GetDataSet() will be the texture's data instead of the mapper's data. The GetPointId(), GetCellId(), GetPCoords() etc. will all return information for use with the texture's data. If the picked prop does not have any texture, then GetDataSet() will return the mapper's data instead and GetPointId() etc. will return information related to the mapper's data. The default value of PickTextureData is "Off".

virtual void Kitware.VTK.vtkCellPicker.PickTextureDataOn ( ) [virtual]

If this is "On" and if the picked prop has a texture, then the data returned by GetDataSet() will be the texture's data instead of the mapper's data. The GetPointId(), GetCellId(), GetPCoords() etc. will all return information for use with the texture's data. If the picked prop does not have any texture, then GetDataSet() will return the mapper's data instead and GetPointId() etc. will return information related to the mapper's data. The default value of PickTextureData is "Off".

Remove all locators associated with this picker.

Remove a locator that was previously added. If you try to remove a nonexistent locator, then nothing will happen and no errors will be raised.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPicker.

Reimplemented in Kitware.VTK.vtkVolumePicker.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkCellPicker.SetPickClippingPlanes ( int  _arg) [virtual]

The PickClippingPlanes setting controls how clipping planes are handled by the pick. If it is On, then the clipping planes become pickable objects, even though they are usually invisible. This means that if the pick ray intersects a clipping plane before it hits anything else, the pick will stop at that clipping plane. The GetProp3D() and GetMapper() methods will return the Prop3D and Mapper that the clipping plane belongs to. The GetClippingPlaneId() method will return the index of the clipping plane so that you can retrieve it from the mapper, or -1 if no clipping plane was picked. The picking of vtkImageActors is not influenced by this setting, since they have no clipping planes.

virtual void Kitware.VTK.vtkCellPicker.SetPickTextureData ( int  _arg) [virtual]

If this is "On" and if the picked prop has a texture, then the data returned by GetDataSet() will be the texture's data instead of the mapper's data. The GetPointId(), GetCellId(), GetPCoords() etc. will all return information for use with the texture's data. If the picked prop does not have any texture, then GetDataSet() will return the mapper's data instead and GetPointId() etc. will return information related to the mapper's data. The default value of PickTextureData is "Off".

virtual void Kitware.VTK.vtkCellPicker.SetUseVolumeGradientOpacity ( int  _arg) [virtual]

Use the product of the scalar and gradient opacity functions when computing the opacity isovalue, instead of just using the scalar opacity. This parameter is only relevant to volume picking and is off by default.

virtual void Kitware.VTK.vtkCellPicker.SetVolumeOpacityIsovalue ( double  _arg) [virtual]

Set the opacity isovalue to use for defining volume surfaces. The pick will occur at the location along the pick ray where the opacity of the volume is equal to this isovalue. If you want to do the pick based on an actual data isovalue rather than the opacity, then pass the data value through the scalar opacity function before using this method.

Use the product of the scalar and gradient opacity functions when computing the opacity isovalue, instead of just using the scalar opacity. This parameter is only relevant to volume picking and is off by default.

Use the product of the scalar and gradient opacity functions when computing the opacity isovalue, instead of just using the scalar opacity. This parameter is only relevant to volume picking and is off by default.

static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_AddLocator_01 ( HandleRef  pThis,
HandleRef  locator 
) [private]
static internal int Kitware.VTK.vtkCellPicker.vtkCellPicker_GetCellId_05 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkCellPicker.vtkCellPicker_GetCellIJK_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_GetCellIJK_03 ( HandleRef  pThis,
ref int  _arg1,
ref int  _arg2,
ref int  _arg3 
) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_GetCellIJK_04 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal int Kitware.VTK.vtkCellPicker.vtkCellPicker_GetClippingPlaneId_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkCellPicker.vtkCellPicker_GetMapperNormal_07 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_GetMapperNormal_08 ( HandleRef  pThis,
ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_GetMapperNormal_09 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal IntPtr Kitware.VTK.vtkCellPicker.vtkCellPicker_GetPCoords_10 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_GetPCoords_11 ( HandleRef  pThis,
ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_GetPCoords_12 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal int Kitware.VTK.vtkCellPicker.vtkCellPicker_GetPickClippingPlanes_13 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkCellPicker.vtkCellPicker_GetPickNormal_14 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_GetPickNormal_15 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal int Kitware.VTK.vtkCellPicker.vtkCellPicker_GetPickTextureData_16 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkCellPicker.vtkCellPicker_GetPointId_20 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkCellPicker.vtkCellPicker_GetPointIJK_17 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_GetPointIJK_18 ( HandleRef  pThis,
ref int  _arg1,
ref int  _arg2,
ref int  _arg3 
) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_GetPointIJK_19 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal int Kitware.VTK.vtkCellPicker.vtkCellPicker_GetSubId_21 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkCellPicker.vtkCellPicker_GetTexture_22 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkCellPicker.vtkCellPicker_GetUseVolumeGradientOpacity_23 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkCellPicker.vtkCellPicker_GetVolumeOpacityIsovalue_24 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkCellPicker.vtkCellPicker_IsA_25 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkCellPicker.vtkCellPicker_IsTypeOf_26 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkCellPicker.vtkCellPicker_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCellPicker.vtkCellPicker_NewInstance_28 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkCellPicker.vtkCellPicker_Pick_29 ( HandleRef  pThis,
double  selectionX,
double  selectionY,
double  selectionZ,
HandleRef  renderer 
) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_PickClippingPlanesOff_30 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_PickClippingPlanesOn_31 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_PickTextureDataOff_32 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_PickTextureDataOn_33 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_RemoveAllLocators_34 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_RemoveLocator_35 ( HandleRef  pThis,
HandleRef  locator 
) [private]
static internal IntPtr Kitware.VTK.vtkCellPicker.vtkCellPicker_SafeDownCast_36 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_SetPickClippingPlanes_37 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_SetPickTextureData_38 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_SetUseVolumeGradientOpacity_39 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_SetVolumeOpacityIsovalue_40 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_UseVolumeGradientOpacityOff_41 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCellPicker.vtkCellPicker_UseVolumeGradientOpacityOn_42 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkCellPicker.MRClassNameKey = "13vtkCellPicker" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPicker.

Reimplemented in Kitware.VTK.vtkVolumePicker.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPicker.

Reimplemented in Kitware.VTK.vtkVolumePicker.


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