pqAnimationTimeWidget Class Reference

pqAnimationTimeWidget is a widget that can be used to show/set the current animation time. More...

#include <pqAnimationTimeWidget.h>

Inherits QWidget.

Public Slots
void	setAnimationScene (vtkSMProxy *animationScene)
	Set the animation scene proxy which is reflected/controlled by this widget. More...
void	repopulateTimeComboBox ()
	Clear the combobox and fill it with current time values. More...

Signals
void	timeValueChanged ()
void	playModeChanged ()
void	dummySignal ()

Public Member Functions
	pqAnimationTimeWidget (QWidget *parent=0)
	~pqAnimationTimeWidget () override
vtkSMProxy *	animationScene () const
	Provides access to the animation scene proxy currently controlled/reflected by this widget. More...
void	setTimeValue (double time)
	Get/set the current time value. More...
double	timeValue () const
void	setTimePrecision (int val)
	Get/set the precision with which time is reported. More...
int	timePrecision () const
void	setTimeNotation (const QChar &val)
	Get/set the precision with which time is reported. More...
QChar	timeNotation () const
void	setTimeStepCount (int count)
	Get/set the number of timesteps. More...
int	timeStepCount () const
void	setPlayMode (const QString &mode)
	Get/set the playmode. More...
QString	playMode () const
void	setPlayModeReadOnly (bool val)
	Get/set whether the user should be able to change the animation play mode using this widget. More...
bool	playModeReadOnly () const
void	setTimeLabel (const QString &val)
	Get/set the label text to use for the "time" parameter. More...
QString	timeLabel () const

Protected Member Functions
QString	formatDouble (double value)
	Format a double with the requested notation and precision. More...

Properties
double	timeValue
int	timeStepCount
QString	playMode
bool	playModeReadOnly
QString	timeLabel

Detailed Description

pqAnimationTimeWidget is a widget that can be used to show/set the current animation time.

The widget allow the user to do the following:

• View and/or change the current time value (in seq/realtime modes), or current time step value (in snap-to-timesteps mode).
• View and/or change the play mode (from seq to snap-to-timesteps). While the widget behaves acceptably if the application externally changes the animation play mode to realtime, the widget itself doesn't allow the user to do that. This mode is optional. You can disabling allowing the user to change the play mode by setting playModeReadOnly to true (default is false).

Definition at line 56 of file pqAnimationTimeWidget.h.

Constructor & Destructor Documentation

pqAnimationTimeWidget()

pqAnimationTimeWidget::pqAnimationTimeWidget

(

QWidget *

parent = 0

)

~pqAnimationTimeWidget()

pqAnimationTimeWidget::~pqAnimationTimeWidget ( )

override

Member Function Documentation

animationScene()

vtkSMProxy* pqAnimationTimeWidget::animationScene

(

)

const

Provides access to the animation scene proxy currently controlled/reflected by this widget.

setTimeValue()

void pqAnimationTimeWidget::setTimeValue

(

double

time

)

Get/set the current time value.

timeValue()

double pqAnimationTimeWidget::timeValue

(

)

const

setTimePrecision()

void pqAnimationTimeWidget::setTimePrecision

(

int

val

)

Get/set the precision with which time is reported.

timePrecision()

int pqAnimationTimeWidget::timePrecision

(

)

const

setTimeNotation()

void pqAnimationTimeWidget::setTimeNotation

(

const QChar &

val

)

Get/set the precision with which time is reported.

timeNotation()

QChar pqAnimationTimeWidget::timeNotation

(

)

const

setTimeStepCount()

void pqAnimationTimeWidget::setTimeStepCount

(

int

count

)

Get/set the number of timesteps.

timeStepCount()

int pqAnimationTimeWidget::timeStepCount

(

)

const

setPlayMode()

void pqAnimationTimeWidget::setPlayMode

(

const QString &

mode

)

Get/set the playmode.

playMode()

QString pqAnimationTimeWidget::playMode

(

)

const

setPlayModeReadOnly()

void pqAnimationTimeWidget::setPlayModeReadOnly

(

bool

val

)

Get/set whether the user should be able to change the animation play mode using this widget.

playModeReadOnly()

bool pqAnimationTimeWidget::playModeReadOnly

(

)

const

setTimeLabel()

void pqAnimationTimeWidget::setTimeLabel

(

const QString &

val

)

Get/set the label text to use for the "time" parameter.

timeLabel()

QString pqAnimationTimeWidget::timeLabel

(

)

const

timeValueChanged

void pqAnimationTimeWidget::timeValueChanged ( )

signal

playModeChanged

void pqAnimationTimeWidget::playModeChanged ( )

signal

dummySignal

void pqAnimationTimeWidget::dummySignal ( )

signal

setAnimationScene

void pqAnimationTimeWidget::setAnimationScene ( vtkSMProxy *  animationScene )

slot

Set the animation scene proxy which is reflected/controlled by this widget.

repopulateTimeComboBox

void pqAnimationTimeWidget::repopulateTimeComboBox ( )

slot

Clear the combobox and fill it with current time values.

formatDouble()

QString pqAnimationTimeWidget::formatDouble ( double  value )

protected

Format a double with the requested notation and precision.

Property Documentation

timeValue

double pqAnimationTimeWidget::timeValue

readwrite

Definition at line 59 of file pqAnimationTimeWidget.h.

timeStepCount

int pqAnimationTimeWidget::timeStepCount

readwrite

Definition at line 60 of file pqAnimationTimeWidget.h.

playMode

QString pqAnimationTimeWidget::playMode

readwrite

Definition at line 61 of file pqAnimationTimeWidget.h.

playModeReadOnly

bool pqAnimationTimeWidget::playModeReadOnly

readwrite

Definition at line 62 of file pqAnimationTimeWidget.h.

timeLabel

QString pqAnimationTimeWidget::timeLabel

readwrite

Definition at line 63 of file pqAnimationTimeWidget.h.

---

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

• /home/kitware/dashboards/buildbot/paraview_release-vall-linux-shared-release_adios2_doc_extdeps_gui_mpi_python3/source/Qt/Components/pqAnimationTimeWidget.h