Lumiera  0.pre.03
»edit your freedom«
RulerTrack Class Reference

#include "stage/timeline/ruler-track.hpp"

Description

Helper to organise and draw the time or content overview ruler at the top of the timeline track display.

The purpose is to support custom drawing onto the TimelineCanvas to show rendered content, timecode or frame count ticks plus any markers, ranges and locators...

Todo:
this is more or less preliminary/placeholder code as of 4/2019 ////////////////////////TICKET #1194 : proper handling of ruler tracks

Definition at line 66 of file ruler-track.hpp.

Public Member Functions

 RulerTrack (ID id, ctrl::BusTerm &nexus, TrackPresenter &parent)
 
virtual void buildMutator (lib::diff::TreeMutator::Handle) override
 set up a binding to respond to mutation messages via UiBus
 
uint calcHeight ()
 recursively calculate the height in pixels to display this ruler track. More...
 
uint getGapHeight ()
 possibly cause the display of an additional padding gap below this ruler track More...
 
- Public Member Functions inherited from Tangible
virtual ~Tangible ()
 this is an interface
 
void clearErr ()
 invoke the hook to clear error markers More...
 
void clearMsg ()
 invoke the hook to clear notification messages More...
 
ID getID () const
 
void installExpander (Expander::ProbeFun, Expander::ChangeFun)
 Configure the (optional) functionality to expand or collapse the UI-Element. More...
 
void installRevealer (Revealer::RevealeItFun)
 Configure the (optional) functionality to bring the UI-Element into sight. More...
 
template<typename... ARGS>
void invoke (Symbol cmdID, ARGS &&...)
 
void invoke (Symbol cmdID, Rec &&arguments)
 Perform a command or action, once the execution context has been established. More...
 
template<typename... ARGS>
void invoke (Symbol cmdID, ARGS &&... args)
 convenience shortcut to issue a command with several arguments
 
void mark (GenNode const &)
 generic handler for all incoming "state mark" messages
 
void markErr (string error)
 push an error state tag to the element More...
 
void markFlash ()
 highlight the element visually to catch the user's attention More...
 
void markMsg (string message)
 push a notification (or warning) message to the element. More...
 
 operator LuidH () const
 
 operator string () const
 diagnostic representation. More...
 
void reset ()
 invoke the generic reset hook More...
 
void slotCollapse ()
 Collapse or minimise this element and remember the collapsed state. More...
 
void slotExpand ()
 Expand this element and remember the expanded state. More...
 
void slotReveal ()
 Cause the element to be brought into sight. More...
 
- Public Member Functions inherited from DiffMutable
virtual ~DiffMutable ()
 this is an interface
 

Private Types

using Scales = std::vector< RulerScale >
 

Private Attributes

Scales scales_
 
TrackPresentertrack_
 

Additional Inherited Members

- Public Types inherited from Tangible
using ID = ctrl::BusTerm::ID
 
using LuidH = lib::hash::LuidH
 
- Protected Types inherited from Tangible
using GenNode = lib::diff::GenNode
 
using Rec = lib::diff::Rec
 
- Protected Member Functions inherited from Controller
virtual void doMark (GenNode const &mark) override
 default handler for all generic mark messages. More...
 
- Protected Member Functions inherited from Tangible
 Tangible (ID identity, ctrl::BusTerm &nexus)
 
virtual bool doExpand (bool yes)
 generic default implementation of the expand/collapse functionality. More...
 
virtual void doReveal ()
 generic default implementation of the "reveal" functionality. More...
 
- Protected Attributes inherited from Tangible
Expander expand_
 
Revealer reveal_
 
ctrl::BusTerm uiBus_
 

Constructor & Destructor Documentation

◆ RulerTrack()

RulerTrack ( ID  id,
ctrl::BusTerm nexus,
TrackPresenter parent 
)
Parameters
ididentity used to refer to a corresponding session::Fork
nexusa way to connect this Controller to the UI-Bus.
anchorDisplaya one-way closure to attach into the display fabric

Definition at line 66 of file ruler-track.cpp.

Member Function Documentation

◆ calcHeight()

uint calcHeight ( )

recursively calculate the height in pixels to display this ruler track.

Todo:
this is more or less braindead placeholder code as of 4/2019

Definition at line 94 of file ruler-track.cpp.

◆ getGapHeight()

uint getGapHeight ( )

possibly cause the display of an additional padding gap below this ruler track

Returns
0 when no gap shall be displayed, otherwise the gap height in pixels.
Todo:
this is more or less braindead placeholder code as of 4/2019

Definition at line 113 of file ruler-track.cpp.

+ Inheritance diagram for RulerTrack:
+ Collaboration diagram for RulerTrack:

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