Picks props behind a selection rectangle on a viewport. More...

#include <vtkAreaPicker.h>

Inheritance diagram for vtkAreaPicker:

Collaboration diagram for vtkAreaPicker:

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. More...

vtkAreaPicker *	NewInstance () const

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

void	SetPickCoords (double x0, double y0, double x1, double y1)
	Set the default screen rectangle to pick in. More...

void	SetRenderer (vtkRenderer *)
	Set the default renderer to pick on. More...

virtual int	Pick ()
	Perform an AreaPick within the default screen rectangle and renderer. More...

virtual int	AreaPick (double x0, double y0, double x1, double y1, vtkRenderer *renderer=nullptr)
	Perform pick operation in volume behind the given screen coordinates. More...

int	Pick (double x0, double y0, double vtkNotUsed(z0), vtkRenderer *renderer=nullptr) override
	Perform pick operation in volume behind the given screen coordinate. More...

vtkProp3DCollection *	GetProp3Ds ()
	Return a collection of all the prop 3D's that were intersected by the pick ray. More...


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


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


virtual vtkPlanes *	GetFrustum ()
	Return the six planes that define the selection frustum. More...


virtual vtkPoints *	GetClipPoints ()
	Return eight points that define the selection frustum. More...

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. More...

vtkAbstractPropPicker *	NewInstance () const

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

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

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

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

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

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

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

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

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

virtual vtkAssemblyPath *	GetPath ()
	Return the vtkAssemblyPath that has been picked. More...

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. More...

vtkAbstractPicker *	NewInstance () const

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

virtual int	Pick (double selectionX, double selectionY, double selectionZ, vtkRenderer *renderer)=0
	Perform pick operation with selection point provided. More...

int	Pick (double selectionPt[3], vtkRenderer *ren)
	provided. More...

virtual int	Pick3DPoint (double[3], vtkRenderer *)
	Perform pick operation with selection point provided. More...

virtual int	Pick3DRay (double[3], double[4], vtkRenderer *)
	Perform pick operation with selection point and orientation provided. More...

void	InitializePickList ()
	Initialize list of actors in pick list. More...

void	AddPickList (vtkProp *)
	Add an actor to the pick list. More...

void	DeletePickList (vtkProp *)
	Delete an actor from the pick list. More...

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

virtual vtkRenderer *	GetRenderer ()
	Get the renderer in which pick event occurred. More...

virtual double *	GetSelectionPoint ()
	Get the selection point in screen (pixel) coordinates. More...

virtual void	GetSelectionPoint (double data[3])
	Get the selection point in screen (pixel) coordinates. More...

virtual double *	GetPickPosition ()
	Return position in global coordinates of pick point. More...

virtual void	GetPickPosition (double data[3])
	Return position in global coordinates of pick point. More...

virtual void	SetPickFromList (vtkTypeBool)
	Use these methods to control whether to limit the picking to this list (rather than renderer's actors). More...

virtual vtkTypeBool	GetPickFromList ()
	Use these methods to control whether to limit the picking to this list (rather than renderer's actors). More...

virtual void	PickFromListOn ()
	Use these methods to control whether to limit the picking to this list (rather than renderer's actors). More...

virtual void	PickFromListOff ()
	Use these methods to control whether to limit the picking to this list (rather than renderer's actors). More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

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

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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. More...

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. More...

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. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

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). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

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

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

Static Public Member Functions
static vtkAreaPicker *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAreaPicker *	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. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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. More...

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). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

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. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAreaPicker ()

	~vtkAreaPicker () override

void	Initialize () override

void	DefineFrustum (double x0, double y0, double x1, double y1, vtkRenderer *)

virtual int	PickProps (vtkRenderer *renderer)

int	TypeDecipher (vtkProp , vtkAbstractMapper3D *)

int	ABoxFrustumIsect (double bounds[], double &mindist)

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. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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 *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkPoints *	ClipPoints

vtkPlanes *	Frustum

vtkProp3DCollection *	Prop3Ds

vtkAbstractMapper3D *	Mapper

vtkDataSet *	DataSet

vtkExtractSelectedFrustum *	FrustumExtractor

double	X0

double	Y0

double	X1

double	Y1

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

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

Picks props behind a selection rectangle on a viewport.

The vtkAreaPicker picks all vtkProp3Ds that lie behind the screen space rectangle from x0,y0 and x1,y1. The selection is based upon the bounding box of the prop and is thus not exact.

Like vtkPicker, a pick results in a list of Prop3Ds because many props may lie within the pick frustum. You can also get an AssemblyPath, which in this case is defined to be the path to the one particular prop in the Prop3D list that lies nearest to the near plane.

This picker also returns the selection frustum, defined as either a vtkPlanes, or a set of eight corner vertices in world space. The vtkPlanes version is an ImplicitFunction, which is suitable for use with the vtkExtractGeometry. The six frustum planes are in order: left, right, bottom, top, near, far

Because this picker picks everything within a volume, the world pick point result is ill-defined. Therefore if you ask this class for the world pick position, you will get the centroid of the pick frustum. This may be outside of all props in the prop list.

See also: vtkInteractorStyleRubberBandPick, vtkExtractSelectedFrustum.

Online Examples:

MoveAGlyph

MoveAVertexUnstructuredGrid

SelectAVertex

AreaPicking

HighlightSelectedPoints

HighlightSelection

Definition at line 128 of file vtkAreaPicker.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAbstractPropPicker vtkAreaPicker::Superclass

Definition at line 132 of file vtkAreaPicker.h.

Constructor & Destructor Documentation

◆ vtkAreaPicker()

vtkAreaPicker::vtkAreaPicker ( )

protected

◆ ~vtkAreaPicker()

vtkAreaPicker::~vtkAreaPicker ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkAreaPicker * vtkAreaPicker::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

Reimplemented in vtkRenderedAreaPicker.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAreaPicker::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractPropPicker.

Reimplemented in vtkRenderedAreaPicker.

◆ NewInstance()

vtkAreaPicker * vtkAreaPicker::NewInstance ( ) const

◆ PrintSelf()

void vtkAreaPicker::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.

Reimplemented in vtkRenderedAreaPicker.

◆ SetPickCoords()

void vtkAreaPicker::SetPickCoords	(	double	x0,
		double	y0,
		double	x1,
		double	y1
	)

Set the default screen rectangle to pick in.

◆ SetRenderer()

void vtkAreaPicker::SetRenderer ( vtkRenderer * )

Set the default renderer to pick on.

◆ Pick() [1/2]

virtual int vtkAreaPicker::Pick ( )

virtual

Perform an AreaPick within the default screen rectangle and renderer.

◆ AreaPick()

virtual int vtkAreaPicker::AreaPick	(	double	x0,
		double	y0,
		double	x1,
		double	y1,
		vtkRenderer *	renderer = `nullptr`
	)

virtual

Perform pick operation in volume behind the given screen coordinates.

Props intersecting the selection frustum will be accessible via GetProp3D. GetPlanes returns a vtkImplicitFunction suitable for vtkExtractGeometry.

Reimplemented in vtkRenderedAreaPicker.

◆ Pick() [2/2]

int vtkAreaPicker::Pick	(	double	x0,
		double	y0,
		double	vtkNotUsedz0,
		vtkRenderer *	renderer = `nullptr`
	)

inlineoverride

Perform pick operation in volume behind the given screen coordinate.

This makes a thin frustum around the selected pixel. Note: this ignores Z in order to pick everying in a volume from z=0 to z=1.

Definition at line 162 of file vtkAreaPicker.h.

◆ GetMapper()

virtual vtkAbstractMapper3D * vtkAreaPicker::GetMapper ( )

virtual

Return mapper that was picked (if any).

◆ GetDataSet()

virtual vtkDataSet * vtkAreaPicker::GetDataSet ( )

virtual

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

If nothing was picked then NULL is returned.

◆ GetProp3Ds()

vtkProp3DCollection * vtkAreaPicker::GetProp3Ds ( )

inline

Return a collection of all the prop 3D's that were intersected by the pick ray.

This collection is not sorted.

Definition at line 186 of file vtkAreaPicker.h.

◆ GetFrustum()

virtual vtkPlanes * vtkAreaPicker::GetFrustum ( )

virtual

Return the six planes that define the selection frustum.

The implicit function defined by the planes evaluates to negative inside and positive outside.

◆ GetClipPoints()

virtual vtkPoints * vtkAreaPicker::GetClipPoints ( )

virtual

Return eight points that define the selection frustum.

◆ Initialize()

void vtkAreaPicker::Initialize ( )

overrideprotectedvirtual

Reimplemented from vtkAbstractPropPicker.

◆ DefineFrustum()

void vtkAreaPicker::DefineFrustum	(	double	x0,
		double	y0,
		double	x1,
		double	y1,
		vtkRenderer *
	)

protected

◆ PickProps()

virtual int vtkAreaPicker::PickProps ( vtkRenderer * renderer )

protectedvirtual

◆ TypeDecipher()

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

protected

◆ ABoxFrustumIsect()

int vtkAreaPicker::ABoxFrustumIsect	(	double	bounds[],
		double &	mindist
	)

protected

Member Data Documentation

◆ ClipPoints

vtkPoints* vtkAreaPicker::ClipPoints

protected

Definition at line 215 of file vtkAreaPicker.h.

◆ Frustum

vtkPlanes* vtkAreaPicker::Frustum

protected

Definition at line 216 of file vtkAreaPicker.h.

◆ Prop3Ds

vtkProp3DCollection* vtkAreaPicker::Prop3Ds

protected

Definition at line 218 of file vtkAreaPicker.h.

◆ Mapper

vtkAbstractMapper3D* vtkAreaPicker::Mapper

protected

Definition at line 219 of file vtkAreaPicker.h.

◆ DataSet

vtkDataSet* vtkAreaPicker::DataSet

protected

Definition at line 220 of file vtkAreaPicker.h.

◆ FrustumExtractor

vtkExtractSelectedFrustum* vtkAreaPicker::FrustumExtractor

protected

Definition at line 223 of file vtkAreaPicker.h.

◆ X0

double vtkAreaPicker::X0

protected

Definition at line 225 of file vtkAreaPicker.h.

◆ Y0

double vtkAreaPicker::Y0

protected

Definition at line 226 of file vtkAreaPicker.h.

◆ X1

double vtkAreaPicker::X1

protected

Definition at line 227 of file vtkAreaPicker.h.

◆ Y1

double vtkAreaPicker::Y1

protected

Definition at line 228 of file vtkAreaPicker.h.

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

Rendering/Core/vtkAreaPicker.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

◆ vtkAreaPicker()

◆ ~vtkAreaPicker()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetPickCoords()

◆ SetRenderer()

◆ Pick() [1/2]

◆ AreaPick()

◆ Pick() [2/2]

◆ GetMapper()

◆ GetDataSet()

◆ GetProp3Ds()

◆ GetFrustum()

◆ GetClipPoints()

◆ Initialize()

◆ DefineFrustum()

◆ PickProps()

◆ TypeDecipher()

◆ ABoxFrustumIsect()

Member Data Documentation

◆ ClipPoints

◆ Frustum

◆ Prop3Ds

◆ Mapper

◆ DataSet

◆ FrustumExtractor

◆ X0

◆ Y0

◆ X1

◆ Y1