Public Types | Public Slots | Signals | Public Member Functions | Protected Slots | Properties | List of all members
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 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 playModeChanged ()
 
void dummySignal ()
 

Public Member Functions

 pqAnimationTimeWidget (QWidget *parent=nullptr)
 
 ~pqAnimationTimeWidget () override
 
vtkSMProxyanimationScene () 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 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...
 

Protected Slots

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

Properties

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:

Definition at line 60 of file pqAnimationTimeWidget.h.

Member Typedef Documentation

◆ RealNumberNotation

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

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

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

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

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

◆ playModeReadOnly

bool pqAnimationTimeWidget::playModeReadOnly
readwrite

Definition at line 65 of file pqAnimationTimeWidget.h.

◆ timeLabel

QString pqAnimationTimeWidget::timeLabel
readwrite

Definition at line 66 of file pqAnimationTimeWidget.h.

◆ timestepValues

QList<QVariant> pqAnimationTimeWidget::timestepValues
readwrite

Definition at line 67 of file pqAnimationTimeWidget.h.


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