VTK  9.3.20240329
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkVolumePicker Class Reference

ray-cast picker enhanced for volumes More...

#include <vtkVolumePicker.h>

Inheritance diagram for vtkVolumePicker:
[legend]
Collaboration diagram for vtkVolumePicker:
[legend]

Public Types

typedef vtkCellPicker Superclass
 
- Public Types inherited from vtkCellPicker
typedef vtkPicker Superclass
 
- Public Types inherited from vtkPicker
typedef vtkAbstractPropPicker Superclass
 
- Public Types inherited from vtkAbstractPropPicker
typedef vtkAbstractPicker Superclass
 
- Public Types inherited from vtkAbstractPicker
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkVolumePickerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetPickCroppingPlanes (vtkTypeBool)
 Set whether to pick the cropping planes of props that have them. More...
 
virtual void PickCroppingPlanesOn ()
 Set whether to pick the cropping planes of props that have them. More...
 
virtual void PickCroppingPlanesOff ()
 Set whether to pick the cropping planes of props that have them. More...
 
virtual vtkTypeBool GetPickCroppingPlanes ()
 Set whether to pick the cropping planes of props that have them. More...
 
virtual int GetCroppingPlaneId ()
 Get the index of the cropping plane that the pick ray passed through on its way to the prop. More...
 
- Public Member Functions inherited from vtkCellPicker
vtkCellPickerNewInstance () const
 
int Pick (double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer) override
 Perform pick operation with selection point provided. More...
 
int Pick3DRay (double selectionPt[3], double orient[4], vtkRenderer *ren) override
 Perform pick operation with selection point provided. More...
 
void AddLocator (vtkAbstractCellLocator *locator)
 Add a locator for one of the data sets that will be included in the scene. More...
 
void RemoveLocator (vtkAbstractCellLocator *locator)
 Remove a locator that was previously added. More...
 
void RemoveAllLocators ()
 Remove all locators associated with this picker. More...
 
vtkTextureGetTexture ()
 Get the texture that was picked. More...
 
virtual void SetVolumeOpacityIsovalue (double)
 Set the opacity isovalue to use for defining volume surfaces. More...
 
virtual double GetVolumeOpacityIsovalue ()
 Set the opacity isovalue to use for defining volume surfaces. More...
 
virtual void SetUseVolumeGradientOpacity (vtkTypeBool)
 Use the product of the scalar and gradient opacity functions when computing the opacity isovalue, instead of just using the scalar opacity. More...
 
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. More...
 
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. More...
 
virtual vtkTypeBool GetUseVolumeGradientOpacity ()
 Use the product of the scalar and gradient opacity functions when computing the opacity isovalue, instead of just using the scalar opacity. More...
 
virtual void SetPickClippingPlanes (vtkTypeBool)
 The PickClippingPlanes setting controls how clipping planes are handled by the pick. More...
 
virtual void PickClippingPlanesOn ()
 The PickClippingPlanes setting controls how clipping planes are handled by the pick. More...
 
virtual void PickClippingPlanesOff ()
 The PickClippingPlanes setting controls how clipping planes are handled by the pick. More...
 
virtual vtkTypeBool GetPickClippingPlanes ()
 The PickClippingPlanes setting controls how clipping planes are handled by the pick. More...
 
virtual int GetClippingPlaneId ()
 Get the index of the clipping plane that was intersected during the pick. More...
 
virtual double * GetPickNormal ()
 Return the normal of the picked surface at the PickPosition. More...
 
virtual void GetPickNormal (double data[3])
 Return the normal of the picked surface at the PickPosition. More...
 
virtual double * GetMapperNormal ()
 Return the normal of the surface at the PickPosition in mapper coordinates. More...
 
virtual void GetMapperNormal (double &, double &, double &)
 Return the normal of the surface at the PickPosition in mapper coordinates. More...
 
virtual void GetMapperNormal (double[3])
 Return the normal of the surface at the PickPosition in mapper coordinates. More...
 
virtual int * GetPointIJK ()
 Get the structured coordinates of the point at the PickPosition. More...
 
virtual void GetPointIJK (int &, int &, int &)
 Get the structured coordinates of the point at the PickPosition. More...
 
virtual void GetPointIJK (int[3])
 Get the structured coordinates of the point at the PickPosition. More...
 
virtual int * GetCellIJK ()
 Get the structured coordinates of the cell at the PickPosition. More...
 
virtual void GetCellIJK (int &, int &, int &)
 Get the structured coordinates of the cell at the PickPosition. More...
 
virtual void GetCellIJK (int[3])
 Get the structured coordinates of the cell at the PickPosition. More...
 
virtual vtkIdType GetPointId ()
 Get the id of the picked point. More...
 
virtual vtkIdType GetCellId ()
 Get the id of the picked cell. More...
 
virtual int GetSubId ()
 Get the subId of the picked cell. More...
 
virtual double * GetPCoords ()
 Get the parametric coordinates of the picked cell. More...
 
virtual void GetPCoords (double &, double &, double &)
 Get the parametric coordinates of the picked cell. More...
 
virtual void GetPCoords (double[3])
 Get the parametric coordinates of the picked cell. More...
 
virtual void SetPickTextureData (vtkTypeBool)
 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. More...
 
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. More...
 
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. More...
 
virtual vtkTypeBool 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. More...
 
- Public Member Functions inherited from vtkPicker
vtkPickerNewInstance () const
 
vtkProp3DCollectionGetProp3Ds ()
 Return a collection of all the prop 3D's that were intersected by the pick ray. More...
 
vtkActorCollectionGetActors ()
 Return a collection of all the actors that were intersected. More...
 
vtkPointsGetPickedPositions ()
 Return a list of the points the actors returned by GetProp3Ds were intersected at. More...
 
int Pick (double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer) override
 Perform pick operation with selection point provided. More...
 
int Pick (double selectionPt[3], vtkRenderer *ren)
 Perform pick operation with selection point provided. More...
 
int Pick3DPoint (double selectionPt[3], vtkRenderer *ren) override
 Perform pick operation with selection point provided. More...
 
virtual int Pick3DPoint (double p1World[3], double p2World[3], vtkRenderer *ren)
 
int Pick3DRay (double selectionPt[3], double orient[4], vtkRenderer *ren) override
 Perform pick operation with selection point and orientation provided. More...
 
virtual void SetTolerance (double)
 Specify tolerance for performing pick operation. More...
 
virtual double GetTolerance ()
 Specify tolerance for performing pick operation. More...
 
virtual double * GetMapperPosition ()
 Return position in mapper (i.e., non-transformed) coordinates of pick point. More...
 
virtual void GetMapperPosition (double data[3])
 Return position in mapper (i.e., non-transformed) coordinates of pick point. More...
 
virtual vtkAbstractMapper3DGetMapper ()
 Return mapper that was picked (if any). More...
 
virtual vtkDataSetGetDataSet ()
 Get a pointer to the dataset that was picked (if any). More...
 
virtual vtkCompositeDataSetGetCompositeDataSet ()
 Get a pointer to the composite dataset that was picked (if any). More...
 
virtual vtkIdType GetFlatBlockIndex ()
 Get the flat block index of the vtkDataSet in the composite dataset that was picked (if any). More...
 
- Public Member Functions inherited from vtkAbstractPropPicker
vtkAbstractPropPickerNewInstance () const
 
virtual vtkPropGetViewProp ()
 Return the vtkProp that has been picked. More...
 
virtual vtkProp3DGetProp3D ()
 Return the vtkProp that has been picked. More...
 
virtual vtkActorGetActor ()
 Return the vtkActor that has been picked. More...
 
virtual vtkActor2DGetActor2D ()
 Return the vtkActor2D that has been picked. More...
 
virtual vtkVolumeGetVolume ()
 Return the vtkVolume that has been picked. More...
 
virtual vtkAssemblyGetAssembly ()
 Return the vtkAssembly that has been picked. More...
 
virtual vtkPropAssemblyGetPropAssembly ()
 Return the vtkPropAssembly that has been picked. More...
 
virtual void SetPath (vtkAssemblyPath *)
 Return the vtkAssemblyPath that has been picked. More...
 
virtual vtkAssemblyPathGetPath ()
 Return the vtkAssemblyPath that has been picked. More...
 
- Public Member Functions inherited from vtkAbstractPicker
vtkAbstractPickerNewInstance () const
 
int Pick (double selectionPt[3], vtkRenderer *ren)
 provided. More...
 
void InitializePickList ()
 Initialize list of actors in pick list. More...
 
void AddPickList (vtkProp *)
 Add an actor to the pick list. More...
 
void DeletePickList (vtkProp *)
 Delete an actor from the pick list. More...
 
vtkPropCollectionGetPickList ()
 Return the list of actors in the PickList. More...
 
virtual vtkRendererGetRenderer ()
 Get the renderer in which pick event occurred. More...
 
virtual double * GetSelectionPoint ()
 Get the selection point in screen (pixel) coordinates. More...
 
virtual void GetSelectionPoint (double data[3])
 Get the selection point in screen (pixel) coordinates. More...
 
virtual double * GetPickPosition ()
 Return position in global coordinates of pick point. More...
 
virtual void GetPickPosition (double data[3])
 Return position in global coordinates of pick point. More...
 
virtual void SetPickFromList (vtkTypeBool)
 Use these methods to control whether to limit the picking to this list (rather than renderer's actors). More...
 
virtual vtkTypeBool GetPickFromList ()
 Use these methods to control whether to limit the picking to this list (rather than renderer's actors). More...
 
virtual void PickFromListOn ()
 Use these methods to control whether to limit the picking to this list (rather than renderer's actors). More...
 
virtual void PickFromListOff ()
 Use these methods to control whether to limit the picking to this list (rather than renderer's actors). More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkVolumePickerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkVolumePickerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkCellPicker
static vtkCellPickerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellPickerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPicker
static vtkPickerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPickerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractPropPicker
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractPropPickerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractPicker
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractPickerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkVolumePicker ()
 
 ~vtkVolumePicker () override
 
void ResetPickInfo () override
 
double IntersectVolumeWithLine (const double p1[3], const double p2[3], double t1, double t2, vtkProp3D *prop, vtkAbstractVolumeMapper *mapper) override
 
- Protected Member Functions inherited from vtkCellPicker
 vtkCellPicker ()
 
 ~vtkCellPicker () override
 
void Initialize () override
 
double IntersectWithLine (const double p1[3], const double p2[3], double tol, vtkAssemblyPath *path, vtkProp3D *p, vtkAbstractMapper3D *m) override
 
virtual double IntersectActorWithLine (const double p1[3], const double p2[3], double t1, double t2, double tol, vtkProp3D *prop, vtkMapper *mapper)
 
virtual bool IntersectDataSetWithLine (vtkDataSet *dataSet, const double p1[3], const double p2[3], double t1, double t2, double tol, vtkAbstractCellLocator *&locator, vtkIdType &cellId, int &subId, double &tMin, double &pDistMin, double xyz[3], double minPCoords[3])
 
virtual double IntersectImageWithLine (const double p1[3], const double p2[3], double t1, double t2, vtkProp3D *prop, vtkImageMapper3D *mapper)
 
virtual double IntersectProp3DWithLine (const double p1[3], const double p2[3], double t1, double t2, double tol, vtkProp3D *prop, vtkAbstractMapper3D *mapper)
 
void SetImageDataPickInfo (const double x[3], const int extent[6])
 
double ComputeVolumeOpacity (const int xi[3], const double pcoords[3], vtkImageData *data, vtkDataArray *scalars, vtkPiecewiseFunction *scalarOpacity, vtkPiecewiseFunction *gradientOpacity)
 
virtual double IntersectHyperTreeGridWithLine (const double[3], const double[3], double, double, vtkAbstractHyperTreeGridMapper *)
 Intersect a vtkAbstractHyperTreeGridMapper with a line by ray casting. More...
 
virtual bool RecursivelyProcessTree (vtkHyperTreeGridNonOrientedGeometryCursor *, int)
 Intersect a vtkAbstractHyperTreeGridMapper with a line by ray casting. More...
 
- Protected Member Functions inherited from vtkPicker
 vtkPicker ()
 
 ~vtkPicker () override
 
virtual int Pick3DInternal (vtkRenderer *ren, double p1World[4], double p2World[4])
 
void MarkPicked (vtkAssemblyPath *path, vtkProp3D *p, vtkAbstractMapper3D *m, double tMin, double mapperPos[3])
 
void MarkPickedData (vtkAssemblyPath *path, double tMin, double mapperPos[3], vtkAbstractMapper3D *mapper, vtkDataSet *input, vtkIdType flatBlockIndex=-1)
 
void Initialize () override
 
- Protected Member Functions inherited from vtkAbstractPropPicker
 vtkAbstractPropPicker ()
 
 ~vtkAbstractPropPicker () override
 
- Protected Member Functions inherited from vtkAbstractPicker
 vtkAbstractPicker ()
 
 ~vtkAbstractPicker () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static int ClipLineWithCroppingRegion (const double bounds[6], const int extent[6], int flags, const double x1[3], const double x2[3], double t1, double t2, int &extentPlaneId, int &numSegments, double *t1List, double *t2List, double *s1List, int *planeIdList)
 
- Static Protected Member Functions inherited from vtkCellPicker
static int ClipLineWithPlanes (vtkAbstractMapper3D *mapper, vtkMatrix4x4 *propMatrix, const double p1[3], const double p2[3], double &t1, double &t2, int &planeId)
 
static int ClipLineWithExtent (const int extent[6], const double x1[3], const double x2[3], double &t1, double &t2, int &planeId)
 
static int ComputeSurfaceNormal (vtkDataSet *data, vtkCell *cell, const double *weights, double normal[3])
 
static int ComputeSurfaceTCoord (vtkDataSet *data, vtkCell *cell, const double *weights, double tcoord[3])
 
static vtkTypeBool HasSubCells (int cellType)
 
static int GetNumberOfSubCells (vtkIdList *pointIds, int cellType)
 
static void GetSubCell (vtkDataSet *data, vtkIdList *pointIds, int subId, int cellType, vtkGenericCell *cell)
 
static void SubCellFromCell (vtkGenericCell *cell, int subId)
 
- Static Protected Member Functions inherited from vtkPicker
static bool CalculateRay (const double p1[3], const double p2[3], double ray[3], double &rayFactor)
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Protected Attributes

vtkTypeBool PickCroppingPlanes
 
int CroppingPlaneId
 
- Protected Attributes inherited from vtkCellPicker
vtkCollectionLocators
 
double VolumeOpacityIsovalue
 
vtkTypeBool UseVolumeGradientOpacity
 
vtkTypeBool PickClippingPlanes
 
int ClippingPlaneId
 
vtkIdType PointId
 
vtkIdType CellId
 
int SubId
 
double PCoords [3]
 
int PointIJK [3]
 
int CellIJK [3]
 
double PickNormal [3]
 
double MapperNormal [3]
 
vtkTextureTexture
 
vtkTypeBool PickTextureData
 
vtkBitArrayInMask
 
double WordlPoint [3]
 
- Protected Attributes inherited from vtkPicker
double Tolerance
 
double MapperPosition [3]
 
vtkAbstractMapper3DMapper
 
vtkDataSetDataSet
 
vtkCompositeDataSetCompositeDataSet
 
vtkIdType FlatBlockIndex
 
double GlobalTMin
 
vtkTransformTransform
 
vtkActorCollectionActors
 
vtkProp3DCollectionProp3Ds
 
vtkPointsPickedPositions
 
- Protected Attributes inherited from vtkAbstractPropPicker
vtkAssemblyPathPath
 
- Protected Attributes inherited from vtkAbstractPicker
vtkRendererRenderer
 
double SelectionPoint [3]
 
double PickPosition [3]
 
vtkTypeBool PickFromList
 
vtkPropCollectionPickList
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

ray-cast picker enhanced for volumes

vtkVolumePicker is a subclass of vtkCellPicker. It has one advantage over vtkCellPicker for volumes: it will be able to correctly perform picking when CroppingPlanes are present. This isn't possible for vtkCellPicker since it doesn't link to the VolumeRendering classes and hence cannot access information about the CroppingPlanes.

See also
vtkPicker vtkPointPicker vtkCellPicker
Thanks:
This class was contributed to VTK by David Gobbi on behalf of Atamai Inc.
Tests:
vtkVolumePicker (Tests)

Definition at line 31 of file vtkVolumePicker.h.

Member Typedef Documentation

◆ Superclass

Definition at line 35 of file vtkVolumePicker.h.

Constructor & Destructor Documentation

◆ vtkVolumePicker()

vtkVolumePicker::vtkVolumePicker ( )
protected

◆ ~vtkVolumePicker()

vtkVolumePicker::~vtkVolumePicker ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkVolumePicker* vtkVolumePicker::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkVolumePicker::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkVolumePicker::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCellPicker.

◆ SafeDownCast()

static vtkVolumePicker* vtkVolumePicker::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkVolumePicker::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCellPicker.

◆ NewInstance()

vtkVolumePicker* vtkVolumePicker::NewInstance ( ) const

◆ PrintSelf()

void vtkVolumePicker::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkCellPicker.

◆ SetPickCroppingPlanes()

virtual void vtkVolumePicker::SetPickCroppingPlanes ( vtkTypeBool  )
virtual

Set whether to pick the cropping planes of props that have them.

If this is set, then the pick will be done on the cropping planes rather than on the data. The GetCroppingPlaneId() method will return the index of the cropping plane of the volume that was picked. This setting is only relevant to the picking of volumes.

◆ PickCroppingPlanesOn()

virtual void vtkVolumePicker::PickCroppingPlanesOn ( )
virtual

Set whether to pick the cropping planes of props that have them.

If this is set, then the pick will be done on the cropping planes rather than on the data. The GetCroppingPlaneId() method will return the index of the cropping plane of the volume that was picked. This setting is only relevant to the picking of volumes.

◆ PickCroppingPlanesOff()

virtual void vtkVolumePicker::PickCroppingPlanesOff ( )
virtual

Set whether to pick the cropping planes of props that have them.

If this is set, then the pick will be done on the cropping planes rather than on the data. The GetCroppingPlaneId() method will return the index of the cropping plane of the volume that was picked. This setting is only relevant to the picking of volumes.

◆ GetPickCroppingPlanes()

virtual vtkTypeBool vtkVolumePicker::GetPickCroppingPlanes ( )
virtual

Set whether to pick the cropping planes of props that have them.

If this is set, then the pick will be done on the cropping planes rather than on the data. The GetCroppingPlaneId() method will return the index of the cropping plane of the volume that was picked. This setting is only relevant to the picking of volumes.

◆ GetCroppingPlaneId()

virtual int vtkVolumePicker::GetCroppingPlaneId ( )
virtual

Get the index of the cropping plane that the pick ray passed through on its way to the prop.

This will be set regardless of whether PickCroppingPlanes is on. The crop planes are ordered as follows: xmin, xmax, ymin, ymax, zmin, zmax. If the volume is not cropped, the value will bet set to -1.

◆ ResetPickInfo()

void vtkVolumePicker::ResetPickInfo ( )
overrideprotectedvirtual

Reimplemented from vtkCellPicker.

◆ IntersectVolumeWithLine()

double vtkVolumePicker::IntersectVolumeWithLine ( const double  p1[3],
const double  p2[3],
double  t1,
double  t2,
vtkProp3D prop,
vtkAbstractVolumeMapper mapper 
)
overrideprotectedvirtual

Reimplemented from vtkCellPicker.

◆ ClipLineWithCroppingRegion()

static int vtkVolumePicker::ClipLineWithCroppingRegion ( const double  bounds[6],
const int  extent[6],
int  flags,
const double  x1[3],
const double  x2[3],
double  t1,
double  t2,
int &  extentPlaneId,
int &  numSegments,
double *  t1List,
double *  t2List,
double *  s1List,
int *  planeIdList 
)
staticprotected

Member Data Documentation

◆ PickCroppingPlanes

vtkTypeBool vtkVolumePicker::PickCroppingPlanes
protected

Definition at line 75 of file vtkVolumePicker.h.

◆ CroppingPlaneId

int vtkVolumePicker::CroppingPlaneId
protected

Definition at line 76 of file vtkVolumePicker.h.


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