pick a point or snap to point of an actor/prop using graphics hardware More...

#include <vtkHardwarePicker.h>

Inheritance diagram for vtkHardwarePicker:

Collaboration diagram for vtkHardwarePicker:

Public Types
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.

vtkHardwarePicker *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual bool	GetNormalFlipped ()
	Get if normal is flipped.

int	Pick (double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer) override
	Perform the pick operation set the PickedProp.


virtual void	SetSnapToMeshPoint (bool)
	Set/Get if the picker will snap to the closest mesh point or get the actual intersected point.

virtual bool	GetSnapToMeshPoint ()
	Set/Get if the picker will snap to the closest mesh point or get the actual intersected point.

virtual void	SnapToMeshPointOn ()
	Set/Get if the picker will snap to the closest mesh point or get the actual intersected point.

virtual void	SnapToMeshPointOff ()
	Set/Get if the picker will snap to the closest mesh point or get the actual intersected point.


virtual void	SetPixelTolerance (int)
	When SnapToMeshPoint is on, this is the pixel tolerance to use when snapping.

virtual int	GetPixelTolerance ()
	When SnapToMeshPoint is on, this is the pixel tolerance to use when snapping.


virtual vtkAbstractMapper3D *	GetMapper ()
	Return mapper that was picked (if any).


virtual vtkDataSet *	GetDataSet ()
	Get a pointer to the dataset that was picked (if any).


virtual vtkDataObject *	GetDataObject ()
	Get a pointer to the dataobject that was picked (if any).


virtual vtkCompositeDataSet *	GetCompositeDataSet ()
	Get a pointer to the composite dataset that was picked (if any).


virtual vtkIdType	GetFlatBlockIndex ()
	Get the flat block index of the vtkDataSet in the composite dataset that was picked (if any).


virtual vtkIdType	GetPointId ()
	Get the id of the picked point.


virtual vtkIdType	GetCellId ()
	Get the id of the picked cell.


virtual int	GetSubId ()
	Get the subId of the picked cell.


virtual vtkIdType	GetCellGridCellTypeId ()
	Get the id of the picked cell type in a vtkCellGrid.


virtual vtkIdType	GetCellGridSourceSpecId ()
	Get the id of the picked cell/side spec (the vtkDGCell::Source object) in a vtkCellGrid's cell type.


virtual vtkIdType	GetCellGridTupleId ()
	Get the id of the tuple in the cell/side's connectivity array in a vtkCellGrid.


virtual double *	GetPCoords ()
	Get the parametric coordinates of the picked cell.

virtual void	GetPCoords (double &, double &, double &)
	Get the parametric coordinates of the picked cell.

virtual void	GetPCoords (double[3])
	Get the parametric coordinates of the picked cell.


virtual double *	GetPickNormal ()
	Get the normal of the point at the PickPosition.

virtual void	GetPickNormal (double data[3])
	Get the normal of the point at the PickPosition.

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.

vtkAbstractPropPicker *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual vtkProp *	GetViewProp ()
	Return the vtkProp that has been picked.

virtual vtkProp3D *	GetProp3D ()
	Return the vtkProp that has been picked.

virtual vtkActor *	GetActor ()
	Return the vtkActor that has been picked.

virtual vtkActor2D *	GetActor2D ()
	Return the vtkActor2D that has been picked.

virtual vtkVolume *	GetVolume ()
	Return the vtkVolume that has been picked.

virtual vtkAssembly *	GetAssembly ()
	Return the vtkAssembly that has been picked.

virtual vtkPropAssembly *	GetPropAssembly ()
	Return the vtkPropAssembly that has been picked.

virtual void	SetPath (vtkAssemblyPath *)
	Return the vtkAssemblyPath that has been picked.

virtual vtkAssemblyPath *	GetPath ()
	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.

vtkAbstractPicker *	NewInstance () 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.

vtkPropCollection *	GetPickList ()
	Return the list of actors in the PickList.

virtual vtkRenderer *	GetRenderer ()
	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.

vtkCommand *	GetCommand (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 vtkHardwarePicker *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkHardwarePicker *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractPropPicker
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractPropPicker *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractPicker
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractPicker *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () const

	vtkHardwarePicker ()

	~vtkHardwarePicker () override

void	Initialize () override

int	TypeDecipher (vtkProp , vtkAbstractMapper3D *)

void	FixNormalSign ()
	Fix normal sign in case the orientation of the picked cell is wrong.

int	ComputeSurfaceNormal (vtkDataSet data, vtkCell cell, double *weights)
	Compute the intersection normal either by interpolating the point normals at the intersected point, or by computing the plane normal for the 2D intersected face/cell.

void	ComputeIntersectionFromDataSet (vtkDataSet *ds)
	Compute the intersection using provided dataset.

Protected Member Functions inherited from vtkAbstractPropPicker
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractPropPicker ()

	~vtkAbstractPropPicker () override

void	Initialize () override

Protected Member Functions inherited from vtkAbstractPicker
virtual vtkObjectBase *	NewInstanceInternal () 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
bool	SnapToMeshPoint

int	PixelTolerance

vtkNew< vtkPropCollection >	PickableProps

vtkSmartPointer< vtkSelection >	HardwareSelection

double	NearRayPoint [3]

double	FarRayPoint [3]

vtkAbstractMapper3D *	Mapper

vtkDataSet *	DataSet

vtkDataObject *	DataObject

vtkCompositeDataSet *	CompositeDataSet

vtkIdType	FlatBlockIndex

vtkIdType	PointId

vtkIdType	CellId

int	SubId

vtkIdType	CellGridCellTypeId

vtkIdType	CellGridSourceSpecId

vtkIdType	CellGridTupleId

double	PCoords [3]

double	PickNormal [3]

bool	NormalFlipped

Protected Attributes inherited from vtkAbstractPropPicker
vtkAssemblyPath *	Path

Protected Attributes inherited from vtkAbstractPicker
vtkRenderer *	Renderer

double	SelectionPoint [3]

double	PickPosition [3]

vtkTypeBool	PickFromList

vtkPropCollection *	PickList

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

pick a point or snap to point of an actor/prop using graphics hardware

vtkHardwarePicker is used to pick point or snap to point of 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 pick position, and pick normal in world coordinates; pointId is determined if snapping is enabled, otherwise the cellId is determined. if no actor/prop is picked, pick position = camera focal point, and pick normal = camera plane normal.

Warning: This class supports only picking in a screen, and not in VR.

See also: vtkPropPicker vtkPicker vtkWorldPointPicker vtkCellPicker vtkPointPicker

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

Tests:: vtkHardwarePicker (Tests)

Definition at line 44 of file vtkHardwarePicker.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAbstractPropPicker vtkHardwarePicker::Superclass

Definition at line 48 of file vtkHardwarePicker.h.

Constructor & Destructor Documentation

◆ vtkHardwarePicker()

vtkHardwarePicker::vtkHardwarePicker ( )

protected

◆ ~vtkHardwarePicker()

vtkHardwarePicker::~vtkHardwarePicker ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkHardwarePicker * vtkHardwarePicker::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkHardwarePicker::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractPropPicker.

◆ NewInstance()

vtkHardwarePicker * vtkHardwarePicker::NewInstance ( ) const

◆ PrintSelf()

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

◆ SetSnapToMeshPoint()

virtual void vtkHardwarePicker::SetSnapToMeshPoint ( bool )

virtual

Set/Get if the picker will snap to the closest mesh point or get the actual intersected point.

Default is off.

◆ GetSnapToMeshPoint()

virtual bool vtkHardwarePicker::GetSnapToMeshPoint ( )

virtual

Set/Get if the picker will snap to the closest mesh point or get the actual intersected point.

Default is off.

◆ SnapToMeshPointOn()

virtual void vtkHardwarePicker::SnapToMeshPointOn ( )

virtual

Set/Get if the picker will snap to the closest mesh point or get the actual intersected point.

Default is off.

◆ SnapToMeshPointOff()

virtual void vtkHardwarePicker::SnapToMeshPointOff ( )

virtual

Set/Get if the picker will snap to the closest mesh point or get the actual intersected point.

Default is off.

◆ SetPixelTolerance()

virtual void vtkHardwarePicker::SetPixelTolerance ( int )

virtual

When SnapToMeshPoint is on, this is the pixel tolerance to use when snapping.

Default is 5.

◆ GetPixelTolerance()

virtual int vtkHardwarePicker::GetPixelTolerance ( )

virtual

When SnapToMeshPoint is on, this is the pixel tolerance to use when snapping.

Default is 5.

◆ GetMapper()

virtual vtkAbstractMapper3D * vtkHardwarePicker::GetMapper ( )

virtual

Return mapper that was picked (if any).

Note: Use vtkWeakPointer. This is because the Mapper may be deleted.

◆ GetDataSet()

virtual vtkDataSet * vtkHardwarePicker::GetDataSet ( )

virtual

Get a pointer to the dataset that was picked (if any).

If nothing was picked then nullptr is returned.

Note: Use vtkWeakPointer. This is because the DataSet may be deleted.

◆ GetDataObject()

virtual vtkDataObject * vtkHardwarePicker::GetDataObject ( )

virtual

Get a pointer to the dataobject that was picked (if any).

If nothing was picked then nullptr is returned.

Note: Use vtkWeakPointer. This is because the DataObject may be deleted.

◆ GetCompositeDataSet()

virtual vtkCompositeDataSet * vtkHardwarePicker::GetCompositeDataSet ( )

virtual

Get a pointer to the composite dataset that was picked (if any).

If nothing was picked or a non-composite data object was picked then nullptr is returned.

Note: Use vtkWeakPointer. This is because the CompositeDataSet may be deleted.

◆ GetFlatBlockIndex()

virtual vtkIdType vtkHardwarePicker::GetFlatBlockIndex ( )

virtual

Get the flat block index of the vtkDataSet in the composite dataset that was picked (if any).

If nothing was picked or a non-composite data object was picked then -1 is returned.

◆ GetPointId()

virtual vtkIdType vtkHardwarePicker::GetPointId ( )

virtual

Get the id of the picked point.

If a prop is picked:

1) if SnapOnMeshPoint is on, the pointId of the prop's dataset will be returned 2) If SnapOnMeshPoint is off, PointId = -1;

If a prop is not picked, PointId = -1;

◆ GetCellId()

virtual vtkIdType vtkHardwarePicker::GetCellId ( )

virtual

Get the id of the picked cell.

If a prop is picked:

1) If SnapOnMeshPoint is on, CellId = -1. 2) If SnapOnMeshPoint is off, the cellId of the prop's dataset will be returned

if a prop is not picked, CellId = -1.

◆ GetSubId()

virtual int vtkHardwarePicker::GetSubId ( )

virtual

Get the subId of the picked cell.

This is useful, for example, if the data is made of triangle strips.

If a prop is picked:

1) If SnapOnMeshPoint is on, SubId = -1. 2) If SnapOnMeshPoint is off and the picked cell is a triangle strip, the subId of the intersected triangle will be returned, otherwise SubId = -1.

If a prop is not picked, SubId = -1.

◆ GetCellGridCellTypeId()

virtual vtkIdType vtkHardwarePicker::GetCellGridCellTypeId ( )

virtual

Get the id of the picked cell type in a vtkCellGrid.

If a prop is picked, cellGridCellTypeId >= 0

if a prop is not picked, CellGridCellTypeId = -1.

◆ GetCellGridSourceSpecId()

virtual vtkIdType vtkHardwarePicker::GetCellGridSourceSpecId ( )

virtual

Get the id of the picked cell/side spec (the vtkDGCell::Source object) in a vtkCellGrid's cell type.

If a prop is picked:

1) If a cell spec was picked, CellGridSourceSpecId = 0. 2) If a side spec was picked, the CellGridSourceSpecId will be >= 1.

if a prop is not picked, CellGridSourceSpecId = -1.

◆ GetCellGridTupleId()

virtual vtkIdType vtkHardwarePicker::GetCellGridTupleId ( )

virtual

Get the id of the tuple in the cell/side's connectivity array in a vtkCellGrid.

If a prop is picked, CellGridTupleId >= 0

if a prop is not picked, CellGridTupleId = -1.

◆ GetPCoords() [1/3]

virtual double * vtkHardwarePicker::GetPCoords ( )

virtual

Get the parametric coordinates of the picked cell.

PCoords can be used to compute the weights that are needed to interpolate data values within the cell.

If a prop is picked:

1) If SnapOnMeshPoint is on, PCoords will be a vector of std::numeric_limits<double>::quiet_NaN(). 2) If SnapOnMeshPoint is off, PCoords will be extracted and the intersection point of the cell.

if a prop is not picked, PCoords will be a vector of std::numeric_limits<double>::quiet_NaN().

◆ GetPCoords() [2/3]

virtual void vtkHardwarePicker::GetPCoords	(	double &	,
		double &	,
		double &
	)

virtual

Get the parametric coordinates of the picked cell.

PCoords can be used to compute the weights that are needed to interpolate data values within the cell.

If a prop is picked:

1) If SnapOnMeshPoint is on, PCoords will be a vector of std::numeric_limits<double>::quiet_NaN(). 2) If SnapOnMeshPoint is off, PCoords will be extracted and the intersection point of the cell.

if a prop is not picked, PCoords will be a vector of std::numeric_limits<double>::quiet_NaN().

◆ GetPCoords() [3/3]

virtual void vtkHardwarePicker::GetPCoords ( double [3] )

virtual

Get the parametric coordinates of the picked cell.

PCoords can be used to compute the weights that are needed to interpolate data values within the cell.

If a prop is picked:

1) If SnapOnMeshPoint is on, PCoords will be a vector of std::numeric_limits<double>::quiet_NaN(). 2) If SnapOnMeshPoint is off, PCoords will be extracted and the intersection point of the cell.

if a prop is not picked, PCoords will be a vector of std::numeric_limits<double>::quiet_NaN().

◆ GetPickNormal() [1/2]

virtual double * vtkHardwarePicker::GetPickNormal ( )

virtual

Get the normal of the point at the PickPosition.

If a prop is picked:

1) If SnapOnMeshPoint is on, the picked normal will be extracted from the PointData normals, if they exist, otherwise a vector of std::numeric_limits<double>::quiet_NaN() will be returned. 2) If SnapOnMeshPoint is off, the picked normal on the intersected cell will be extracted using ray intersection, if the ray intersections was successful, otherwise a vector of std::numeric_limits<double>::quiet_NaN() will be returned.

if a prop is not picked, the camera plane normal will be returned will be returned.

◆ GetPickNormal() [2/2]

virtual void vtkHardwarePicker::GetPickNormal ( double data[3] )

virtual

Get the normal of the point at the PickPosition.

If a prop is picked:

1) If SnapOnMeshPoint is on, the picked normal will be extracted from the PointData normals, if they exist, otherwise a vector of std::numeric_limits<double>::quiet_NaN() will be returned. 2) If SnapOnMeshPoint is off, the picked normal on the intersected cell will be extracted using ray intersection, if the ray intersections was successful, otherwise a vector of std::numeric_limits<double>::quiet_NaN() will be returned.

if a prop is not picked, the camera plane normal will be returned will be returned.

◆ GetNormalFlipped()

virtual bool vtkHardwarePicker::GetNormalFlipped ( )

virtual

Get if normal is flipped.

The normal will be flipped if point normals don't exist and the angle between the PickedNormal and the camera plane normal is more than pi / 2.

◆ Pick()

int vtkHardwarePicker::Pick	(	double	selectionX,
		double	selectionY,
		double	selectionZ,
		vtkRenderer *	renderer
	)

overridevirtual

Perform the pick operation set the PickedProp.

If something is picked, 1 is returned, and PickPosition, PickNormal, and the rest of the results variables) are extracted from intersection with the PickedProp.

If something is not picked, 0 is returned, and PickPosition and PickNormal are extracted from the camera's focal plane.

Implements vtkAbstractPicker.

◆ Initialize()

void vtkHardwarePicker::Initialize ( )

overrideprotectedvirtual

Reimplemented from vtkAbstractPropPicker.

◆ TypeDecipher()

int vtkHardwarePicker::TypeDecipher	(	vtkProp *	,
		vtkAbstractMapper3D **
	)

protected

◆ FixNormalSign()

void vtkHardwarePicker::FixNormalSign ( )

protected

Fix normal sign in case the orientation of the picked cell is wrong.

When you cast a ray to a 3d object from a specific view angle (camera normal), the angle between the camera normal and the normal of the cell surface that the ray intersected, can have an angle up to pi / 2. This is true because you can't see surface objects with a greater angle than pi / 2, therefore, you can't pick them. In case an angle greater than pi / 2 is computed, we flip the picked normal.

◆ ComputeSurfaceNormal()

int vtkHardwarePicker::ComputeSurfaceNormal	(	vtkDataSet *	data,
		vtkCell *	cell,
		double *	weights
	)

protected

Compute the intersection normal either by interpolating the point normals at the intersected point, or by computing the plane normal for the 2D intersected face/cell.

◆ ComputeIntersectionFromDataSet()

void vtkHardwarePicker::ComputeIntersectionFromDataSet ( vtkDataSet * ds )

protected

Compute the intersection using provided dataset.

Member Data Documentation

◆ SnapToMeshPoint

bool vtkHardwarePicker::SnapToMeshPoint

protected

Definition at line 280 of file vtkHardwarePicker.h.

◆ PixelTolerance

int vtkHardwarePicker::PixelTolerance

protected

Definition at line 281 of file vtkHardwarePicker.h.

◆ PickableProps

vtkNew<vtkPropCollection> vtkHardwarePicker::PickableProps

protected

Definition at line 283 of file vtkHardwarePicker.h.

◆ HardwareSelection

vtkSmartPointer<vtkSelection> vtkHardwarePicker::HardwareSelection

protected

Definition at line 284 of file vtkHardwarePicker.h.

◆ NearRayPoint

double vtkHardwarePicker::NearRayPoint[3]

protected

Definition at line 286 of file vtkHardwarePicker.h.

◆ FarRayPoint

double vtkHardwarePicker::FarRayPoint[3]

protected

Definition at line 287 of file vtkHardwarePicker.h.

◆ Mapper

vtkAbstractMapper3D* vtkHardwarePicker::Mapper

protected

Definition at line 289 of file vtkHardwarePicker.h.

◆ DataSet

vtkDataSet* vtkHardwarePicker::DataSet

protected

Definition at line 290 of file vtkHardwarePicker.h.

◆ DataObject

vtkDataObject* vtkHardwarePicker::DataObject

protected

Definition at line 291 of file vtkHardwarePicker.h.

◆ CompositeDataSet

vtkCompositeDataSet* vtkHardwarePicker::CompositeDataSet

protected

Definition at line 293 of file vtkHardwarePicker.h.

◆ FlatBlockIndex

vtkIdType vtkHardwarePicker::FlatBlockIndex

protected

Definition at line 294 of file vtkHardwarePicker.h.

◆ PointId

vtkIdType vtkHardwarePicker::PointId

protected

Definition at line 296 of file vtkHardwarePicker.h.

◆ CellId

vtkIdType vtkHardwarePicker::CellId

protected

Definition at line 297 of file vtkHardwarePicker.h.

◆ SubId

int vtkHardwarePicker::SubId

protected

Definition at line 298 of file vtkHardwarePicker.h.

◆ CellGridCellTypeId

vtkIdType vtkHardwarePicker::CellGridCellTypeId

protected

Definition at line 299 of file vtkHardwarePicker.h.

◆ CellGridSourceSpecId

vtkIdType vtkHardwarePicker::CellGridSourceSpecId

protected

Definition at line 300 of file vtkHardwarePicker.h.

◆ CellGridTupleId

vtkIdType vtkHardwarePicker::CellGridTupleId

protected

Definition at line 303 of file vtkHardwarePicker.h.

◆ PCoords

double vtkHardwarePicker::PCoords[3]

protected

Definition at line 304 of file vtkHardwarePicker.h.

◆ PickNormal

double vtkHardwarePicker::PickNormal[3]

protected

Definition at line 305 of file vtkHardwarePicker.h.

◆ NormalFlipped

bool vtkHardwarePicker::NormalFlipped

protected

Definition at line 306 of file vtkHardwarePicker.h.

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

Rendering/Core/vtkHardwarePicker.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkHardwarePicker()

◆ ~vtkHardwarePicker()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetSnapToMeshPoint()

◆ GetSnapToMeshPoint()

◆ SnapToMeshPointOn()

◆ SnapToMeshPointOff()

◆ SetPixelTolerance()

◆ GetPixelTolerance()

◆ GetMapper()

◆ GetDataSet()

◆ GetDataObject()

◆ GetCompositeDataSet()

◆ GetFlatBlockIndex()

◆ GetPointId()

◆ GetCellId()

◆ GetSubId()

◆ GetCellGridCellTypeId()

◆ GetCellGridSourceSpecId()

◆ GetCellGridTupleId()

◆ GetPCoords() [1/3]

◆ GetPCoords() [2/3]

◆ GetPCoords() [3/3]

◆ GetPickNormal() [1/2]

◆ GetPickNormal() [2/2]

◆ GetNormalFlipped()

◆ Pick()

◆ Initialize()

◆ TypeDecipher()

◆ FixNormalSign()

◆ ComputeSurfaceNormal()

◆ ComputeIntersectionFromDataSet()

Member Data Documentation

◆ SnapToMeshPoint

◆ PixelTolerance

◆ PickableProps

◆ HardwareSelection

◆ NearRayPoint

◆ FarRayPoint

◆ Mapper

◆ DataSet

◆ DataObject

◆ CompositeDataSet

◆ FlatBlockIndex

◆ PointId

◆ CellId

◆ SubId

◆ CellGridCellTypeId

◆ CellGridSourceSpecId

◆ CellGridTupleId

◆ PCoords

◆ PickNormal

◆ NormalFlipped