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 Types
using	RealNumberNotation = pqDoubleLineEdit::RealNumberNotation

Public Slots
void	setAnimationScene (vtkSMProxy *animationScene)
	Set the animation scene proxy which is reflected/controlled by this widget. More...
void	setNotation (RealNumberNotation _notation)
	Set the notation used to display the number. More...
void	setPrecision (int precision)
	Set the precision used to display the number. 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...
RealNumberNotation	notation () const
	Return the notation used to display the number. More...
int	precision () const
	Return the precision used to display the number. More...
void	setTimestepValues (const QList< QVariant > &list)
	Get/Set the list of timestep. More...
const QList< QVariant > &	timestepValues () const
	Get/Set the list of timestep. More...
void	setTimeValue (double time)
	Get/set the current time value. More...
double	timeValue () const
	Get/set the current time value. More...
void	setPlayMode (const QString &mode)
	Get/set the animation playback mode. More...
QString	playMode () const
	Get/set the animation playback mode. More...
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
	Get/set whether the user should be able to change the animation play mode using this widget. More...
void	setTimeLabel (const QString &val)
	Get/set the label text to use for the "time" parameter. More...
QString	timeLabel () const
	Get/set the label text to use for the "time" parameter. More...
void	setTimePrecision (int)
int	timePrecision () const
void	setTimeNotation (const QChar &val)
QChar	timeNotation () const
void	setTimeStepCount (int count)
int	timeStepCount () const

Properties
double	timeValue
QString	playMode
bool	playModeReadOnly
QString	timeLabel
QList< QVariant >	timestepValues

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 60 of file pqAnimationTimeWidget.h.

Member Typedef Documentation

RealNumberNotation

using pqAnimationTimeWidget::RealNumberNotation = pqDoubleLineEdit::RealNumberNotation

Definition at line 76 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.

setTimestepValues()

void pqAnimationTimeWidget::setTimestepValues

(

const QList< QVariant > &

list

)

Get/Set the list of timestep.

QList<QVariant> is a list of variants convertible to double.

timestepValues()

const QList<QVariant>& pqAnimationTimeWidget::timestepValues

(

)

const

Get/Set the list of timestep.

QList<QVariant> is a list of variants convertible to double.

setTimeValue()

void pqAnimationTimeWidget::setTimeValue

(

double

time

)

Get/set the current time value.

timeValue()

double pqAnimationTimeWidget::timeValue

(

)

const

Get/set the current time value.

notation()

RealNumberNotation pqAnimationTimeWidget::notation

(

)

const

Return the notation used to display the number.

See also

setNotation()

precision()

int pqAnimationTimeWidget::precision

(

)

const

Return the precision used to display the number.

See also

setPrecision()

setPlayMode()

void pqAnimationTimeWidget::setPlayMode

(

const QString &

mode

)

Get/set the animation playback mode.

playMode()

QString pqAnimationTimeWidget::playMode

(

)

const

Get/set the animation playback mode.

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

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

setTimeLabel()

void pqAnimationTimeWidget::setTimeLabel

(

const QString &

val

)

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

timeLabel()

QString pqAnimationTimeWidget::timeLabel

(

)

const

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

setTimePrecision()

void pqAnimationTimeWidget::setTimePrecision

(

int

)

Deprecated:

ParaView 5.9.

Use setPrecision and setNotation instead.

timePrecision()

int pqAnimationTimeWidget::timePrecision

(

)

const

Deprecated:

ParaView 5.9.

Use setPrecision and setNotation instead.

setTimeNotation()

void pqAnimationTimeWidget::setTimeNotation

(

const QChar &

val

)

Deprecated:

ParaView 5.9.

Use setPrecision and setNotation instead.

timeNotation()

QChar pqAnimationTimeWidget::timeNotation

(

)

const

Deprecated:

ParaView 5.9.

Use setPrecision and setNotation instead.

setTimeStepCount()

void pqAnimationTimeWidget::setTimeStepCount

(

int

count

)

Deprecated:

ParaVIew 5.9.

No longer used. Use setTimestepValues instead to provide the timesteps explicitly.

timeStepCount()

int pqAnimationTimeWidget::timeStepCount

(

)

const

Deprecated:

ParaVIew 5.9.

No longer used. Use setTimestepValues instead to provide the timesteps explicitly.

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.

setNotation

void pqAnimationTimeWidget::setNotation ( RealNumberNotation  _notation )

slot

Set the notation used to display the number.

See also

notation()

setPrecision

void pqAnimationTimeWidget::setPrecision ( int  precision )

slot

Set the precision used to display the number.

See also

precision()

Property Documentation

timeValue

double pqAnimationTimeWidget::timeValue

readwrite

Definition at line 64 of file pqAnimationTimeWidget.h.

playMode

QString pqAnimationTimeWidget::playMode

readwrite

Definition at line 65 of file pqAnimationTimeWidget.h.

playModeReadOnly

bool pqAnimationTimeWidget::playModeReadOnly

readwrite

Definition at line 66 of file pqAnimationTimeWidget.h.

timeLabel

QString pqAnimationTimeWidget::timeLabel

readwrite

Definition at line 67 of file pqAnimationTimeWidget.h.

timestepValues

QList<QVariant> pqAnimationTimeWidget::timestepValues

readwrite

Definition at line 68 of file pqAnimationTimeWidget.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/Qt/Components/pqAnimationTimeWidget.h