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	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...

void	render ()
	Re render the widget. More...

Signals
void	playModeChanged ()

void	dummySignal ()

Public Member Functions
	pqAnimationTimeWidget (QWidget *parent=nullptr)

	~pqAnimationTimeWidget () override

vtkSMProxy *	animationScene () const
	Provides access to the animation scene proxy currently controlled/reflected by this widget. More...

void	setAnimationScene (pqAnimationScene *animationScene)
	Set the animation scene which is reflected/controlled by this widget. More...

void	setCurrentTime (double t)
	Set the current animation time. 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	setStartTime (double start)
	Get/Set the animation start time. More...

double	startTime () const
	Get/Set the animation start time. More...


void	setEndTime (double end)
	Get/Set the animation end time. More...

double	endTime () const
	Get/Set the animation end time. More...


void	setNumberOfFrames (int nbOfFrame)
	Get/Set the number of frames. More...

int	numberOfFrames () const
	Get/Set the number of frames. More...


void	setPlayMode (const QString &mode)
	Get/set the animation playback mode. More...

QString	playMode () const
	Get/set the animation playback mode. 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...

Protected Slots
void	updateCurrentTime (double t)
	Update the current time in the widget GUI. More...

Properties
QString	playMode

int	numberOfFrames

double	startTime

double	endTime

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 modes), or current time step value (in snap-to-timesteps mode).

Definition at line 28 of file pqAnimationTimeWidget.h.

Member Typedef Documentation

◆ RealNumberNotation

using pqAnimationTimeWidget::RealNumberNotation = pqDoubleLineEdit::RealNumberNotation

Definition at line 44 of file pqAnimationTimeWidget.h.

Constructor & Destructor Documentation

◆ pqAnimationTimeWidget()

pqAnimationTimeWidget::pqAnimationTimeWidget ( QWidget * parent = nullptr )

◆ ~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.

◆ setAnimationScene()

void pqAnimationTimeWidget::setAnimationScene ( pqAnimationScene * animationScene )

Set the animation scene which is reflected/controlled 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.

◆ setStartTime()

void pqAnimationTimeWidget::setStartTime ( double start )

Get/Set the animation start time.

◆ startTime()

double pqAnimationTimeWidget::startTime ( ) const

Get/Set the animation start time.

◆ setEndTime()

void pqAnimationTimeWidget::setEndTime ( double end )

Get/Set the animation end time.

◆ endTime()

double pqAnimationTimeWidget::endTime ( ) const

Get/Set the animation end time.

◆ setNumberOfFrames()

void pqAnimationTimeWidget::setNumberOfFrames ( int nbOfFrame )

Get/Set the number of frames.

◆ numberOfFrames()

int pqAnimationTimeWidget::numberOfFrames ( ) const

Get/Set the number of frames.

◆ setCurrentTime()

void pqAnimationTimeWidget::setCurrentTime ( double t )

Set the current animation time.

◆ 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.

◆ 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.

◆ playModeChanged

void pqAnimationTimeWidget::playModeChanged ( )

signal

◆ dummySignal

void pqAnimationTimeWidget::dummySignal ( )

signal

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

◆ render

void pqAnimationTimeWidget::render ( )

slot

Re render the widget.

This can be helpful when notation/precision settings have changed.

◆ updateCurrentTime

void pqAnimationTimeWidget::updateCurrentTime ( double t )

protectedslot

Update the current time in the widget GUI.

Property Documentation

◆ playMode

QString pqAnimationTimeWidget::playMode

readwrite

Definition at line 32 of file pqAnimationTimeWidget.h.

◆ numberOfFrames

int pqAnimationTimeWidget::numberOfFrames

readwrite

Definition at line 33 of file pqAnimationTimeWidget.h.

◆ startTime

double pqAnimationTimeWidget::startTime

readwrite

Definition at line 34 of file pqAnimationTimeWidget.h.

◆ endTime

double pqAnimationTimeWidget::endTime

readwrite

Definition at line 35 of file pqAnimationTimeWidget.h.

◆ timeLabel

QString pqAnimationTimeWidget::timeLabel

readwrite

Definition at line 36 of file pqAnimationTimeWidget.h.

◆ timestepValues

QList<QVariant> pqAnimationTimeWidget::timestepValues

readwrite

Definition at line 37 of file pqAnimationTimeWidget.h.

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

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

Public Types

Public Slots

Signals

Public Member Functions

Protected Slots

Properties

Detailed Description

Member Typedef Documentation

◆ RealNumberNotation

Constructor & Destructor Documentation

◆ pqAnimationTimeWidget()

◆ ~pqAnimationTimeWidget()

Member Function Documentation

◆ animationScene()

◆ setAnimationScene()

◆ setTimestepValues()

◆ timestepValues()

◆ setStartTime()

◆ startTime()

◆ setEndTime()

◆ endTime()

◆ setNumberOfFrames()

◆ numberOfFrames()

◆ setCurrentTime()

◆ notation()

◆ precision()

◆ setPlayMode()

◆ playMode()

◆ setTimeLabel()

◆ timeLabel()

◆ playModeChanged

◆ dummySignal

◆ setNotation

◆ setPrecision

◆ render

◆ updateCurrentTime

Property Documentation

◆ playMode

◆ numberOfFrames

◆ startTime

◆ endTime

◆ timeLabel

◆ timestepValues