Public Member Functions | Static Public Member Functions | List of all members
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:

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

Member Function Documentation

◆ pause()

static void pqLiveSourceBehavior::pause ( )

Pause live updates.

◆ resume()

static void pqLiveSourceBehavior::resume ( )

Resume live updates.

◆ isPaused()

static bool pqLiveSourceBehavior::isPaused ( )

Returns true if live updates are paused.

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