Signals | Public Member Functions | List of all members
pqLiveSourceManager Class Reference

pqLiveSourceManager is the manager that handle all live sources in ParaView It is usually instantiated by the pqLiveSourceBehavior. More...

#include <pqLiveSourceManager.h>

Inherits QObject.

Signals

void emulatedTimeStateChanged (bool isPaused)
 Triggered when emulated time shared timer is paused / resumed. More...
 

Public Member Functions

 pqLiveSourceManager (QObject *parent=nullptr)
 
 ~pqLiveSourceManager () override
 
bool isPaused ()
 Returns true if all live source updates is paused. More...
 
pqLiveSourceItemgetLiveSourceItem (vtkSMProxy *)
 Returns the pqLiveSourceItem corresponding to the proxy. More...
 
bool isEmulatedTimePaused ()
 Returns true if the emulated time timer is paused. More...
 
void pause ()
 Pause / Resume live updates for all live sources. More...
 
void resume ()
 Pause / Resume live updates for all live sources. More...
 
void pauseEmulatedTime ()
 Pause / Resume internal emulated time shared timer. More...
 
void resumeEmulatedTime ()
 Pause / Resume internal emulated time shared timer. More...
 
void setEmulatedSpeedMultiplier (double speed)
 Set/get playing speed for emulated time algorithms (in seconds). More...
 
double getEmulatedSpeedMultiplier ()
 Set/get playing speed for emulated time algorithms (in seconds). More...
 
void setEmulatedCurrentTime (double time)
 Set/get current global time for emulated time algorithms. More...
 
double getEmulatedCurrentTime ()
 Set/get current global time for emulated time algorithms. More...
 

Detailed Description

pqLiveSourceManager is the manager that handle all live sources in ParaView It is usually instantiated by the pqLiveSourceBehavior.

It provide feature to control live sources.

See also
pqLiveSourceBehavior pqLiveSourceItem

Definition at line 21 of file pqLiveSourceManager.h.

Constructor & Destructor Documentation

◆ pqLiveSourceManager()

pqLiveSourceManager::pqLiveSourceManager ( QObject *  parent = nullptr)

◆ ~pqLiveSourceManager()

pqLiveSourceManager::~pqLiveSourceManager ( )
override

Member Function Documentation

◆ pause()

void pqLiveSourceManager::pause ( )

Pause / Resume live updates for all live sources.

Also pause / resume emulated time timer.

◆ resume()

void pqLiveSourceManager::resume ( )

Pause / Resume live updates for all live sources.

Also pause / resume emulated time timer.

◆ isPaused()

bool pqLiveSourceManager::isPaused ( )

Returns true if all live source updates is paused.

◆ getLiveSourceItem()

pqLiveSourceItem* pqLiveSourceManager::getLiveSourceItem ( vtkSMProxy )

Returns the pqLiveSourceItem corresponding to the proxy.

◆ pauseEmulatedTime()

void pqLiveSourceManager::pauseEmulatedTime ( )

Pause / Resume internal emulated time shared timer.

◆ resumeEmulatedTime()

void pqLiveSourceManager::resumeEmulatedTime ( )

Pause / Resume internal emulated time shared timer.

◆ isEmulatedTimePaused()

bool pqLiveSourceManager::isEmulatedTimePaused ( )

Returns true if the emulated time timer is paused.

◆ setEmulatedSpeedMultiplier()

void pqLiveSourceManager::setEmulatedSpeedMultiplier ( double  speed)

Set/get playing speed for emulated time algorithms (in seconds).

Default to 1.

◆ getEmulatedSpeedMultiplier()

double pqLiveSourceManager::getEmulatedSpeedMultiplier ( )

Set/get playing speed for emulated time algorithms (in seconds).

Default to 1.

◆ setEmulatedCurrentTime()

void pqLiveSourceManager::setEmulatedCurrentTime ( double  time)

Set/get current global time for emulated time algorithms.

◆ getEmulatedCurrentTime()

double pqLiveSourceManager::getEmulatedCurrentTime ( )

Set/get current global time for emulated time algorithms.

◆ emulatedTimeStateChanged

void pqLiveSourceManager::emulatedTimeStateChanged ( bool  isPaused)
signal

Triggered when emulated time shared timer is paused / resumed.


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