Workspace 6.21.5
Public Types | Public Slots | Signals | Public Member Functions | Properties | List of all members
PlaybackControlWidget Class Reference

Widget for controlling playback of a scene.

#include <Rendering/Widgets/playbackcontrolwidget.h>

Inherits QWidget.

Public Types

enum  Control {
  JumpToFirstLast = 0x001 , Loop = 0x002 , Slider = 0x004 , Step = 0x008 ,
  CurrentFrame = 0x010 , FrameRange = 0x020 , FrameRate = 0x040 , Play = 0x080 ,
  FrameRateMultiplyer = 0x100 , AllControls = 0xFFF
}
 

Public Slots

void notifyFrameRendered ()
 
void playToggled (bool checked)
 
void rewind ()
 
void setCurrentFrame (int frameNumber)
 
void setFrameRange (int min, int max)
 
void setFrameRate (double fps)
 
void setFrameRateMultiplier (double multiplier)
 
void setLoopingToggle (bool toggle)
 
void setLoopPauseMilliSecs (int loopPauseMilliSecs)
 
void setMaxFrame (int max)
 
void setMinFrame (int min)
 
void setShowTickMarks (bool enabled)
 
void setStep (int step)
 
void start ()
 
void stop ()
 

Signals

void frameChangeRequested (int frameNumber)
 
void frameRangeChanged (int minFrame, int maxFrame)
 

Public Member Functions

 PlaybackControlWidget (QWidget *parent=nullptr)
 
 ~PlaybackControlWidget () override
 
int getCurrentFrame () const
 
void getFrameRange (int &min, int &max) const
 
bool getFrameRangeEnabled () const
 
double getFrameRate () const
 
bool getLoopingToggle () const
 
int getLoopPauseMilliSecs () const
 
int getMaxFrame () const
 
int getMinFrame () const
 
bool getShowTickMarks () const
 
Controls getVisibleControls () const
 
void setFrameRangeEnabled (bool b)
 
void setVisibleControls (Controls controls)
 

Properties

bool frameRangeEnabled
 
double framesPerSecond
 
bool loopingToggle
 
int loopPauseMilliSecs
 
bool showTickMarks
 
Controls visibleControls
 

Member Enumeration Documentation

◆ Control

enum Control
Enumerator
JumpToFirstLast 
Loop 
Slider 
Step 
CurrentFrame 
FrameRange 
FrameRate 
Play 
FrameRateMultiplyer 
AllControls 

Constructor & Destructor Documentation

◆ PlaybackControlWidget()

PlaybackControlWidget ( QWidget *  parent = nullptr)
explicit

◆ ~PlaybackControlWidget()

~PlaybackControlWidget ( )
override

Member Function Documentation

◆ frameChangeRequested

void frameChangeRequested ( int  frameNumber)
signal

◆ frameRangeChanged

void frameRangeChanged ( int  minFrame,
int  maxFrame 
)
signal

◆ getCurrentFrame()

int getCurrentFrame ( ) const

◆ getFrameRange()

void getFrameRange ( int &  min,
int &  max 
) const
Parameters
minThe desired min frame value
maxThe desired max frame value.

◆ getFrameRangeEnabled()

bool getFrameRangeEnabled ( ) const

◆ getFrameRate()

double getFrameRate ( ) const
Returns
The frame rate as frames per second.

◆ getLoopingToggle()

bool getLoopingToggle ( ) const
Returns
true if looping is toggled on, false if not.

◆ getLoopPauseMilliSecs()

int getLoopPauseMilliSecs ( ) const
Returns
The pause value in milliseconds.

◆ getMaxFrame()

int getMaxFrame ( ) const
Returns
The max frame value.

◆ getMinFrame()

int getMinFrame ( ) const
Returns
The min frame value.

◆ getShowTickMarks()

bool getShowTickMarks ( ) const
Returns
Whether or not tick marks are enabled.

◆ getVisibleControls()

PlaybackControlWidget::Controls getVisibleControls ( ) const

◆ notifyFrameRendered

void notifyFrameRendered ( )
slot

◆ playToggled

void playToggled ( bool  checked)
slot

◆ rewind

void rewind ( )
slot

◆ setCurrentFrame

void setCurrentFrame ( int  frameNumber)
slot

◆ setFrameRange

void setFrameRange ( int  min,
int  max 
)
slot
Parameters
minThe minimum value (lowest frame)
maxThe maximum value (highest frame)

Sets the range of the frames which can be played back.

◆ setFrameRangeEnabled()

void setFrameRangeEnabled ( bool  b)

◆ setFrameRate

void setFrameRate ( double  fps)
slot
Parameters
fpsFrames Per Second

◆ setFrameRateMultiplier

void setFrameRateMultiplier ( double  multiplier)
slot
Parameters
multiplierValue by which the Frames Per Second value is multiplied.

◆ setLoopingToggle

void setLoopingToggle ( bool  toggle)
slot
Parameters
toggleToggles playback looping.

◆ setLoopPauseMilliSecs

void setLoopPauseMilliSecs ( int  loopPauseMilliSecs)
slot
Parameters
loopPauseMilliSecsTime in milliseconds for a pause between a loop event from last to first frame.

◆ setMaxFrame

void setMaxFrame ( int  max)
slot

◆ setMinFrame

void setMinFrame ( int  min)
slot

◆ setShowTickMarks

void setShowTickMarks ( bool  enable)
slot
Parameters
enableWhether or not to show tick marks.

◆ setStep

void setStep ( int  step)
slot
Parameters
stepThe desired step value.

◆ setVisibleControls()

void setVisibleControls ( Controls  controls)

◆ start

void start ( )
slot

◆ stop

void stop ( )
slot

Property Documentation

◆ frameRangeEnabled

bool frameRangeEnabled
readwrite

◆ framesPerSecond

double framesPerSecond
readwrite

◆ loopingToggle

bool loopingToggle
readwrite

◆ loopPauseMilliSecs

int loopPauseMilliSecs
readwrite

◆ showTickMarks

bool showTickMarks
readwrite

◆ visibleControls

Controls visibleControls
readwrite