Public Slots | Signals | Public Member Functions | List of all members
pqPointPickingHelper Class Reference

pqPointPickingHelper is a helper class that is designed for use by subclasses of pqInteractivePropertyWidget (or others) that want to support using a shortcut key to pick a point on the surface mesh. More...

#include <pqPointPickingHelper.h>

Inherits QObject.

Public Slots

void setView (pqView *view)
 Set the view on which the pick is active. More...
 
void setShortcutEnabled (bool)
 Enable/disable the pick point shortcut. More...
 

Signals

void pick (double x, double y, double z)
 

Public Member Functions

 pqPointPickingHelper (const QKeySequence &keySequence, bool pick_on_mesh, QObject *parent=0)
 
 ~pqPointPickingHelper () override
 
bool pickOnMesh () const
 Returns whether the helper will pick a point in the mesh or simply a point on the surface. More...
 

Detailed Description

pqPointPickingHelper is a helper class that is designed for use by subclasses of pqInteractivePropertyWidget (or others) that want to support using a shortcut key to pick a point on the surface mesh.

Definition at line 49 of file pqPointPickingHelper.h.

Constructor & Destructor Documentation

◆ pqPointPickingHelper()

pqPointPickingHelper::pqPointPickingHelper ( const QKeySequence &  keySequence,
bool  pick_on_mesh,
QObject *  parent = 0 
)

◆ ~pqPointPickingHelper()

pqPointPickingHelper::~pqPointPickingHelper ( )
override

Member Function Documentation

◆ pickOnMesh()

bool pqPointPickingHelper::pickOnMesh ( ) const
inline

Returns whether the helper will pick a point in the mesh or simply a point on the surface.

In other words, if pickOnMesh returns true, then the picked point will always be a point specified in the points that form the mesh.

Definition at line 64 of file pqPointPickingHelper.h.

◆ setView

void pqPointPickingHelper::setView ( pqView view)
slot

Set the view on which the pick is active.

We only support pqRenderView and subclasses currently.

◆ setShortcutEnabled

void pqPointPickingHelper::setShortcutEnabled ( bool  )
slot

Enable/disable the pick point shortcut.

◆ pick

void pqPointPickingHelper::pick ( double  x,
double  y,
double  z 
)
signal

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