Picks an entire viewport at one shot. More...

#include <vtkScenePicker.h>

Inheritance diagram for vtkScenePicker:

Collaboration diagram for vtkScenePicker:

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

vtkScenePicker *	NewInstance () const

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

vtkIdType	GetCellId (int displayPos[2])
	Get cell id at the pick position. More...

vtkIdType	GetVertexId (int displayPos[2])
	Get cell id at the pick position. More...

vtkProp *	GetViewProp (int displayPos[2])
	Get actor at the pick position. More...


virtual void	SetRenderer (vtkRenderer *)
	Set the renderer. More...

virtual vtkRenderer *	GetRenderer ()
	Set the renderer. More...


virtual void	SetEnableVertexPicking (vtkTypeBool)
	Vertex picking (using the method GetVertexId()), required additional resources and can slow down still render time by 5-10%. More...

virtual vtkTypeBool	GetEnableVertexPicking ()
	Vertex picking (using the method GetVertexId()), required additional resources and can slow down still render time by 5-10%. More...

virtual void	EnableVertexPickingOn ()
	Vertex picking (using the method GetVertexId()), required additional resources and can slow down still render time by 5-10%. More...

virtual void	EnableVertexPickingOff ()
	Vertex picking (using the method GetVertexId()), required additional resources and can slow down still render time by 5-10%. 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	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. More...

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

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

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

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. 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...

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

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

Static Public Member Functions
static vtkScenePicker *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkScenePicker *	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 (vtkTypeBool 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 vtkTypeBool	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

	vtkScenePicker ()

	~vtkScenePicker () override

void	PickRender ()

void	PickRender (int x0, int y0, int x1, int y1)

void	Update (int displayPos[2])

void	SetInteractor (vtkRenderWindowInteractor *)

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	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkTypeBool	EnableVertexPicking

vtkHardwareSelector *	Selector

vtkRenderer *	Renderer

vtkRenderWindowInteractor *	Interactor

vtkIdType	VertId

vtkIdType	CellId

vtkProp *	Prop

bool	NeedToUpdate

int	LastQueriedDisplayPos [2]

vtkScenePickerSelectionRenderCommand *	SelectionRenderCommand

vtkTimeStamp	PickRenderTime

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

Friends
class	vtkRenderer

class	vtkScenePickerSelectionRenderCommand

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 an entire viewport at one shot.

The Scene picker, unlike conventional pickers picks an entire viewport at one shot and caches the result, which can be retrieved later. The utility of the class arises during Actor Selection. Let's say you have a couple of polygonal objects in your scene and you wish to have a status bar that indicates the object your mouse is over. Picking repeatedly every time your mouse moves would be very slow. The scene picker automatically picks your viewport every time the camera is changed and caches the information. Additionally, it observes the vtkRenderWindowInteractor to avoid picking during interaction, so that you still maintain your interactivity. In effect, the picker does an additional pick-render of your scene every time you stop interacting with your scene. As an example, see Rendering/TestScenePicker.

Warning

Unlike a vtkHoverWidget, this class is not timer based. The hover widget picks a scene when the mouse is over an actor for a specified duration.
This class uses a vtkHardwareSelector under the hood. Hence, it will work only for actors that have opaque geometry and are rendered by a vtkPolyDataMapper.

See also: vtkHoverWidget vtkHardwareSelector

Definition at line 44 of file vtkScenePicker.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkScenePicker::Superclass

Definition at line 52 of file vtkScenePicker.h.

Constructor & Destructor Documentation

◆ vtkScenePicker()

vtkScenePicker::vtkScenePicker ( )

protected

◆ ~vtkScenePicker()

vtkScenePicker::~vtkScenePicker ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkScenePicker* vtkScenePicker::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkScenePicker::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkScenePicker* vtkScenePicker::NewInstance ( ) const

◆ PrintSelf()

void vtkScenePicker::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 vtkObject.

◆ SetRenderer()

virtual void vtkScenePicker::SetRenderer ( vtkRenderer * )

virtual

Set the renderer.

Scene picks are restricted to the viewport.

◆ GetRenderer()

virtual vtkRenderer* vtkScenePicker::GetRenderer ( )

virtual

Set the renderer.

Scene picks are restricted to the viewport.

◆ GetCellId()

vtkIdType vtkScenePicker::GetCellId ( int displayPos[2] )

Get cell id at the pick position.

Returns -1 if no cell was picked. Makes sense only after Pick has been called.

◆ GetVertexId()

vtkIdType vtkScenePicker::GetVertexId ( int displayPos[2] )

Get cell id at the pick position.

Returns -1 if no cell was picked. Makes sense only after Pick has been called.

◆ GetViewProp()

vtkProp* vtkScenePicker::GetViewProp ( int displayPos[2] )

Get actor at the pick position.

Returns NULL if none. Makes sense only after Pick has been called.

◆ SetEnableVertexPicking()

virtual void vtkScenePicker::SetEnableVertexPicking ( vtkTypeBool )

virtual

Vertex picking (using the method GetVertexId()), required additional resources and can slow down still render time by 5-10%.

Enabled by default.

◆ GetEnableVertexPicking()

virtual vtkTypeBool vtkScenePicker::GetEnableVertexPicking ( )

virtual

Vertex picking (using the method GetVertexId()), required additional resources and can slow down still render time by 5-10%.

Enabled by default.

◆ EnableVertexPickingOn()

virtual void vtkScenePicker::EnableVertexPickingOn ( )

virtual

Vertex picking (using the method GetVertexId()), required additional resources and can slow down still render time by 5-10%.

Enabled by default.

◆ EnableVertexPickingOff()

virtual void vtkScenePicker::EnableVertexPickingOff ( )

virtual

Vertex picking (using the method GetVertexId()), required additional resources and can slow down still render time by 5-10%.

Enabled by default.

◆ PickRender() [1/2]

void vtkScenePicker::PickRender ( )

protected

◆ PickRender() [2/2]

void vtkScenePicker::PickRender	(	int	x0,
		int	y0,
		int	x1,
		int	y1
	)

protected

◆ Update()

void vtkScenePicker::Update ( int displayPos[2] )

protected

◆ SetInteractor()

void vtkScenePicker::SetInteractor ( vtkRenderWindowInteractor * )

protected

Friends And Related Function Documentation

◆ vtkRenderer

friend class vtkRenderer

friend

Definition at line 47 of file vtkScenePicker.h.

◆ vtkScenePickerSelectionRenderCommand

friend class vtkScenePickerSelectionRenderCommand

friend

Definition at line 48 of file vtkScenePicker.h.

Member Data Documentation

◆ EnableVertexPicking

vtkTypeBool vtkScenePicker::EnableVertexPicking

protected

Definition at line 114 of file vtkScenePicker.h.

◆ Selector

vtkHardwareSelector* vtkScenePicker::Selector

protected

Definition at line 115 of file vtkScenePicker.h.

◆ Renderer

vtkRenderer* vtkScenePicker::Renderer

protected

Definition at line 116 of file vtkScenePicker.h.

◆ Interactor

vtkRenderWindowInteractor* vtkScenePicker::Interactor

protected

Definition at line 117 of file vtkScenePicker.h.

◆ VertId

vtkIdType vtkScenePicker::VertId

protected

Definition at line 118 of file vtkScenePicker.h.

◆ CellId

vtkIdType vtkScenePicker::CellId

protected

Definition at line 119 of file vtkScenePicker.h.

◆ Prop

vtkProp* vtkScenePicker::Prop

protected

Definition at line 120 of file vtkScenePicker.h.

◆ NeedToUpdate

bool vtkScenePicker::NeedToUpdate

protected

Definition at line 121 of file vtkScenePicker.h.

◆ LastQueriedDisplayPos

int vtkScenePicker::LastQueriedDisplayPos[2]

protected

Definition at line 122 of file vtkScenePicker.h.

◆ SelectionRenderCommand

vtkScenePickerSelectionRenderCommand* vtkScenePicker::SelectionRenderCommand

protected

Definition at line 123 of file vtkScenePicker.h.

◆ PickRenderTime

vtkTimeStamp vtkScenePicker::PickRenderTime

protected

Definition at line 125 of file vtkScenePicker.h.

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

Rendering/Core/vtkScenePicker.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkScenePicker()

◆ ~vtkScenePicker()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetRenderer()

◆ GetRenderer()

◆ GetCellId()

◆ GetVertexId()

◆ GetViewProp()

◆ SetEnableVertexPicking()

◆ GetEnableVertexPicking()

◆ EnableVertexPickingOn()

◆ EnableVertexPickingOff()

◆ PickRender() [1/2]

◆ PickRender() [2/2]

◆ Update()

◆ SetInteractor()

Friends And Related Function Documentation

◆ vtkRenderer

◆ vtkScenePickerSelectionRenderCommand

Member Data Documentation

◆ EnableVertexPicking

◆ Selector

◆ Renderer

◆ Interactor

◆ VertId

◆ CellId

◆ Prop

◆ NeedToUpdate

◆ LastQueriedDisplayPos

◆ SelectionRenderCommand

◆ PickRenderTime