VTK  9.4.20241202
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkAbstractPropPicker Class Reference

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

#include <vtkAbstractPropPicker.h>

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

Public Types

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.
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
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.
 
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.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

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 (vtkTypeBool 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 vtkTypeBool 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
 
 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 *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

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
 

Additional Inherited Members

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

Detailed Description

abstract API for pickers that can pick an instance of vtkProp

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

Warning
Because a vtkProp can be placed into different assemblies, or even in different leaf positions of the same assembly, the vtkAssemblyPath is used to fully qualify exactly which use of the vtkProp was picked, including its position (since vtkAssemblyPath includes a transformation matrix per node).
The class returns information about picked actors, props, etc. Note that what is returned by these methods is the top level of the assembly path. This can cause a lot of confusion! For example, if you pick a vtkAssembly, and the returned vtkAssemblyPath has as a leaf a vtkActor, then if you invoke GetActor(), you will get NULL, even though an actor was indeed picked. (GetAssembly() will return something.) Note that the safest thing to do is to do a GetViewProp(), which will always return something if something was picked. A better way to manage picking is to work with vtkAssemblyPath, since this completely defines the pick path from top to bottom in a assembly hierarchy, and avoids confusion when the same prop is used in different assemblies.
The returned assembly paths refer to assembly nodes that in turn refer to vtkProp and vtkMatrix. This association to vtkProp is not a reference counted association, meaning that dangling references are possible if you do a pick, get an assembly path, and then delete a vtkProp. (Reason: assembly paths create many self-referencing loops that destroy reference counting.)
See also
vtkPropPicker vtkPicker vtkWorldPointPicker vtkCellPicker vtkPointPicker vtkAssemblyPath vtkAssemblyNode vtkAssemblyPaths vtkAbstractPicker vtkRenderer

Definition at line 68 of file vtkAbstractPropPicker.h.

Member Typedef Documentation

◆ Superclass

Definition at line 71 of file vtkAbstractPropPicker.h.

Constructor & Destructor Documentation

◆ vtkAbstractPropPicker()

vtkAbstractPropPicker::vtkAbstractPropPicker ( )
protected

◆ ~vtkAbstractPropPicker()

vtkAbstractPropPicker::~vtkAbstractPropPicker ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkResliceCursorPicker, vtkAreaPicker, vtkCellPicker, vtkHardwarePicker, vtkPicker, vtkPointPicker, vtkPropPicker, vtkRenderedAreaPicker, vtkVolumePicker, vtkVRHardwarePicker, and vtkZSpaceHardwarePicker.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAbstractPropPicker::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkAbstractPropPicker * vtkAbstractPropPicker::NewInstance ( ) const

◆ PrintSelf()

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

Reimplemented in vtkResliceCursorPicker, vtkAreaPicker, vtkCellPicker, vtkHardwarePicker, vtkPicker, vtkPointPicker, vtkPropPicker, vtkRenderedAreaPicker, vtkVolumePicker, vtkVRHardwarePicker, and vtkZSpaceHardwarePicker.

◆ SetPath()

virtual void vtkAbstractPropPicker::SetPath ( vtkAssemblyPath )
virtual

Return the vtkAssemblyPath that has been picked.

The assembly path lists all the vtkProps that form an assembly. If no assembly is present, then the assembly path will have one node (which is the picked prop). The set method is used internally to set the path. (Note: the structure of an assembly path is a collection of vtkAssemblyNode, each node pointing to a vtkProp and (possibly) a transformation matrix.)

◆ GetPath()

virtual vtkAssemblyPath * vtkAbstractPropPicker::GetPath ( )
virtual

Return the vtkAssemblyPath that has been picked.

The assembly path lists all the vtkProps that form an assembly. If no assembly is present, then the assembly path will have one node (which is the picked prop). The set method is used internally to set the path. (Note: the structure of an assembly path is a collection of vtkAssemblyNode, each node pointing to a vtkProp and (possibly) a transformation matrix.)

◆ GetViewProp()

virtual vtkProp * vtkAbstractPropPicker::GetViewProp ( )
virtual

Return the vtkProp that has been picked.

If NULL, nothing was picked. If anything at all was picked, this method will return something.

◆ GetProp3D()

virtual vtkProp3D * vtkAbstractPropPicker::GetProp3D ( )
virtual

Return the vtkProp that has been picked.

If NULL, no vtkProp3D was picked.

◆ GetActor()

virtual vtkActor * vtkAbstractPropPicker::GetActor ( )
virtual

Return the vtkActor that has been picked.

If NULL, no actor was picked.

◆ GetActor2D()

virtual vtkActor2D * vtkAbstractPropPicker::GetActor2D ( )
virtual

Return the vtkActor2D that has been picked.

If NULL, no actor2D was picked.

◆ GetVolume()

virtual vtkVolume * vtkAbstractPropPicker::GetVolume ( )
virtual

Return the vtkVolume that has been picked.

If NULL, no volume was picked.

◆ GetAssembly()

virtual vtkAssembly * vtkAbstractPropPicker::GetAssembly ( )
virtual

Return the vtkAssembly that has been picked.

If NULL, no assembly was picked. (Note: the returned assembly is the first node in the assembly path. If the path is one node long, then the assembly and the prop are the same, assuming that the first node is a vtkAssembly.)

◆ GetPropAssembly()

virtual vtkPropAssembly * vtkAbstractPropPicker::GetPropAssembly ( )
virtual

Return the vtkPropAssembly that has been picked.

If NULL, no prop assembly was picked. (Note: the returned prop assembly is the first node in the assembly path. If the path is one node long, then the prop assembly and the prop are the same, assuming that the first node is a vtkPropAssembly.)

◆ Initialize()

void vtkAbstractPropPicker::Initialize ( )
overrideprotectedvirtual

Member Data Documentation

◆ Path

vtkAssemblyPath* vtkAbstractPropPicker::Path
protected

Definition at line 142 of file vtkAbstractPropPicker.h.


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