vtkHardwareSelector subclass with paraview specific logic to avoid recapturing buffers unless needed. More...

#include <vtkPVHardwareSelector.h>

Inheritance diagram for vtkPVHardwareSelector:

Collaboration diagram for vtkPVHardwareSelector:

[legend]

Public Types
typedef vtkOpenGLHardwareSelector	Superclass

Public Types inherited from vtkOpenGLHardwareSelector
typedef vtkHardwareSelector	Superclass

typedef vtkHardwareSelector	Superclass

Public Types inherited from vtkHardwareSelector
enum	PassTypes

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	SetView (vtkPVRenderView *view)
	Set the view that will be used to exchange messages between all processes involved. More...

virtual vtkSelection *	Select (int region[4])
	Perform the selection over the specified region. More...

vtkSelection *	PolygonSelect (int *polygonPoints, vtkIdType count)
	Same as Select() above, except this one use a polygon, instead of a rectangle region, and select elements inside the polygon. More...

virtual bool	NeedToRenderForSelection ()
	Returns true when the next call to Select() will result in renders to capture the selection-buffers. More...

void	InvalidateCachedSelection ()
	Called to invalidate the cache. More...

int	AssignUniqueId (vtkProp *)

void	BeginRenderProp (vtkRenderWindow *) override
	Set the local ProcessId. More...

Public Member Functions inherited from vtkOpenGLHardwareSelector
vtkOpenGLHardwareSelector *	NewInstance () const

virtual void	EndRenderProp ()

vtkOpenGLHardwareSelector *	NewInstance () const

virtual void	RenderCompositeIndex (unsigned int index)

virtual void	RenderAttributeId (vtkIdType attribid)

virtual void	RenderProcessId (unsigned int processid)

virtual void	BeginRenderProp ()

virtual void	BeginRenderProp ()

virtual void	EndRenderProp ()

virtual void	BeginRenderProp ()

virtual void	BeginRenderProp ()

virtual void	EndRenderProp ()

Public Member Functions inherited from vtkHardwareSelector
vtkHardwareSelector *	NewInstance () const

vtkSelection *	Select ()

int	Render (vtkRenderer renderer, vtkProp *propArray, int propArrayCount)

vtkProp *	GetPropFromID (int id)

virtual void	SetRenderer (vtkRenderer *)

virtual vtkRenderer *	GetRenderer ()

virtual void	SetArea (unsigned int, unsigned int, unsigned int, unsigned int)

virtual void	SetArea (unsigned int[4])

virtual unsigned int *	GetArea ()

virtual void	GetArea (unsigned int &, unsigned int &, unsigned int &, unsigned int &)

virtual void	GetArea (unsigned int[4])

virtual void	SetFieldAssociation (int)

virtual int	GetFieldAssociation ()

virtual void	SetUseProcessIdFromData (bool)

virtual bool	GetUseProcessIdFromData ()

virtual bool	CaptureBuffers ()

PixelInformation	GetPixelInformation (const unsigned int display_position[2])

PixelInformation	GetPixelInformation (const unsigned int display_position[2], int maxDist)

PixelInformation	GetPixelInformation (const unsigned int display_position[2], int maxDist, unsigned int selected_position[2])

void	ClearBuffers ()

virtual void	SetProcessID (int)

virtual int	GetProcessID ()

virtual float *	GetPropColorValue ()

virtual void	GetPropColorValue (float &, float &, float &)

virtual void	GetPropColorValue (float[3])

virtual void	SetPropColorValue (float, float, float)

virtual void	SetPropColorValue (float[3])

virtual int	GetCurrentPass ()

virtual vtkSelection *	GenerateSelection ()

virtual vtkSelection *	GenerateSelection (unsigned int r[4])

virtual vtkSelection *	GenerateSelection (unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2)

virtual vtkSelection *	GeneratePolygonSelection (int *polygonPoints, vtkIdType count)

virtual void	SetRenderer (vtkRenderer *)

virtual vtkRenderer *	GetRenderer ()

virtual void	SetArea (unsigned int, unsigned int, unsigned int, unsigned int)

virtual void	SetArea (unsigned int[4])

virtual unsigned int *	GetArea ()

virtual void	GetArea (unsigned int &, unsigned int &, unsigned int &, unsigned int &)

virtual void	GetArea (unsigned int[4])

virtual void	SetFieldAssociation (int)

virtual int	GetFieldAssociation ()

virtual void	SetUseProcessIdFromData (bool)

virtual bool	GetUseProcessIdFromData ()

virtual bool	CaptureBuffers ()

PixelInformation	GetPixelInformation (const unsigned int display_position[2])

PixelInformation	GetPixelInformation (const unsigned int display_position[2], int maxDist)

PixelInformation	GetPixelInformation (const unsigned int display_position[2], int maxDist, unsigned int selected_position[2])

void	ClearBuffers ()

virtual void	SetProcessID (int)

virtual int	GetProcessID ()

virtual float *	GetPropColorValue ()

virtual void	GetPropColorValue (float &, float &, float &)

virtual void	GetPropColorValue (float[3])

virtual void	SetPropColorValue (float, float, float)

virtual void	SetPropColorValue (float[3])

virtual int	GetCurrentPass ()

virtual vtkSelection *	GenerateSelection ()

virtual vtkSelection *	GenerateSelection (unsigned int r[4])

virtual vtkSelection *	GenerateSelection (unsigned int x1, unsigned int y1, unsigned int x2, unsigned int y2)

virtual vtkSelection *	GeneratePolygonSelection (int *polygonPoints, vtkIdType count)

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

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

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkPVHardwareSelector *	New ()

static int	IsTypeOf (const char *type)

static vtkPVHardwareSelector *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkOpenGLHardwareSelector
static vtkOpenGLHardwareSelector *	New ()

static int	IsTypeOf (const char *type)

static vtkOpenGLHardwareSelector *	SafeDownCast (vtkObjectBase *o)

static vtkOpenGLHardwareSelector *	New ()

static int	IsTypeOf (const char *type)

static vtkOpenGLHardwareSelector *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkHardwareSelector
static vtkHardwareSelector *	New ()

static int	IsTypeOf (const char *type)

static vtkHardwareSelector *	SafeDownCast (vtkObjectBase *o)

static void	Convert (int id, float tcoord[3])

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkPVHardwareSelector ()

	~vtkPVHardwareSelector () override

int	GetPropID (int idx, vtkProp *prop) override
	Return a unique ID for the prop. More...

bool	PassRequired (int pass) override
	Returns is the pass indicated is needed. More...

bool	PrepareSelect ()
	Prepare for selection. More...

void	SavePixelBuffer (int passNo) override

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

	vtkOpenGLHardwareSelector ()

virtual	~vtkOpenGLHardwareSelector ()

virtual void	EndRenderProp (vtkRenderWindow *)

virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOpenGLHardwareSelector ()

virtual	~vtkOpenGLHardwareSelector ()

virtual void	EndRenderProp (vtkRenderWindow *)

Protected Member Functions inherited from vtkHardwareSelector
	vtkHardwareSelector ()

	~vtkHardwareSelector ()

int	Convert (unsigned long offset, unsigned char *pb)

vtkIdType	GetID (int low24, int mid24, int high16)

bool	IsPropHit (int propid)

virtual void	BeginSelection ()

virtual void	EndSelection ()

void	BuildPropHitList (unsigned char *rgbData)

int	Convert (unsigned int pos[2], unsigned char *pb)

int	Convert (int xx, int yy, unsigned char *pb)

virtual int	GetPropID (int idx, vtkProp *vtkNotUsed(prop))

int	Convert (unsigned int pos[2], unsigned char *pb)

int	Convert (int xx, int yy, unsigned char *pb)

virtual int	GetPropID (int idx, vtkProp *vtkNotUsed(prop))

void	ReleasePixBuffers ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkTimeStamp	CaptureTime

int	UniqueId

Protected Attributes inherited from vtkOpenGLHardwareSelector
vtkInternals *	Internals

Protected Attributes inherited from vtkHardwareSelector
unsigned char *	PixBuffer [10]

int	ProcessID

int	CurrentPass

int	InPropRender

int	PropID

float	PropColorValue [3]

vtkRenderer *	Renderer

unsigned int	Area [4]

int	FieldAssociation

bool	UseProcessIdFromData

vtkIdType	MaxAttributeId

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkHardwareSelector
	PROCESS_PASS

	ACTOR_PASS

	COMPOSITE_INDEX_PASS

	ID_LOW24

	ID_MID24

	ID_HIGH16

	MAX_KNOWN_PASS

	MIN_KNOWN_PASS

Detailed Description

vtkHardwareSelector subclass with paraview specific logic to avoid recapturing buffers unless needed.

vtkHardwareSelector is subclass of vtkHardwareSelector that adds logic to reuse the captured buffers as much as possible. Thus avoiding repeated selection-rendering of repeated selections or picking. This class does not know, however, when the cached buffers are invalid. External logic must explicitly calls InvalidateCachedSelection() to ensure that the cache is not reused.

Definition at line 24 of file vtkPVHardwareSelector.h.

Member Typedef Documentation

◆ Superclass

typedef vtkOpenGLHardwareSelector vtkPVHardwareSelector::Superclass

Definition at line 28 of file vtkPVHardwareSelector.h.

Constructor & Destructor Documentation

◆ vtkPVHardwareSelector()

vtkPVHardwareSelector::vtkPVHardwareSelector ( )

protected

◆ ~vtkPVHardwareSelector()

vtkPVHardwareSelector::~vtkPVHardwareSelector ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPVHardwareSelector* vtkPVHardwareSelector::New ( )

static

◆ GetClassName()

virtual const char* vtkPVHardwareSelector::GetClassName ( )

virtual

◆ IsTypeOf()

static int vtkPVHardwareSelector::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkPVHardwareSelector::IsA ( const char * type )

virtual

Reimplemented from vtkOpenGLHardwareSelector.

◆ SafeDownCast()

static vtkPVHardwareSelector* vtkPVHardwareSelector::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

void vtkPVHardwareSelector::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Reimplemented from vtkOpenGLHardwareSelector.

◆ SetView()

void vtkPVHardwareSelector::SetView ( vtkPVRenderView * view )

Set the view that will be used to exchange messages between all processes involved.

Note this does not affect the reference count of the view.

◆ Select()

virtual vtkSelection* vtkPVHardwareSelector::Select ( int region[4] )

virtual

Perform the selection over the specified region.

Avoid clearing of captured buffers.

◆ PolygonSelect()

vtkSelection* vtkPVHardwareSelector::PolygonSelect	(	int *	polygonPoints,
		vtkIdType	count
	)

Same as Select() above, except this one use a polygon, instead of a rectangle region, and select elements inside the polygon.

◆ NeedToRenderForSelection()

virtual bool vtkPVHardwareSelector::NeedToRenderForSelection ( )

virtual

Returns true when the next call to Select() will result in renders to capture the selection-buffers.

◆ InvalidateCachedSelection()

void vtkPVHardwareSelector::InvalidateCachedSelection ( )

inline

Called to invalidate the cache.

Definition at line 58 of file vtkPVHardwareSelector.h.

◆ AssignUniqueId()

int vtkPVHardwareSelector::AssignUniqueId ( vtkProp * )

◆ BeginRenderProp()

void vtkPVHardwareSelector::BeginRenderProp ( vtkRenderWindow * )

overridevirtual

Set the local ProcessId.

Reimplemented from vtkOpenGLHardwareSelector.

◆ GetPropID()

int vtkPVHardwareSelector::GetPropID	(	int	idx,
		vtkProp *	prop
	)

overrideprotected

Return a unique ID for the prop.

◆ PassRequired()

bool vtkPVHardwareSelector::PassRequired ( int pass )

overrideprotectedvirtual

Returns is the pass indicated is needed.

Overridden to report that we always need the process-id pass. In future, we can be smart about it by only requiring it for sessions with more than 1 data-server.

Reimplemented from vtkHardwareSelector.

◆ PrepareSelect()

bool vtkPVHardwareSelector::PrepareSelect ( )

protected

Prepare for selection.

Return false if CaptureBuffers() is false

◆ SavePixelBuffer()

void vtkPVHardwareSelector::SavePixelBuffer ( int passNo )

overrideprotectedvirtual

Reimplemented from vtkOpenGLHardwareSelector.

Member Data Documentation

◆ CaptureTime

vtkTimeStamp vtkPVHardwareSelector::CaptureTime

protected

Definition at line 94 of file vtkPVHardwareSelector.h.

◆ UniqueId

int vtkPVHardwareSelector::UniqueId

protected

Definition at line 95 of file vtkPVHardwareSelector.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkPVHardwareSelector.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

◆ vtkPVHardwareSelector()

◆ ~vtkPVHardwareSelector()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetView()

◆ Select()

◆ PolygonSelect()

◆ NeedToRenderForSelection()

◆ InvalidateCachedSelection()

◆ AssignUniqueId()

◆ BeginRenderProp()

◆ GetPropID()

◆ PassRequired()

◆ PrepareSelect()

◆ SavePixelBuffer()

Member Data Documentation

◆ CaptureTime

◆ UniqueId