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 or its normal on the surface mesh. More...

#include <pqPointPickingHelper.h>

Inherits QObject.

Public Types
enum	PickOption { Coordinates, Normal, CoordinatesAndNormal }

Public Slots
void	setView (pqView *view)
	Set the view on which the pick is active. More...

Signals
void	pick (double x, double y, double z)
void	pickNormal (double px, double py, double pz, double nx, double ny, double nz)

Public Member Functions
	pqPointPickingHelper (const QKeySequence &keySequence, bool pick_on_mesh, pqPropertyWidget *parent=nullptr, PickOption pickOpt=Coordinates, bool pickCameraFocalInfo=false)
	~pqPointPickingHelper () override
bool	pickOnMesh () const
	Returns whether the helper will pick a point/normal in the mesh or simply a point/normal on the surface. More...
PickOption	getPickOption () const
	Returns whether the helper will pick a point or a normal. More...
bool	pickCameraFocalInfo () const
	Returns whether the camera focal point/normal can be returned if the picking on mesh fails. 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 or its normal on the surface mesh.

Definition at line 22 of file pqPointPickingHelper.h.

Member Enumeration Documentation

PickOption

enum pqPointPickingHelper::PickOption

Enumerator
Coordinates
Normal
CoordinatesAndNormal

Definition at line 28 of file pqPointPickingHelper.h.

Constructor & Destructor Documentation

pqPointPickingHelper()

pqPointPickingHelper::pqPointPickingHelper	(	const QKeySequence &	keySequence,
		bool	pick_on_mesh,
		pqPropertyWidget *	parent = nullptr,
		PickOption	pickOpt = Coordinates,
		bool	pickCameraFocalInfo = false
	)

~pqPointPickingHelper()

pqPointPickingHelper::~pqPointPickingHelper ( )

override

Member Function Documentation

pickOnMesh()

bool pqPointPickingHelper::pickOnMesh ( ) const

inline

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

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

Definition at line 46 of file pqPointPickingHelper.h.

getPickOption()

PickOption pqPointPickingHelper::getPickOption ( ) const

inline

Returns whether the helper will pick a point or a normal.

Definition at line 51 of file pqPointPickingHelper.h.

pickCameraFocalInfo()

bool pqPointPickingHelper::pickCameraFocalInfo ( ) const

inline

Returns whether the camera focal point/normal can be returned if the picking on mesh fails.

Definition at line 56 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.

pick

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

signal

pickNormal

void pqPointPickingHelper::pickNormal ( double  px, double  py, double  pz, double  nx, double  ny, double  nz  )

signal

---

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

• /builds/gitlab-kitware-sciviz-ci/Qt/ApplicationComponents/pqPointPickingHelper.h