pqLiveSourceBehavior Class Reference

pqLiveSourceBehavior adds support for generated "live" sources algorithms. More...

#include <pqLiveSourceBehavior.h>

Inherits QObject.

Public Member Functions
	pqLiveSourceBehavior (QObject *parent=nullptr)
	~pqLiveSourceBehavior () override

Static Public Member Functions
static void	pause ()
	Pause live updates. More...
static void	resume ()
	Resume live updates. More...
static bool	isPaused ()
	Returns true if live updates are paused. More...

Detailed Description

pqLiveSourceBehavior adds support for generated "live" sources algorithms.

These are vtkAlgorithm subclasses that have a method GetNeedsUpdate which returns true (bool) when source may have new data and should be refreshed. This must be not confused with ParaView Catalyst.

To indicate a source is a "live source", one needs to simply add <LiveSource> XML hint for the source proxy.

This tag can have multiple attributes:

• interval: Call GetNeedsUpdate at interval value in milliseconds (default to 100).
• emulated_time: Boolean to mark the live source as an algorithm inheriting from vtkEmulatedTimeAlgorithm, which will play all timesteps available in an emulated real time.

See also

pqLiveSourceManager pqLiveSourceItem vtkEmulatedTimeAlgorithm

Definition at line 38 of file pqLiveSourceBehavior.h.

Constructor & Destructor Documentation

pqLiveSourceBehavior()

pqLiveSourceBehavior::pqLiveSourceBehavior

(

QObject *

parent = nullptr

)

~pqLiveSourceBehavior()

pqLiveSourceBehavior::~pqLiveSourceBehavior ( )

override

Member Function Documentation

pause()

static void pqLiveSourceBehavior::pause ( )

static

Pause live updates.

resume()

static void pqLiveSourceBehavior::resume ( )

static

Resume live updates.

isPaused()

static bool pqLiveSourceBehavior::isPaused ( )

static

Returns true if live updates are paused.

---

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

• /builds/gitlab-kitware-sciviz-ci/Qt/ApplicationComponents/pqLiveSourceBehavior.h