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

pick an actor/prop given a controller position and orientation More...

#include <vtkVRHardwarePicker.h>

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

Public Types

typedef vtkPropPicker Superclass
 
- Public Types inherited from vtkPropPicker
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.
 
vtkVRHardwarePickerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual int PickProp (double selectionPt[3], double eventWorldOrientation[4], vtkRenderer *renderer, vtkPropCollection *pickfrom, bool actorPassOnly)
 Perform a pick from the user-provided list of vtkProps.
 
virtual vtkSelectionGetSelection ()
 
- Public Member Functions inherited from vtkPropPicker
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkPropPickerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
int PickProp (double selectionX, double selectionY, vtkRenderer *renderer)
 Perform the pick and set the PickedProp ivar.
 
int PickProp (double selectionX, double selectionY, vtkRenderer *renderer, vtkPropCollection *pickfrom)
 Perform a pick from the user-provided list of vtkProps and not from the list of vtkProps that the render maintains.
 
int Pick (double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer) override
 override superclasses' Pick() method.
 
int Pick (double selectionPt[3], vtkRenderer *renderer)
 
int Pick3DPoint (double selectionPt[3], vtkRenderer *ren) override
 Perform pick operation with selection point provided.
 
int PickProp3DPoint (double pos[3], vtkRenderer *renderer)
 Perform the pick and set the PickedProp ivar.
 
int PickProp3DPoint (double pos[3], vtkRenderer *renderer, vtkPropCollection *pickfrom)
 Perform a pick from the user-provided list of vtkProps and not from the list of vtkProps that the render maintains.
 
virtual int PickProp3DRay (double selectionPt[3], double eventWorldOrientation[4], vtkRenderer *renderer, vtkPropCollection *pickfrom)
 Perform a pick from the user-provided list of vtkProps.
 
int Pick3DRay (double selectionPt[3], double orient[4], vtkRenderer *ren) override
 Perform pick operation with selection point provided.
 
- 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 vtkVRHardwarePickerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkVRHardwarePickerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPropPicker
static vtkPropPickerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropPickerSafeDownCast (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
 
 vtkVRHardwarePicker ()=default
 
 ~vtkVRHardwarePicker () override=default
 
void Initialize () override
 
- Protected Member Functions inherited from vtkPropPicker
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPropPicker ()
 
 ~vtkPropPicker () override
 
void Initialize () override
 
- 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

vtkSelectionSelection = nullptr
 
- Protected Attributes inherited from vtkPropPicker
vtkPropCollectionPickFromProps
 
vtkWorldPointPickerWorldPointPicker
 
- 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

pick an actor/prop given a controller position and orientation

vtkVRHardwarePicker is used to pick an actor/prop along a ray. This version uses a hardware selector to do the picking.

See also
vtkProp3DPicker vtkVRInteractorStylePointer
Events:
vtkCommand::EndPickEvent vtkCommand::StartPickEvent

Definition at line 37 of file vtkVRHardwarePicker.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkVRHardwarePicker.h.

Constructor & Destructor Documentation

◆ vtkVRHardwarePicker()

vtkVRHardwarePicker::vtkVRHardwarePicker ( )
protecteddefault

◆ ~vtkVRHardwarePicker()

vtkVRHardwarePicker::~vtkVRHardwarePicker ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkVRHardwarePicker * vtkVRHardwarePicker::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkVRHardwarePicker::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 vtkPropPicker.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkVRHardwarePicker::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPropPicker.

◆ NewInstance()

vtkVRHardwarePicker * vtkVRHardwarePicker::NewInstance ( ) const

◆ PrintSelf()

void vtkVRHardwarePicker::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 vtkPropPicker.

◆ PickProp()

virtual int vtkVRHardwarePicker::PickProp ( double  selectionPt[3],
double  eventWorldOrientation[4],
vtkRenderer renderer,
vtkPropCollection pickfrom,
bool  actorPassOnly 
)
virtual

Perform a pick from the user-provided list of vtkProps.

◆ GetSelection()

virtual vtkSelection * vtkVRHardwarePicker::GetSelection ( )
virtual

◆ Initialize()

void vtkVRHardwarePicker::Initialize ( )
overrideprotectedvirtual

Reimplemented from vtkPropPicker.

Member Data Documentation

◆ Selection

vtkSelection* vtkVRHardwarePicker::Selection = nullptr
protected

Definition at line 59 of file vtkVRHardwarePicker.h.


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