ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSMTooltipSelectionPipeline Class Reference

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:
Inheritance graph
[legend]
Collaboration diagram for vtkSMTooltipSelectionPipeline:
Collaboration graph
[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)
 
bool CanDisplayTooltip (bool &showTooltip)
 Return true if a tooltip can be displayed according to the context, otherwise return false. More...
 
bool GetTooltipInfo (double tooltipPos[2], std::string &tooltipText)
 Get information about the tooltip to be displayed. More...
 
virtual void Hide (vtkSMRenderViewProxy *view)
 Re-implemented from vtkSMPreselectionPipeline. More...
 
virtual void Show (vtkSMSourceProxy *sourceRepresentation, vtkSMSourceProxy *selection, vtkSMRenderViewProxy *view)
 Re-implemented from vtkSMPreselectionPipeline. More...
 
- Public Member Functions inherited from vtkSMPreselectionPipeline
void PrintSelf (ostream &os, vtkIndent indent)
 
void CopyLabels (vtkSMProxy *representation)
 Copies the labels for interactive selection from the selection labels in the representation parameter. More...
 
virtual vtkSMProxyGetSelectionRepresentation () const
 Get/Create the interactive selection representation. More...
 
virtual vtkSMProxyGetOrCreateSelectionRepresentation ()
 Get/Create the interactive selection representation. More...
 
virtual vtkSMProxyCreateSelectionRepresentation (vtkSMSourceProxy *extract)
 Get/Create the interactive selection representation. More...
 

Static Public Member Functions

static vtkSMTooltipSelectionPipelineNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMTooltipSelectionPipelineSafeDownCast (vtkObject *o)
 
static vtkSMTooltipSelectionPipelineGetInstance ()
 
- Static Public Member Functions inherited from vtkSMPreselectionPipeline
static int IsTypeOf (const char *type)
 
static vtkSMPreselectionPipelineSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSMTooltipSelectionPipeline ()
 
 ~vtkSMTooltipSelectionPipeline ()
 
void ClearCache ()
 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 ()
 
vtkSMSourceProxyConnectPVExtractSelection (vtkSMSourceProxy *source, unsigned int sourceOutputPort, vtkSMSourceProxy *selection)
 

Protected Attributes

vtkSMSourceProxyMoveSelectionToClient
 
vtkIdType PreviousSelectionId
 
bool SelectionFound
 
bool TooltipEnabled
 
- Protected Attributes inherited from vtkSMPreselectionPipeline
vtkSMSourceProxyExtractInteractiveSelection
 
vtkSMProxySelectionRepresentation
 
vtkWeakPointer< vtkSMRenderViewProxyPreviousView
 
vtkWeakPointer< vtkSMSourceProxyPreviousRepresentation
 
vtkCallbackCommand * ColorObserver
 
vtkCallbackCommand * ConnectionObserver
 

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 39 of file vtkSMTooltipSelectionPipeline.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkSMTooltipSelectionPipeline.h.

Constructor & Destructor Documentation

◆ vtkSMTooltipSelectionPipeline()

vtkSMTooltipSelectionPipeline::vtkSMTooltipSelectionPipeline ( )
protected

◆ ~vtkSMTooltipSelectionPipeline()

vtkSMTooltipSelectionPipeline::~vtkSMTooltipSelectionPipeline ( )
protected

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 
)

◆ GetInstance()

static vtkSMTooltipSelectionPipeline* vtkSMTooltipSelectionPipeline::GetInstance ( )
static

◆ Hide()

virtual void vtkSMTooltipSelectionPipeline::Hide ( vtkSMRenderViewProxy view)
virtual

Re-implemented from vtkSMPreselectionPipeline.

Reimplemented from vtkSMPreselectionPipeline.

◆ Show()

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

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

bool vtkSMTooltipSelectionPipeline::GetTooltipInfo ( double  tooltipPos[2],
std::string &  tooltipText 
)

Get information about the tooltip to be displayed.

Return false if the method failed computing information.

◆ ClearCache()

void vtkSMTooltipSelectionPipeline::ClearCache ( )
protectedvirtual

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

◆ MoveSelectionToClient

vtkSMSourceProxy* vtkSMTooltipSelectionPipeline::MoveSelectionToClient
protected

Definition at line 98 of file vtkSMTooltipSelectionPipeline.h.

◆ PreviousSelectionId

vtkIdType vtkSMTooltipSelectionPipeline::PreviousSelectionId
protected

Definition at line 99 of file vtkSMTooltipSelectionPipeline.h.

◆ SelectionFound

bool vtkSMTooltipSelectionPipeline::SelectionFound
protected

Definition at line 100 of file vtkSMTooltipSelectionPipeline.h.

◆ TooltipEnabled

bool vtkSMTooltipSelectionPipeline::TooltipEnabled
protected

Definition at line 101 of file vtkSMTooltipSelectionPipeline.h.


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