Lumiera  0.pre.03
»edityourfreedom«
proc::cmd Namespace Reference

Namespaces

 test
 

Typedefs

using DummySess = session::DummySessionConnection
 

Functions

 COMMAND_DEFINITION (session_saveSnapshot)
 store a snapshot of current session actions and state and UI state. More...
 
 COMMAND_DEFINITION (sequence_newTrack)
 add a new track within the fork, anchored at the given context. More...
 
 COMMAND_DEFINITION (session_newSequence)
 add a new sequence, anchored at the given context. More...
 
 COMMAND_DEFINITION (test_meta_activateContentDiff)
 instruct the session to start keeping the UI up-to-date through diff messages. More...
 
 COMMAND_DEFINITION (meta_deactivateContentDiff)
 instruct the session to start keeping the UI up-to-date through diff messages. More...
 
 COMMAND_DEFINITION (test_fake_injectSequence_1)
 Populate the Timeline in the UI with a typical simple Dummy sequence. More...
 
 COMMAND_DEFINITION (test_meta_displayInfo)
 DemoGuiRoundtrip: push a notification info message back up into the UI. More...
 
 COMMAND_DEFINITION (test_meta_markError)
 DemoGuiRoundtrip: send a markError message back up into the UI. More...
 
 COMMAND_DEFINITION (test_fake_injectSequence_2)
 Populate the Timeline in the UI with a rather complex Dummy sequence. More...
 
 COMMAND_DEFINITION (test_meta_markNote)
 DemoGuiRoundtrip: send a markNote message back up into the UI. More...
 
 COMMAND_DEFINITION (test_fake_blubb)
 Template for dummy-code.... More...
 
 COMMAND_DEFINITION (test_meta_markAction)
 DemoGuiRoundtrip: send a generic mark message with given action ID back up into the UI. More...
 

Variables

CommandSetup meta_deactivateContentDiff
 
CommandSetup sequence_newTrack
 
CommandSetup session_newSequence
 
CommandSetup session_saveSnapshot
 
CommandSetup test_fake_injectSequence_1
 
CommandSetup test_fake_injectSequence_2
 
CommandSetup test_meta_activateContentDiff
 
CommandSetup test_meta_displayInfo
 
CommandSetup test_meta_markAction
 
CommandSetup test_meta_markError
 
CommandSetup test_meta_markNote
 

Typedef Documentation

◆ DummySess

Function Documentation

◆ COMMAND_DEFINITION() [1/12]

proc::cmd::COMMAND_DEFINITION ( test_meta_activateContentDiff  )

instruct the session to start keeping the UI up-to-date through diff messages.

Remarks
we assume the UI is empty when issuing this command. Thus the session will commence by sending a population diff, to reflect all the UI relevant structures currently present within the session data. Moreover, from that point on, any changes within the session structure and contents will be reflected by pushing appropriate diff messages upwards through the GuiNotification façade.
Note
to UNDO this action means to waive the live-update state. In addition, the session will push up a status change to mark the session-root as defunct.
Todo:
used for preliminary integration testing ///////////////////////////////////////////TICKET #211 prefix test_ bypasses logging and immediately executes for now (2018)

Definition at line 89 of file meta-cmd.cpp.

References GuiNotification::facade, and gui::NOTE_INFO.

◆ COMMAND_DEFINITION() [2/12]

proc::cmd::COMMAND_DEFINITION ( meta_deactivateContentDiff  )

instruct the session to start keeping the UI up-to-date through diff messages.

Remarks
we assume the UI is empty when issuing this command. Thus the session will commence by sending a population diff, to reflect all the UI relevant structures currently present within the session data. Moreover, from that point on, any changes within the session structure and contents will be reflected by pushing appropriate diff messages upwards through the GuiNotification façade.
Note
to UNDO this action means to waive the live-update state. In addition, the session will push up a status change to mark the session-root as defunct.

Definition at line 122 of file meta-cmd.cpp.

◆ COMMAND_DEFINITION() [3/12]

proc::cmd::COMMAND_DEFINITION ( test_meta_displayInfo  )

DemoGuiRoundtrip: push a notification info message back up into the UI.

Todo:
this is a demo mock setup to further development of the Proc-UI integration //////////////////TICKET #1140 : prototypical Proc-GUI communication

Definition at line 151 of file meta-cmd.cpp.

References GuiNotification::facade, and gui::NOTE_WARN.

◆ COMMAND_DEFINITION() [4/12]

proc::cmd::COMMAND_DEFINITION ( test_meta_markError  )

DemoGuiRoundtrip: send a markError message back up into the UI.

Todo:
this is a demo mock setup to further development of the Proc-UI integration //////////////////TICKET #1140 : prototypical Proc-GUI communication

Definition at line 171 of file meta-cmd.cpp.

References GuiNotification::facade, Wizard::getErrorLogID(), and gui::NOTE_WARN.

+ Here is the call graph for this function:

◆ COMMAND_DEFINITION() [5/12]

proc::cmd::COMMAND_DEFINITION ( test_meta_markNote  )

DemoGuiRoundtrip: send a markNote message back up into the UI.

Todo:
this is a demo mock setup to further development of the Proc-UI integration //////////////////TICKET #1140 : prototypical Proc-GUI communication

Definition at line 192 of file meta-cmd.cpp.

References GuiNotification::facade, Wizard::getErrorLogID(), and gui::NOTE_WARN.

+ Here is the call graph for this function:

◆ COMMAND_DEFINITION() [6/12]

proc::cmd::COMMAND_DEFINITION ( test_meta_markAction  )

DemoGuiRoundtrip: send a generic mark message with given action ID back up into the UI.

Todo:
this is a demo mock setup to further development of the Proc-UI integration //////////////////TICKET #1140 : prototypical Proc-GUI communication

Definition at line 213 of file meta-cmd.cpp.

References GuiNotification::facade, Wizard::getErrorLogID(), util::isYes(), gui::MARK_expand, and gui::NOTE_WARN.

+ Here is the call graph for this function:

◆ COMMAND_DEFINITION() [7/12]

proc::cmd::COMMAND_DEFINITION ( sequence_newTrack  )

add a new track within the fork, anchored at the given context.

Parameters
contextan object to use as anchor to relate the new track container to
newIDidentity of the new track to create

Definition at line 69 of file sequence-cmd.cpp.

◆ COMMAND_DEFINITION() [8/12]

proc::cmd::COMMAND_DEFINITION ( session_saveSnapshot  )

store a snapshot of current session actions and state and UI state.

Parameters
snapshotIDa marker to tag the snapshot

Definition at line 67 of file session-cmd.cpp.

References Session::current, and SessManager::save().

+ Here is the call graph for this function:

◆ COMMAND_DEFINITION() [9/12]

proc::cmd::COMMAND_DEFINITION ( session_newSequence  )

add a new sequence, anchored at the given context.

Parameters
contextan object to use as anchor to relate the new sequence to
newIDidentity of the new sequence to create

Definition at line 88 of file session-cmd.cpp.

◆ COMMAND_DEFINITION() [10/12]

proc::cmd::COMMAND_DEFINITION ( test_fake_injectSequence_1  )

Populate the Timeline in the UI with a typical simple Dummy sequence.

This Proc-Layer command script fabricates a faked "population diff", which not corresponds to any existing session data structure, but looks as if emanated while loading current session state.

  • one single Timeline
  • just the root track
  • two clips placed on that track
    Todo:
    use this to establish basic Timeline display in the UI //////////////////TICKET #1014 : produce Dummy content to populate timeline

Definition at line 151 of file dummy-session-connection.cpp.

References Root::getID(), gui::NOTE_INFO, and gui::NOTE_WARN.

+ Here is the call graph for this function:

◆ COMMAND_DEFINITION() [11/12]

proc::cmd::COMMAND_DEFINITION ( test_fake_injectSequence_2  )

Populate the Timeline in the UI with a rather complex Dummy sequence.

This command script fabricates a faked convoluted "population diff"...

Todo:
use this to enact a complex layout structure in the Timeline-UI //////////////////TICKET #1014 : produce Dummy content to populate timeline

Definition at line 177 of file dummy-session-connection.cpp.

References gui::NOTE_INFO, and gui::NOTE_WARN.

◆ COMMAND_DEFINITION() [12/12]

proc::cmd::COMMAND_DEFINITION ( test_fake_blubb  )

Template for dummy-code....

Todo:
use this to enact a complex layout structure in the Timeline-UI //////////////////TICKET #1042 : further the DummySessionConnection

Definition at line 198 of file dummy-session-connection.cpp.

References gui::NOTE_INFO, and gui::NOTE_WARN.

Variable Documentation

◆ session_saveSnapshot

CommandSetup session_saveSnapshot

◆ session_newSequence

CommandSetup session_newSequence

◆ sequence_newTrack

CommandSetup sequence_newTrack

◆ test_meta_activateContentDiff

CommandSetup test_meta_activateContentDiff

◆ meta_deactivateContentDiff

CommandSetup meta_deactivateContentDiff

◆ test_meta_displayInfo

CommandSetup test_meta_displayInfo

◆ test_meta_markError

CommandSetup test_meta_markError

◆ test_meta_markNote

CommandSetup test_meta_markNote

◆ test_meta_markAction

CommandSetup test_meta_markAction

◆ test_fake_injectSequence_1

CommandSetup test_fake_injectSequence_1

◆ test_fake_injectSequence_2

CommandSetup test_fake_injectSequence_2