TimelinePanel Class Reference

Class for a panel that contains a timeline widget for accessing the scene model's time. More...

#include <TimelinePanel.h>

Inheritance diagram for TimelinePanel:

Collaboration diagram for TimelinePanel:

[legend]

List of all members.

Public Slots

void toggleRealtimeMode (bool realtime)

Enables and disables certain widgets when realtime mode is toggled.

void setFrameStep (int frameStep)

Sets the frame step displayed in the frame step spin box to the given value.

void setFrameRate (int frameRate)

Sets the frame rate displayed in the FPS spin box to the given value.

void setCurrentFrame (int index)

Sets the index of the current frame in the scene's time.

void setStartFrame (int index)

Sets the index of the start frame in the scene's time.

void setEndFrame (int index)

Sets the index of the end frame in the scene's time.

void setInFrame (int index)

Sets the index of the in frame in the scene's time.

void setOutFrame (int index)

Sets the index of the out frame in the scene's time.

Signals

void currentFrameSet (int index)

Signal that is emitted when the index of the current frame in the scene's time has been changed.

void startFrameSet (int index)

Signal that is emitted when the index of the start frame in the scene's time has been changed.

void endFrameSet (int index)

Signal that is emitted when the index of the end frame in the scene's time has been changed.

void inFrameSet (int index)

Signal that is emitted when the index of the in frame in the scene's time has been changed.

void outFrameSet (int index)

Signal that is emitted when the index of the out frame in the scene's time has been changed.

void frameStepSet (int frameStep)

Signal that is emitted when the frame step for the scene has been changed.

void frameRateSet (int frameRate)

Signal that is emitted when the frame rate for the scene has been changed.

Public Member Functions

TimelinePanel (QWidget *parent=0, Qt::WindowFlags flags=0)

Constructor of the TimelinePanel class.

virtual ~TimelinePanel ()

Destructor of the TimelinePanel class.

void fillToolBars (QToolBar *mainToolBar, QToolBar *panelToolBar)

Fills the given tool bars in a panel frame with actions for the panel.

void fillControlToolBar (QList< QAction * > controlActions)

Fills the panel's control tool bar with the given actions.

void setFrameRange (int firstFrame, int lastFrame)

Sets the frame range available for the scene time to the given frame indices.

Protected Member Functions

virtual void keyPressEvent (QKeyEvent *event)

Handles key press events for the widget.

Private Slots

void on_ui_realtimeAction_triggered (bool realtime)

Sets the real-time mode on or off.

void on_ui_scaleToFitAction_triggered (bool checked=false)

Event handler that is called when the Scale to Fit action has been triggered.

void on_ui_startFrameSpinBox_valueChanged (int value)

Event handler that is called when the value of the start frame spin box has been changed.

void on_ui_endFrameSpinBox_valueChanged (int value)

Event handler that is called when the value of the end frame spin box has been changed.

void on_ui_inFrameSpinBox_valueChanged (int value)

Event handler that is called when the value of the in frame spin box has been changed.

void on_ui_frameStepSpinBox_valueChanged (int value)

Event handler that is called when the value of the frame step spin box has been changed.

void on_ui_outFrameSpinBox_valueChanged (int value)

Event handler that is called when the value of the out frame spin box has been changed.

void on_ui_fpsSpinBox_valueChanged (int value)

Event handler that is called when the value of the frame rate spin box has been changed.

Private Attributes

QScrollBar * m_scaleScrollBar

The scroll bar widget for adjusting the scale of the timeline widget's frames.

TimelineWidget * m_timelineWidget

The widget for accessing the scene model's time.

QToolBar * m_controlToolBar

The tool bar that will receive actions for controlling the scene's time.

Detailed Description

Class for a panel that contains a timeline widget for accessing the scene model's time.

Constructor & Destructor Documentation

TimelinePanel::TimelinePanel	(	QWidget *	parent = `0`,
		Qt::WindowFlags	flags = `0`
	)

Constructor of the TimelinePanel class.

Constructors and Destructors.

Parameters:

	parent	The parent widget the created instance will be a child of.
	flags	Extra widget options.

Constructor of the TimelinePanel class.

Parameters:

	parent	The parent widget the created instance will be a child of.
	flags	Extra widget options.

TimelinePanel::~TimelinePanel ( ) [virtual]

Destructor of the TimelinePanel class.

Defined virtual to guarantee that the destructor of a derived class will be called if the instance of the derived class is saved in a variable of its parent class type.

Member Function Documentation

void TimelinePanel::fillToolBars	(	QToolBar *	mainToolBar,
		QToolBar *	panelToolBar
	)			`[virtual]`

Fills the given tool bars in a panel frame with actions for the panel.

Public Functions.

Parameters:

	mainToolBar	The main tool bar to fill with actions.
	panelToolBar	The panel tool bar to fill with actions.

Fills the given tool bars in a panel frame with actions for the panel.

Parameters:

	mainToolBar	The main tool bar to fill with actions.
	panelToolBar	The panel tool bar to fill with actions.

Reimplemented from Panel.

void TimelinePanel::fillControlToolBar ( QList< QAction * > controlActions )

Fills the panel's control tool bar with the given actions.

Fills the panel's control and options tool bars with the given actions.

Parameters:

	controlActions	The actions to add to the control tool bar.
	controlActions	The actions to add to the control tool bar.
	optionsActions	The actions to add to the options tool bar.

void TimelinePanel::setFrameRange	(	int	firstFrame,
		int	lastFrame
	)

Sets the frame range available for the scene time to the given frame indices.

Parameters:

	firstFrame	The index of the first frame in the scene's time range.
	lastFrame	The index of the last frame in the scene's time range.

void TimelinePanel::toggleRealtimeMode ( bool realtime ) [slot]

Enables and disables certain widgets when realtime mode is toggled.

Public Slots.

Parameters:

realtime

Indicates whether realtime mode is on or off.

Enables and disables certain widgets when realtime mode is toggled.

Parameters:

realtime

Indicates whether realtime mode is on or off.

void TimelinePanel::setFrameStep ( int frameStep ) [slot]

Sets the frame step displayed in the frame step spin box to the given value.

Parameters:

frameStep

The frame step currently used in the scene.

void TimelinePanel::setFrameRate ( int frameRate ) [slot]

Sets the frame rate displayed in the FPS spin box to the given value.

Parameters:

frameRate

The frame rate currently used in the scene.

void TimelinePanel::setCurrentFrame ( int index ) [slot]

Sets the index of the current frame in the scene's time.

Parameters:

index

The new index of the current frame in the scene's time.

void TimelinePanel::setStartFrame ( int index ) [slot]

Sets the index of the start frame in the scene's time.

Parameters:

index

The new index of the start frame in the scene's time.

void TimelinePanel::setEndFrame ( int index ) [slot]

Sets the index of the end frame in the scene's time.

Parameters:

index

The new index of the end frame in the scene's time.

void TimelinePanel::setInFrame ( int index ) [slot]

Sets the index of the in frame in the scene's time.

Parameters:

index

The new index of the in frame in the scene's time.

void TimelinePanel::setOutFrame ( int index ) [slot]

Sets the index of the out frame in the scene's time.

Parameters:

index

The new index of the out frame in the scene's time.

void TimelinePanel::currentFrameSet ( int index ) [signal]

Signal that is emitted when the index of the current frame in the scene's time has been changed.

Parameters:

index

The new index of the current frame in the scene's time.

void TimelinePanel::startFrameSet ( int index ) [signal]

Signal that is emitted when the index of the start frame in the scene's time has been changed.

Parameters:

index

The new index of the start frame in the scene's time.

void TimelinePanel::endFrameSet ( int index ) [signal]

Signal that is emitted when the index of the end frame in the scene's time has been changed.

Parameters:

index

The new index of the end frame in the scene's time.

void TimelinePanel::inFrameSet ( int index ) [signal]

Signal that is emitted when the index of the in frame in the scene's time has been changed.

Parameters:

index

The new index of the in frame in the scene's time.

void TimelinePanel::outFrameSet ( int index ) [signal]

Signal that is emitted when the index of the out frame in the scene's time has been changed.

Parameters:

index

The new index of the out frame in the scene's time.

void TimelinePanel::frameStepSet ( int frameStep ) [signal]

Signal that is emitted when the frame step for the scene has been changed.

Parameters:

frameStep

The new frame step to use for the scene.

void TimelinePanel::frameRateSet ( int frameRate ) [signal]

Signal that is emitted when the frame rate for the scene has been changed.

Parameters:

frameRate

The new frame rate to use for the scene.

void TimelinePanel::keyPressEvent ( QKeyEvent * event ) [protected, virtual]

Handles key press events for the widget.

Protected Events.

Parameters:

event

The description of the key event.

Handles key press events for the widget.

Parameters:

event

The description of the key event.

void TimelinePanel::on_ui_realtimeAction_triggered ( bool realtime ) [private, slot]

Sets the real-time mode on or off.

Private Slots.

Parameters:

realtime

True -> realtime, false -> no-real-time.

Sets the real-time mode on or off.

Parameters:

realtime

True -> realtime, false -> no-real-time.

void TimelinePanel::on_ui_scaleToFitAction_triggered ( bool checked = false ) [private, slot]

Event handler that is called when the Scale to Fit action has been triggered.

Parameters:

checked

The state of the action.

void TimelinePanel::on_ui_startFrameSpinBox_valueChanged ( int value ) [private, slot]

Event handler that is called when the value of the start frame spin box has been changed.

Parameters:

value

The value of the spin box.

void TimelinePanel::on_ui_endFrameSpinBox_valueChanged ( int value ) [private, slot]

Event handler that is called when the value of the end frame spin box has been changed.

Parameters:

value

The value of the spin box.

void TimelinePanel::on_ui_inFrameSpinBox_valueChanged ( int value ) [private, slot]

Event handler that is called when the value of the in frame spin box has been changed.

Parameters:

value

The value of the spin box.

void TimelinePanel::on_ui_frameStepSpinBox_valueChanged ( int value ) [private, slot]

Event handler that is called when the value of the frame step spin box has been changed.

Parameters:

value

The value of the spin box.

void TimelinePanel::on_ui_outFrameSpinBox_valueChanged ( int value ) [private, slot]

Event handler that is called when the value of the out frame spin box has been changed.

Parameters:

value

The value of the spin box.

void TimelinePanel::on_ui_fpsSpinBox_valueChanged ( int value ) [private, slot]

Event handler that is called when the value of the frame rate spin box has been changed.

Parameters:

value

The value of the spin box.

Member Data Documentation

QScrollBar* TimelinePanel::m_scaleScrollBar [private]

The scroll bar widget for adjusting the scale of the timeline widget's frames.

TimelineWidget* TimelinePanel::m_timelineWidget [private]

The widget for accessing the scene model's time.

QToolBar* TimelinePanel::m_controlToolBar [private]

The tool bar that will receive actions for controlling the scene's time.

See also:: getControlToolBar

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


Public Slots
void	toggleRealtimeMode (bool realtime)
	Enables and disables certain widgets when realtime mode is toggled.
void	setFrameStep (int frameStep)
	Sets the frame step displayed in the frame step spin box to the given value.
void	setFrameRate (int frameRate)
	Sets the frame rate displayed in the FPS spin box to the given value.
void	setCurrentFrame (int index)
	Sets the index of the current frame in the scene's time.
void	setStartFrame (int index)
	Sets the index of the start frame in the scene's time.
void	setEndFrame (int index)
	Sets the index of the end frame in the scene's time.
void	setInFrame (int index)
	Sets the index of the in frame in the scene's time.
void	setOutFrame (int index)
	Sets the index of the out frame in the scene's time.
Signals
void	currentFrameSet (int index)
	Signal that is emitted when the index of the current frame in the scene's time has been changed.
void	startFrameSet (int index)
	Signal that is emitted when the index of the start frame in the scene's time has been changed.
void	endFrameSet (int index)
	Signal that is emitted when the index of the end frame in the scene's time has been changed.
void	inFrameSet (int index)
	Signal that is emitted when the index of the in frame in the scene's time has been changed.
void	outFrameSet (int index)
	Signal that is emitted when the index of the out frame in the scene's time has been changed.
void	frameStepSet (int frameStep)
	Signal that is emitted when the frame step for the scene has been changed.
void	frameRateSet (int frameRate)
	Signal that is emitted when the frame rate for the scene has been changed.
Public Member Functions
	TimelinePanel (QWidget *parent=0, Qt::WindowFlags flags=0)
	Constructor of the TimelinePanel class.
virtual	~TimelinePanel ()
	Destructor of the TimelinePanel class.
void	fillToolBars (QToolBar mainToolBar, QToolBar panelToolBar)
	Fills the given tool bars in a panel frame with actions for the panel.
void	fillControlToolBar (QList< QAction * > controlActions)
	Fills the panel's control tool bar with the given actions.
void	setFrameRange (int firstFrame, int lastFrame)
	Sets the frame range available for the scene time to the given frame indices.
Protected Member Functions
virtual void	keyPressEvent (QKeyEvent *event)
	Handles key press events for the widget.
Private Slots
void	on_ui_realtimeAction_triggered (bool realtime)
	Sets the real-time mode on or off.
void	on_ui_scaleToFitAction_triggered (bool checked=false)
	Event handler that is called when the Scale to Fit action has been triggered.
void	on_ui_startFrameSpinBox_valueChanged (int value)
	Event handler that is called when the value of the start frame spin box has been changed.
void	on_ui_endFrameSpinBox_valueChanged (int value)
	Event handler that is called when the value of the end frame spin box has been changed.
void	on_ui_inFrameSpinBox_valueChanged (int value)
	Event handler that is called when the value of the in frame spin box has been changed.
void	on_ui_frameStepSpinBox_valueChanged (int value)
	Event handler that is called when the value of the frame step spin box has been changed.
void	on_ui_outFrameSpinBox_valueChanged (int value)
	Event handler that is called when the value of the out frame spin box has been changed.
void	on_ui_fpsSpinBox_valueChanged (int value)
	Event handler that is called when the value of the frame rate spin box has been changed.
Private Attributes
QScrollBar *	m_scaleScrollBar
	The scroll bar widget for adjusting the scale of the timeline widget's frames.
TimelineWidget *	m_timelineWidget
	The widget for accessing the scene model's time.
QToolBar *	m_controlToolBar
	The tool bar that will receive actions for controlling the scene's time.