vtkPropPicker Class Reference

#include <vtkPropPicker.h>

Inheritance diagram for vtkPropPicker:

[legend]Collaboration diagram for vtkPropPicker:

[legend]List of all members.

---

Detailed Description

pick an actor/prop using graphics hardware

vtkPropPicker is used to pick an actor/prop given a selection point (in display coordinates) and a renderer. This class uses graphics hardware/rendering system to pick rapidly (as compared to using ray casting as does vtkCellPicker and vtkPointPicker). This class determines the actor/prop and pick position in world coordinates; point and cell ids are not determined.

See also:

vtkPicker vtkWorldPointPicker vtkCellPicker vtkPointPicker

Events:

vtkCommand::PickEvent vtkCommand::EndPickEvent vtkCommand::StartPickEvent

Tests:

vtkPropPicker (Tests)

Definition at line 43 of file vtkPropPicker.h.

Public Types
typedef vtkAbstractPropPicker	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	PickProp (double selectionX, double selectionY, vtkRenderer *renderer)
int	PickProp (double selectionX, double selectionY, vtkRenderer *renderer, vtkPropCollection *pickfrom)
int	Pick (double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer)
int	Pick (double selectionPt[3], vtkRenderer *renderer)
Static Public Member Functions
static vtkPropPicker *	New ()
static int	IsTypeOf (const char *type)
static vtkPropPicker *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkPropPicker ()
	~vtkPropPicker ()
void	Initialize ()
Protected Attributes
vtkPropCollection *	PickFromProps
vtkWorldPointPicker *	WorldPointPicker

---

Member Typedef Documentation

typedef vtkAbstractPropPicker vtkPropPicker::Superclass

Reimplemented from vtkAbstractPropPicker. Definition at line 48 of file vtkPropPicker.h.

---

Constructor & Destructor Documentation

vtkPropPicker::vtkPropPicker (   )  [protected]

vtkPropPicker::~vtkPropPicker (   )  [protected]

---

Member Function Documentation

static vtkPropPicker* vtkPropPicker::New (   )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkObject.

virtual const char* vtkPropPicker::GetClassName (   )  [virtual]

Reimplemented from vtkAbstractPropPicker.

static int vtkPropPicker::IsTypeOf (  const char *  type  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkAbstractPropPicker.

virtual int vtkPropPicker::IsA (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkAbstractPropPicker.

static vtkPropPicker* vtkPropPicker::SafeDownCast (  vtkObject *  o  )  [static]

Reimplemented from vtkAbstractPropPicker.

void vtkPropPicker::PrintSelf (  ostream &  os, vtkIndent  indent )  [virtual]

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.

int vtkPropPicker::PickProp (  double  selectionX, double  selectionY, vtkRenderer *  renderer )

Perform the pick and set the PickedProp ivar. If something is picked, a 1 is returned, otherwise 0 is returned. Use the GetViewProp() method to get the instance of vtkProp that was picked. Props are picked from the renderers list of pickable Props.

int vtkPropPicker::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 vtkPropPicker::Pick (  double  selectionX, double  selectionY, double  selectionZ, vtkRenderer *  renderer )  [virtual]

Overide superclasses' Pick() method. Implements vtkAbstractPicker.

int vtkPropPicker::Pick (  double  selectionPt[3], vtkRenderer *  renderer )  [inline]

Overide superclasses' Pick() method. Reimplemented from vtkAbstractPicker. Definition at line 68 of file vtkPropPicker.h. References vtkAbstractPicker::Pick().

void vtkPropPicker::Initialize (   )  [protected, virtual]

Reimplemented from vtkAbstractPropPicker.

---

Member Data Documentation

vtkPropCollection* vtkPropPicker::PickFromProps [protected]

Definition at line 79 of file vtkPropPicker.h.

vtkWorldPointPicker* vtkPropPicker::WorldPointPicker [protected]

Definition at line 82 of file vtkPropPicker.h.

---

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

• dox/Rendering/vtkPropPicker.h

---