pqTimeKeeper is pqProxy for "TimeKeeper" proxy. More...

#include <pqTimeKeeper.h>

Inheritance diagram for pqTimeKeeper:

Collaboration diagram for pqTimeKeeper:

Public Slots
void	addSource (pqPipelineSource *source)
	By default all sources/filters created are added to the time keeper as a source that can contribute timesteps.
void	removeSource (pqPipelineSource *source)
Signals
void	timeStepsChanged ()
	Fired when the keeper updates the times.
void	timeChanged ()
	Fired when the current time changes.
void	timeRangeChanged ()
	Fired when the time range changes.
Public Member Functions
	pqTimeKeeper (const QString &group, const QString &name, vtkSMProxy timekeeper, pqServer server, QObject *parent=0)
virtual	~pqTimeKeeper ()
int	getNumberOfTimeStepValues () const
	Returns the number of timestep values known to this time keeper.
double	getTimeStepValue (int index) const
	Returns the timestep value at the given index.
int	getTimeStepValueIndex (double time) const
	Returns the maximum index in the timestep values for the given time for which timestep value[index] <= time.
QList< double >	getTimeSteps () const
	Returns the available timesteps.
QPair< double, double >	getTimeRange () const
	Returns the time range.
double	getTime () const
	Returns the current time.
void	setTime (double time)
	Update the current time.
void	addTimeSource (pqPipelineSource *)
	Add/remove a source that provides time.
void	removeTimeSource (pqPipelineSource *)
bool	isSourceAdded (pqPipelineSource *)
	Returns true if the source's time values will be considered by the timekeeper in determining time ranges/time steps etc.
Protected Slots
void	sourceAdded (pqPipelineSource *)
	Called when a source is added.
void	sourceRemoved (pqPipelineSource *)
	Called when a source is removed.
void	viewAdded (pqView *)
	Called when a view is added.
void	viewRemoved (pqView *)
	Called when a view is removed.

Detailed Description

pqTimeKeeper is pqProxy for "TimeKeeper" proxy.

A timekeeper is created by default per connection. pqServer keeps a pointer to the connection's time keeper. A time keeper keeps track of the global time and timesteps available currently.

Definition at line 47 of file pqTimeKeeper.h.

Constructor & Destructor Documentation

pqTimeKeeper::pqTimeKeeper	(	const QString &	group,
		const QString &	name,
		vtkSMProxy *	timekeeper,
		pqServer *	server,
		QObject *	parent = `0`
	)

virtual pqTimeKeeper::~pqTimeKeeper ( ) [virtual]

Member Function Documentation

int pqTimeKeeper::getNumberOfTimeStepValues ( ) const

Returns the number of timestep values known to this time keeper.

double pqTimeKeeper::getTimeStepValue ( int index ) const

Returns the timestep value at the given index.

index < getNumberOfTimeStepValues().

int pqTimeKeeper::getTimeStepValueIndex ( double time ) const

Returns the maximum index in the timestep values for the given time for which timestep value[index] <= time.

QList<double> pqTimeKeeper::getTimeSteps ( ) const

Returns the available timesteps.

QPair<double, double> pqTimeKeeper::getTimeRange ( ) const

Returns the time range.

Return (0,0) is getNumberOfTimeStepValues() == 0.

double pqTimeKeeper::getTime ( ) const

Returns the current time.

void pqTimeKeeper::setTime ( double time )

Update the current time.

void pqTimeKeeper::addTimeSource ( pqPipelineSource * )

Add/remove a source that provides time.

Every registered source is added to this list by pqPipelineSource::initialize().

void pqTimeKeeper::removeTimeSource ( pqPipelineSource * )

bool pqTimeKeeper::isSourceAdded ( pqPipelineSource * )

Returns true if the source's time values will be considered by the timekeeper in determining time ranges/time steps etc.

void pqTimeKeeper::timeStepsChanged ( ) [signal]

Fired when the keeper updates the times.

void pqTimeKeeper::timeChanged ( ) [signal]

Fired when the current time changes.

void pqTimeKeeper::timeRangeChanged ( ) [signal]

Fired when the time range changes.

void pqTimeKeeper::addSource ( pqPipelineSource * source ) [inline, slot]

By default all sources/filters created are added to the time keeper as a source that can contribute timesteps.

These timesteps are used in making decisions such as animation end times, timesteps to snap to when playing animation in "Snap to Timesteps" mode etc. This addSource/removeSource API makes it possible to explicitly add/remove sources.

Definition at line 106 of file pqTimeKeeper.h.

void pqTimeKeeper::removeSource ( pqPipelineSource * source ) [inline, slot]

Definition at line 108 of file pqTimeKeeper.h.

void pqTimeKeeper::sourceAdded ( pqPipelineSource * ) [protected, slot]

Called when a source is added.

void pqTimeKeeper::sourceRemoved ( pqPipelineSource * ) [protected, slot]

Called when a source is removed.

void pqTimeKeeper::viewAdded ( pqView * ) [protected, slot]

Called when a view is added.

void pqTimeKeeper::viewRemoved ( pqView * ) [protected, slot]

Called when a view is removed.

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

/home/kitware/Dashboards/My Tests/ParaView/Qt/Core/pqTimeKeeper.h

Public Slots

Signals

Public Member Functions

Protected Slots

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation