SequenceEditorGUIView Class Reference

#include <sequenceeditorgui.h>

Public Member Functions
	SequenceEditorGUIView (SequenceGUIService &service, SequenceEditor &editor, std::string id, RenderWindow *renderWindow, bool drawFullWindow)
virtual void	show (bool newWindow=true)
void	hideMarkerLabels (bool hide)
SequenceGUIService &	getService ()

Protected Member Functions
void	drawTracks (const SequencePlayer &sequencePlayer, const Sequence &sequence)
void	drawInspectors (const SequencePlayer &sequencePlayer, const Sequence &sequence)
void	drawMarkers (const SequencePlayer &sequencePlayer, const Sequence &sequence)
void	drawMarkerLines (const Sequence &sequence, SequencePlayer &player) const
void	drawPlayerController (SequencePlayer &player)
void	drawTimelinePlayerPosition (const Sequence &sequence, SequencePlayer &player) const
void	drawEndOfSequence (const Sequence &sequence, SequencePlayer &player)
void	handleInsertTrackPopup ()
void	handleLoadPopup ()
void	handleSaveAsPopup ()
void	handleSequenceDurationPopup ()
void	handleEditMarkerPopup ()
void	handleInsertMarkerPopup ()
void	handleHorizontalZoom ()
void	handleHelpPopup ()
void	handleSaveClipboardPopup ()
void	handleUndo ()
void	handleRedo ()
void	handleHistoryPopup ()
void	registerActionHandler (const rttr::type &actionType, const std::function< void()> &action)
void	handleHotKeys ()
void	registerActionHandlers ()

Protected Attributes
SequenceEditor &	mEditor
SequenceEditorGUIState	mState
std::string	mID
bool	mDrawFullWindow = false
bool	mHideMarkerLabels = false
RenderWindow *	mRenderWindow = nullptr
std::unordered_map< rttr::type, std::function< void()> >	mActionHandlers
std::unordered_map< rttr::type, std::unique_ptr< SequenceTrackView > >	mViews
SequenceGUIService &	mService

Description

Responsible for drawing the GUI for the sequence editor Needs reference to editor

Collaboration diagram for SequenceEditorGUIView:

Constructor & Destructor Documentation

SequenceEditorGUIView()

SequenceEditorGUIView	(	SequenceGUIService &	service,
		SequenceEditor &	editor,
		std::string	id,
		RenderWindow *	renderWindow,
		bool	drawFullWindow
	)

Constructor

Parameters

service	sequence gui service handle
editor	reference to editor
id	id of the GUI resource, used to push ID by IMGUI
renderWindow	the render window
drawFullWindow	if the editor occupies the entire window space

Member Function Documentation

drawEndOfSequence()

void drawEndOfSequence ( const Sequence &  sequence, SequencePlayer &  player  )

protected

draws end of sequence

Parameters

sequence	reference to sequence
player	reference to player

drawInspectors()

void drawInspectors ( const SequencePlayer &  sequencePlayer, const Sequence &  sequence  )

protected

Draws inspectors of the sequence tracks

Parameters

sequencePlayer	reference to sequenceplayer
sequence	reference to sequence

drawMarkerLines()

void drawMarkerLines ( const Sequence &  sequence, SequencePlayer &  player  ) const

protected

Draw lines of markers

Parameters

sequence	reference to sequence
player	reference to sequenceplayer

drawMarkers()

void drawMarkers ( const SequencePlayer &  sequencePlayer, const Sequence &  sequence  )

protected

Draws markers

Parameters

sequencePlayer	reference to sequenceplayer
sequence	reference to sequence

drawPlayerController()

void drawPlayerController ( SequencePlayer &  player )

protected

draws player controller bar

Parameters

player

reference to player

drawTimelinePlayerPosition()

void drawTimelinePlayerPosition ( const Sequence &  sequence, SequencePlayer &  player  ) const

protected

draws line of player position

Parameters

sequence	reference to sequence
player	reference to player

drawTracks()

void drawTracks ( const SequencePlayer &  sequencePlayer, const Sequence &  sequence  )

protected

Draws the tracks of the sequence

Parameters

sequencePlayer	reference to sequenceplayer
sequence	reference to sequence

getService()

SequenceGUIService& getService

(

)

handleEditMarkerPopup()

void handleEditMarkerPopup ( )

protected

handle editing of markers

handleHelpPopup()

void handleHelpPopup ( )

protected

when show help popup is pressed, show modal help popup

handleHistoryPopup()

void handleHistoryPopup ( )

protected

history popup

handleHorizontalZoom()

void handleHorizontalZoom ( )

protected

when zooming, zoom around the center of the timeline, keeping the focus in the middle

handleHotKeys()

void handleHotKeys ( )

protected

handleInsertMarkerPopup()

void handleInsertMarkerPopup ( )

protected

handle insertion of new markers

handleInsertTrackPopup()

void handleInsertTrackPopup ( )

protected

Handles insertion of track popup

handleLoadPopup()

void handleLoadPopup ( )

protected

handles load popup

handleRedo()

void handleRedo ( )

protected

handleSaveAsPopup()

void handleSaveAsPopup ( )

protected

handles save as popup

handleSaveClipboardPopup()

void handleSaveClipboardPopup ( )

protected

when save clipboard is pressed, show save clipboard popup

handleSequenceDurationPopup()

void handleSequenceDurationPopup ( )

protected

handle editing of sequence duration

handleUndo()

void handleUndo ( )

protected

undo last action

hideMarkerLabels()

void hideMarkerLabels

(

bool

hide

)

Hides marker labels when not hovered

Parameters

hide	when true, hides marker labels when not hovered

registerActionHandler()

void registerActionHandler ( const rttr::type &  actionType, const std::function< void()> &  action  )

protected

registers handlers for actions

Parameters

actionType	the action type to register a handler function for
action	the handler function

registerActionHandlers()

void registerActionHandlers ( )

protected

show()

virtual void show ( bool  newWindow = true )

virtual

Shows the editor interface

Parameters

newWindow

when true interface will be drawn in a new ImGUI window

Member Data Documentation

mActionHandlers

std::unordered_map<rttr::type, std::function<void()> > mActionHandlers

protected

mDrawFullWindow

bool mDrawFullWindow = false

protected

mEditor

SequenceEditor& mEditor

protected

mHideMarkerLabels

bool mHideMarkerLabels = false

protected

mID

std::string mID

protected

mRenderWindow

RenderWindow* mRenderWindow = nullptr

protected

mService

SequenceGUIService& mService

protected

mState

SequenceEditorGUIState mState

protected

mViews

std::unordered_map<rttr::type, std::unique_ptr<SequenceTrackView> > mViews

protected