VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAreaPicker Class Reference

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

#include <vtkAreaPicker.h>

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

Public Types

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.
 
vtkAreaPickerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void SetPickCoords (double x0, double y0, double x1, double y1)
 Set the default screen rectangle to pick in.
 
void SetRenderer (vtkRenderer *)
 Set the default renderer to pick on.
 
virtual int Pick ()
 Perform an AreaPick within the default screen rectangle and renderer.
 
virtual int AreaPick (double x0, double y0, double x1, double y1, vtkRenderer *renderer=nullptr)
 Perform pick operation in volume behind the given screen coordinates.
 
int Pick (double x0, double y0, double vtkNotUsed(z0), vtkRenderer *renderer=nullptr) override
 Perform pick operation in volume behind the given screen coordinate.
 
vtkProp3DCollectionGetProp3Ds ()
 Return a collection of all the prop 3D's that were intersected by the pick ray.
 
virtual vtkAbstractMapper3DGetMapper ()
 Return mapper that was picked (if any).
 
virtual vtkDataSetGetDataSet ()
 Get a pointer to the dataset that was picked (if any).
 
virtual vtkPlanesGetFrustum ()
 Return the six planes that define the selection frustum.
 
virtual vtkPointsGetClipPoints ()
 Return eight points that define the selection frustum.
 
- Public Member Functions inherited from vtkAbstractPropPicker
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAbstractPropPickerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual vtkPropGetViewProp ()
 Return the vtkProp that has been picked.
 
virtual vtkProp3DGetProp3D ()
 Return the vtkProp that has been picked.
 
virtual vtkActorGetActor ()
 Return the vtkActor that has been picked.
 
virtual vtkActor2DGetActor2D ()
 Return the vtkActor2D that has been picked.
 
virtual vtkVolumeGetVolume ()
 Return the vtkVolume that has been picked.
 
virtual vtkAssemblyGetAssembly ()
 Return the vtkAssembly that has been picked.
 
virtual vtkPropAssemblyGetPropAssembly ()
 Return the vtkPropAssembly that has been picked.
 
virtual void SetPath (vtkAssemblyPath *)
 Return the vtkAssemblyPath that has been picked.
 
virtual vtkAssemblyPathGetPath ()
 Return the vtkAssemblyPath that has been picked.
 
- Public Member Functions inherited from vtkAbstractPicker
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAbstractPickerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual int Pick (double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer)=0
 Perform pick operation with selection point provided.
 
int Pick (double selectionPt[3], vtkRenderer *ren)
 provided.
 
virtual int Pick3DPoint (double[3], vtkRenderer *)
 Perform pick operation with selection point provided.
 
virtual int Pick3DRay (double[3], double[4], vtkRenderer *)
 Perform pick operation with selection point and orientation provided.
 
void InitializePickList ()
 Initialize list of actors in pick list.
 
void AddPickList (vtkProp *)
 Add an actor to the pick list.
 
void DeletePickList (vtkProp *)
 Delete an actor from the pick list.
 
vtkPropCollectionGetPickList ()
 Return the list of actors in the PickList.
 
virtual vtkRendererGetRenderer ()
 Get the renderer in which pick event occurred.
 
virtual double * GetSelectionPoint ()
 Get the selection point in screen (pixel) coordinates.
 
virtual void GetSelectionPoint (double data[3])
 Get the selection point in screen (pixel) coordinates.
 
virtual double * GetPickPosition ()
 Return position in global coordinates of pick point.
 
virtual void GetPickPosition (double data[3])
 Return position in global coordinates of pick point.
 
virtual void SetPickFromList (vtkTypeBool)
 Use these methods to control whether to limit the picking to this list (rather than renderer's actors).
 
virtual vtkTypeBool GetPickFromList ()
 Use these methods to control whether to limit the picking to this list (rather than renderer's actors).
 
virtual void PickFromListOn ()
 Use these methods to control whether to limit the picking to this list (rather than renderer's actors).
 
virtual void PickFromListOff ()
 Use these methods to control whether to limit the picking to this list (rather than renderer's actors).
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
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.
 
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.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
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).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkAreaPickerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAreaPickerSafeDownCast (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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
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).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
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.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAreaPicker ()
 
 ~vtkAreaPicker () override
 
void Initialize () override
 
void DefineFrustum (double x0, double y0, double x1, double y1, vtkRenderer *)
 
virtual int PickProps (vtkRenderer *renderer)
 
int TypeDecipher (vtkProp *, vtkAbstractMapper3D **)
 
int ABoxFrustumIsect (double bounds[], double &mindist)
 
- Protected Member Functions inherited from vtkAbstractPropPicker
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAbstractPropPicker ()
 
 ~vtkAbstractPropPicker () override
 
void Initialize () override
 
- Protected Member Functions inherited from vtkAbstractPicker
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAbstractPicker ()
 
 ~vtkAbstractPicker () override
 
virtual void Initialize ()
 
- 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkPointsClipPoints
 
vtkPlanesFrustum
 
vtkProp3DCollectionProp3Ds
 
vtkAbstractMapper3DMapper
 
vtkDataSetDataSet
 
vtkExtractSelectedFrustumFrustumExtractor
 
double X0
 
double Y0
 
double X1
 
double Y1
 
- 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
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Picks props behind a selection rectangle on a viewport.

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.

See also
vtkInteractorStyleRubberBandPick, vtkExtractSelectedFrustum.
Events:
vtkCommand::EndPickEvent vtkCommand::PickEvent vtkCommand::StartPickEvent
Online Examples:

Tests:
vtkAreaPicker (Tests)

Definition at line 134 of file vtkAreaPicker.h.

Member Typedef Documentation

◆ Superclass

Definition at line 138 of file vtkAreaPicker.h.

Constructor & Destructor Documentation

◆ vtkAreaPicker()

vtkAreaPicker::vtkAreaPicker ( )
protected

◆ ~vtkAreaPicker()

vtkAreaPicker::~vtkAreaPicker ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkAreaPicker * vtkAreaPicker::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkAreaPicker::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 vtkAbstractPropPicker.

Reimplemented in vtkRenderedAreaPicker.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAreaPicker::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAbstractPropPicker.

Reimplemented in vtkRenderedAreaPicker.

◆ NewInstance()

vtkAreaPicker * vtkAreaPicker::NewInstance ( ) const

◆ PrintSelf()

void vtkAreaPicker::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 vtkAbstractPropPicker.

Reimplemented in vtkRenderedAreaPicker.

◆ SetPickCoords()

void vtkAreaPicker::SetPickCoords ( double  x0,
double  y0,
double  x1,
double  y1 
)

Set the default screen rectangle to pick in.

◆ SetRenderer()

void vtkAreaPicker::SetRenderer ( vtkRenderer )

Set the default renderer to pick on.

◆ Pick() [1/2]

virtual int vtkAreaPicker::Pick ( )
virtual

Perform an AreaPick within the default screen rectangle and renderer.

◆ AreaPick()

virtual int vtkAreaPicker::AreaPick ( double  x0,
double  y0,
double  x1,
double  y1,
vtkRenderer renderer = nullptr 
)
virtual

Perform pick operation in volume behind the given screen coordinates.

Props intersecting the selection frustum will be accessible via GetProp3D. GetPlanes returns a vtkImplicitFunction suitable for vtkExtractGeometry.

Reimplemented in vtkRenderedAreaPicker.

◆ Pick() [2/2]

int vtkAreaPicker::Pick ( double  x0,
double  y0,
double   vtkNotUsedz0,
vtkRenderer renderer = nullptr 
)
inlineoverride

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.

Definition at line 168 of file vtkAreaPicker.h.

◆ GetMapper()

virtual vtkAbstractMapper3D * vtkAreaPicker::GetMapper ( )
virtual

Return mapper that was picked (if any).

◆ GetDataSet()

virtual vtkDataSet * vtkAreaPicker::GetDataSet ( )
virtual

Get a pointer to the dataset that was picked (if any).

If nothing was picked then NULL is returned.

◆ GetProp3Ds()

vtkProp3DCollection * vtkAreaPicker::GetProp3Ds ( )
inline

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

This collection is not sorted.

Definition at line 192 of file vtkAreaPicker.h.

◆ GetFrustum()

virtual vtkPlanes * 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.

◆ GetClipPoints()

virtual vtkPoints * vtkAreaPicker::GetClipPoints ( )
virtual

Return eight points that define the selection frustum.

◆ Initialize()

void vtkAreaPicker::Initialize ( )
overrideprotectedvirtual

Reimplemented from vtkAbstractPropPicker.

◆ DefineFrustum()

void vtkAreaPicker::DefineFrustum ( double  x0,
double  y0,
double  x1,
double  y1,
vtkRenderer  
)
protected

◆ PickProps()

virtual int vtkAreaPicker::PickProps ( vtkRenderer renderer)
protectedvirtual

◆ TypeDecipher()

int vtkAreaPicker::TypeDecipher ( vtkProp ,
vtkAbstractMapper3D **   
)
protected

◆ ABoxFrustumIsect()

int vtkAreaPicker::ABoxFrustumIsect ( double  bounds[],
double &  mindist 
)
protected

Member Data Documentation

◆ ClipPoints

vtkPoints* vtkAreaPicker::ClipPoints
protected

Definition at line 221 of file vtkAreaPicker.h.

◆ Frustum

vtkPlanes* vtkAreaPicker::Frustum
protected

Definition at line 222 of file vtkAreaPicker.h.

◆ Prop3Ds

vtkProp3DCollection* vtkAreaPicker::Prop3Ds
protected

Definition at line 224 of file vtkAreaPicker.h.

◆ Mapper

vtkAbstractMapper3D* vtkAreaPicker::Mapper
protected

Definition at line 225 of file vtkAreaPicker.h.

◆ DataSet

vtkDataSet* vtkAreaPicker::DataSet
protected

Definition at line 226 of file vtkAreaPicker.h.

◆ FrustumExtractor

vtkExtractSelectedFrustum* vtkAreaPicker::FrustumExtractor
protected

Definition at line 229 of file vtkAreaPicker.h.

◆ X0

double vtkAreaPicker::X0
protected

Definition at line 231 of file vtkAreaPicker.h.

◆ Y0

double vtkAreaPicker::Y0
protected

Definition at line 232 of file vtkAreaPicker.h.

◆ X1

double vtkAreaPicker::X1
protected

Definition at line 233 of file vtkAreaPicker.h.

◆ Y1

double vtkAreaPicker::Y1
protected

Definition at line 234 of file vtkAreaPicker.h.


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