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

#include <TimelinePanel.h>

Inheritance diagram for Frapper::TimelinePanel:

Collaboration diagram for Frapper::TimelinePanel:

[legend]

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.

Public Member Functions inherited from Frapper::ViewPanel
	ViewPanel (Type viewPanelType, QWidget *parent=0, Qt::WindowFlags flags=0)
	Constructor of the ViewPanel class.

Type	getViewPanelType ()
	Returns the type of the view panel.

Public Member Functions inherited from Frapper::Panel
	Panel (QWidget *parent=0, Qt::WindowFlags flags=0)
	Constructor of the Panel class.

virtual	~Panel ()
	Destructor of the Panel class.

QMap< QString, QString >	getPanelParameters ()
	Gets the panel parameters. For load and save functionality.

virtual void	setPanelParameters (const QMap< QString, QString > &parameterMap)
	Sets the panel parameters. For load and save functionality.

virtual void	registerControl (NodeModel nodeModel, SceneModel sceneModel)
	Connects the panel with the scene.

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.

Additional Inherited Members
Public Types inherited from Frapper::ViewPanel
enum	Type { T_Documentation, T_Viewport, T_NetworkEditor, T_HierarchyEditor, T_ParameterEditor, T_CurveEditor, T_Timeline, T_PluginPanel, T_PainterPanel, T_NumTypes }
	Nested enumeration for the different types of view panels. More...

Static Public Member Functions inherited from Frapper::Panel
static QString	getTypeName (Type panelType)
	Returns the name of the given panel type.

static QString	getTypeIconName (Type panelType)
	Returns the icon name for the given panel type.

Protected Attributes inherited from Frapper::Panel
QMap< QString, QString >	m_parameterMap
	Map with default values. For load and save functionality.

Detailed Description

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

Constructor & Destructor Documentation

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

Frapper::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 Frapper::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 Frapper::Panel.

void Frapper::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 Frapper::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 Frapper::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 Frapper::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 Frapper::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 Frapper::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 Frapper::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 Frapper::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 Frapper::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 Frapper::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 Frapper::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 Frapper::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 Frapper::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 Frapper::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 Frapper::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 Frapper::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 Frapper::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 Frapper::TimelinePanel::keyPressEvent ( QKeyEvent * event )

protectedvirtual

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 Frapper::TimelinePanel::on_ui_realtimeAction_triggered ( bool realtime )

privateslot

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 Frapper::TimelinePanel::on_ui_scaleToFitAction_triggered ( bool checked = false )

privateslot

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

Parameters

checked The state of the action.

void Frapper::TimelinePanel::on_ui_startFrameSpinBox_valueChanged ( int value )

privateslot

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

Parameters