Point tooltip mode enables the user to inspect points (coordinates, data array values) by hovering the mouse cursor over a point. More...

#include <vtkSMTooltipSelectionPipeline.h>

Inheritance diagram for vtkSMTooltipSelectionPipeline:

[legend]

Collaboration diagram for vtkSMTooltipSelectionPipeline:

[legend]

Public Types
typedef vtkSMPreselectionPipeline	Superclass

Public Types inherited from vtkSMPreselectionPipeline
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

bool	CanDisplayTooltip (bool &showTooltip)
	Return true if a tooltip can be displayed according to the context, otherwise return false. More...


void	Hide (vtkSMRenderViewProxy *view) override
	Re-implemented from vtkSMPreselectionPipeline. More...

void	Show (vtkSMSourceProxy sourceRepresentation, vtkSMSourceProxy selection, vtkSMRenderViewProxy *view) override
	Re-implemented from vtkSMPreselectionPipeline. More...


bool	GetTooltipInfo (int association, std::string &tooltipText)
	Get information about the tooltip to be displayed in a HTML formated string. More...

bool	GetTooltipInfo (int association, std::string &tooltipText, std::string &plainTooltipText)
	Get information about the tooltip to be displayed in a HTML formated string. More...

Public Member Functions inherited from vtkSMPreselectionPipeline
void	CopyLabels (vtkSMProxy *representation)
	Copies the labels for interactive selection from the selection labels in the representation parameter. More...

virtual vtkSMProxy *	GetSelectionRepresentation () const
	Get/Create the interactive selection representation. More...

virtual vtkSMProxy *	GetOrCreateSelectionRepresentation ()
	Get/Create the interactive selection representation. More...

virtual vtkSMProxy *	CreateSelectionRepresentation (vtkSMSourceProxy extract, vtkSMRenderViewProxy view)
	Get/Create the interactive selection representation. More...

virtual vtkSMProxy *	CreateSelectionRepresentation (vtkSMSourceProxy *extract)
	Get/Create the interactive selection representation. More...

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 vtkSMTooltipSelectionPipeline *	New ()

static int	IsTypeOf (const char *type)

static vtkSMTooltipSelectionPipeline *	SafeDownCast (vtkObject *o)

static vtkSMTooltipSelectionPipeline *	GetInstance ()

Static Public Member Functions inherited from vtkSMPreselectionPipeline
static int	IsTypeOf (const char *type)

static vtkSMPreselectionPipeline *	SafeDownCast (vtkObject *o)

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
	vtkSMTooltipSelectionPipeline ()

	~vtkSMTooltipSelectionPipeline () override

void	ClearCache () override
	Re-implemented from vtkSMPreselectionPipeline. More...

vtkDataObject *	ConnectPVMoveSelectionToClient (vtkSMSourceProxy *source, unsigned int sourceOutputPort)
	Connect the ClientServerMoveData filter to the pipeline to get the selection on the client side. More...

bool	GetCurrentSelectionId (vtkSMRenderViewProxy *view, vtkIdType &selId)
	Get the id of the selected point. More...

vtkDataSet *	FindDataSet (vtkDataObject *dataObject, bool &compositeFound, std::string &compositeName)
	Extract dataset from the dataObject, which can be either directly a dataset or a composite dataset containing only one dataset. More...

Protected Member Functions inherited from vtkSMPreselectionPipeline
	vtkSMPreselectionPipeline ()

	~vtkSMPreselectionPipeline () override

vtkSMSourceProxy *	ConnectPVExtractSelection (vtkSMSourceProxy source, unsigned int sourceOutputPort, vtkSMSourceProxy selection)

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
vtkSmartPointer< vtkSMProxy >	DataMover

vtkIdType	PreviousSelectionId

bool	SelectionFound

bool	TooltipEnabled

Protected Attributes inherited from vtkSMPreselectionPipeline
vtkSMSourceProxy *	ExtractInteractiveSelection

vtkSMProxy *	SelectionRepresentation

vtkWeakPointer< vtkSMRenderViewProxy >	PreviousView

vtkWeakPointer< vtkSMSourceProxy >	PreviousRepresentation

vtkCallbackCommand *	ColorObserver

vtkCallbackCommand *	ConnectionObserver

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkSMPreselectionPipeline
static void	OnColorModified (vtkObject source, unsigned long eid, void clientdata, void *calldata)

static void	ClearCache (vtkObject source, unsigned long eid, void clientdata, void *calldata)

Detailed Description

Point tooltip mode enables the user to inspect points (coordinates, data array values) by hovering the mouse cursor over a point.

This is a global object that holds the pipeline for showing the point tooltip mode.

See also: vtkSMPreselectionPipeline vtkSMInteractiveSelectionPipeline

Definition at line 28 of file vtkSMTooltipSelectionPipeline.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMPreselectionPipeline vtkSMTooltipSelectionPipeline::Superclass

Definition at line 32 of file vtkSMTooltipSelectionPipeline.h.

Constructor & Destructor Documentation

◆ vtkSMTooltipSelectionPipeline()

vtkSMTooltipSelectionPipeline::vtkSMTooltipSelectionPipeline ( )

protected

◆ ~vtkSMTooltipSelectionPipeline()

vtkSMTooltipSelectionPipeline::~vtkSMTooltipSelectionPipeline ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMTooltipSelectionPipeline* vtkSMTooltipSelectionPipeline::New ( )

static

◆ GetClassName()

virtual const char* vtkSMTooltipSelectionPipeline::GetClassName ( )

virtual

Reimplemented from vtkSMPreselectionPipeline.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMPreselectionPipeline.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMPreselectionPipeline.

◆ GetInstance()

static vtkSMTooltipSelectionPipeline* vtkSMTooltipSelectionPipeline::GetInstance ( )

static

◆ Hide()

void vtkSMTooltipSelectionPipeline::Hide ( vtkSMRenderViewProxy * view )

overridevirtual

Re-implemented from vtkSMPreselectionPipeline.

Reimplemented from vtkSMPreselectionPipeline.

◆ Show()

void vtkSMTooltipSelectionPipeline::Show	(	vtkSMSourceProxy *	sourceRepresentation,
		vtkSMSourceProxy *	selection,
		vtkSMRenderViewProxy *	view
	)

overridevirtual

Re-implemented from vtkSMPreselectionPipeline.

Reimplemented from vtkSMPreselectionPipeline.

◆ CanDisplayTooltip()

bool vtkSMTooltipSelectionPipeline::CanDisplayTooltip ( bool & showTooltip )

Return true if a tooltip can be displayed according to the context, otherwise return false.

The argument showTooltip is true if the tooltip must be shown, false if the tooltip must be hidden.

◆ GetTooltipInfo() [1/2]

bool vtkSMTooltipSelectionPipeline::GetTooltipInfo	(	int	association,
		std::string &	tooltipText
	)

Get information about the tooltip to be displayed in a HTML formated string.

tooltipText received a HTML formatted string, while plainTooltipText receive a plain text version. Return false if the method failed computing information.

◆ GetTooltipInfo() [2/2]

bool vtkSMTooltipSelectionPipeline::GetTooltipInfo	(	int	association,
		std::string &	tooltipText,
		std::string &	plainTooltipText
	)

Get information about the tooltip to be displayed in a HTML formated string.

tooltipText received a HTML formatted string, while plainTooltipText receive a plain text version. Return false if the method failed computing information.

◆ ClearCache()

void vtkSMTooltipSelectionPipeline::ClearCache ( )

overrideprotectedvirtual

Re-implemented from vtkSMPreselectionPipeline.

Reimplemented from vtkSMPreselectionPipeline.

◆ ConnectPVMoveSelectionToClient()

vtkDataObject* vtkSMTooltipSelectionPipeline::ConnectPVMoveSelectionToClient	(	vtkSMSourceProxy *	source,
		unsigned int	sourceOutputPort
	)

protected

Connect the ClientServerMoveData filter to the pipeline to get the selection on the client side.

◆ GetCurrentSelectionId()

bool vtkSMTooltipSelectionPipeline::GetCurrentSelectionId	(	vtkSMRenderViewProxy *	view,
		vtkIdType &	selId
	)

protected

Get the id of the selected point.

◆ FindDataSet()

vtkDataSet* vtkSMTooltipSelectionPipeline::FindDataSet	(	vtkDataObject *	dataObject,
		bool &	compositeFound,
		std::string &	compositeName
	)

protected

Extract dataset from the dataObject, which can be either directly a dataset or a composite dataset containing only one dataset.

Member Data Documentation

◆ DataMover

vtkSmartPointer<vtkSMProxy> vtkSMTooltipSelectionPipeline::DataMover

protected

Definition at line 90 of file vtkSMTooltipSelectionPipeline.h.

◆ PreviousSelectionId

vtkIdType vtkSMTooltipSelectionPipeline::PreviousSelectionId

protected

Definition at line 91 of file vtkSMTooltipSelectionPipeline.h.

◆ SelectionFound

bool vtkSMTooltipSelectionPipeline::SelectionFound

protected

Definition at line 92 of file vtkSMTooltipSelectionPipeline.h.

◆ TooltipEnabled

bool vtkSMTooltipSelectionPipeline::TooltipEnabled

protected

Definition at line 93 of file vtkSMTooltipSelectionPipeline.h.

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

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

◆ vtkSMTooltipSelectionPipeline()

◆ ~vtkSMTooltipSelectionPipeline()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GetInstance()

◆ Hide()

◆ Show()

◆ CanDisplayTooltip()

◆ GetTooltipInfo() [1/2]

◆ GetTooltipInfo() [2/2]

◆ ClearCache()

◆ ConnectPVMoveSelectionToClient()

◆ GetCurrentSelectionId()

◆ FindDataSet()

Member Data Documentation

◆ DataMover

◆ PreviousSelectionId

◆ SelectionFound

◆ TooltipEnabled