diff --git a/doc/devel/uml/class141957.html b/doc/devel/uml/class141957.html index 9158a22a5..6ad99d6c7 100644 --- a/doc/devel/uml/class141957.html +++ b/doc/devel/uml/class141957.html @@ -16,5 +16,6 @@ -

Declaration :

Component(s) : Dispatcher

+

Declaration :

Component(s) : Dispatcher

Stereotype: control

+ diff --git a/doc/devel/uml/class148485.html b/doc/devel/uml/class148485.html new file mode 100644 index 000000000..ea2fc33b3 --- /dev/null +++ b/doc/devel/uml/class148485.html @@ -0,0 +1,40 @@ + + + + + + +Class Command + + + + + +
Class Command
+

+ + + + +

Key abstraction for all proc/edit operations and UNDO management

Declaration :

Stereotype: interface

+
+ +
Attribut ID
+

Declaration :

+
Attribut name
+

Declaration :

+
Attribut do
+

Declaration :

+
Attribut undo
+

Declaration :

+
Attribut closure
+

Declaration :

+
Operation execute

Declaration :

+
Relation <unidirectional association>

Declaration :

Stereotype: has_a

+ +
Relation <unidirectional association>

Declaration :

Stereotype: has_a

+ +
Relation <unidirectional association>

Declaration :

+

All public operations : execute

+ + diff --git a/doc/devel/uml/class148613.html b/doc/devel/uml/class148613.html new file mode 100644 index 000000000..5af4f3e1d --- /dev/null +++ b/doc/devel/uml/class148613.html @@ -0,0 +1,24 @@ + + + + + + +Class HandlingPattern + + + + + +
Class HandlingPattern
+

+ + + + +

Declaration :

Directly inherited by : DoAsync DoSync RedoLast UndoSync

+

Stereotype: interface

+
+
+ + diff --git a/doc/devel/uml/class148741.html b/doc/devel/uml/class148741.html new file mode 100644 index 000000000..0026a259f --- /dev/null +++ b/doc/devel/uml/class148741.html @@ -0,0 +1,22 @@ + + + + + + +Class Mutation + + + + + +
Class Mutation
+

+ + + + +

Declaration :

Directly inherited by : UndoMutation

+

Stereotype: func

+ + diff --git a/doc/devel/uml/class148869.html b/doc/devel/uml/class148869.html new file mode 100644 index 000000000..7e0586b00 --- /dev/null +++ b/doc/devel/uml/class148869.html @@ -0,0 +1,25 @@ + + + + + + +Class UndoMutation + + + + + +
Class UndoMutation
+

+ + + + +

Declaration :

Stereotype: func

+
+ +
Relation capture (<unidirectional association>)

Declaration :

+
Relation undoOp (<unidirectional association>)

Declaration :

+ + diff --git a/doc/devel/uml/class148997.html b/doc/devel/uml/class148997.html new file mode 100644 index 000000000..85ab6a55d --- /dev/null +++ b/doc/devel/uml/class148997.html @@ -0,0 +1,26 @@ + + + + + + +Class CmdClosure + + + + + +
Class CmdClosure
+

+ + + + +

Declaration :

+ +
Relation targets (<directional composition>)

Declaration :

Stereotype: list

+ +
Relation params (<directional composition>)

Declaration :

Stereotype: list

+
+ + diff --git a/doc/devel/uml/class149125.html b/doc/devel/uml/class149125.html new file mode 100644 index 000000000..9426554d2 --- /dev/null +++ b/doc/devel/uml/class149125.html @@ -0,0 +1,22 @@ + + + + + + +Class DoSync + + + + + +
Class DoSync
+

+ + + + +

Declaration :

+
+ + diff --git a/doc/devel/uml/class149253.html b/doc/devel/uml/class149253.html new file mode 100644 index 000000000..0bc1f1ae6 --- /dev/null +++ b/doc/devel/uml/class149253.html @@ -0,0 +1,22 @@ + + + + + + +Class DoAsync + + + + + +
Class DoAsync
+

+ + + + +

Declaration :

+
+ + diff --git a/doc/devel/uml/class149381.html b/doc/devel/uml/class149381.html new file mode 100644 index 000000000..72a009390 --- /dev/null +++ b/doc/devel/uml/class149381.html @@ -0,0 +1,22 @@ + + + + + + +Class UndoSync + + + + + +
Class UndoSync
+

+ + + + +

Declaration :

+
+ + diff --git a/doc/devel/uml/class149509.html b/doc/devel/uml/class149509.html new file mode 100644 index 000000000..e5c2ee5ab --- /dev/null +++ b/doc/devel/uml/class149509.html @@ -0,0 +1,22 @@ + + + + + + +Class RedoLast + + + + + +
Class RedoLast
+

+ + + + +

Declaration :

+
+ + diff --git a/doc/devel/uml/class149637.html b/doc/devel/uml/class149637.html new file mode 100644 index 000000000..da4da6a27 --- /dev/null +++ b/doc/devel/uml/class149637.html @@ -0,0 +1,20 @@ + + + + + + +Class Target + + + + + +
Class Target
+

+ + + + +

Declaration :

+ diff --git a/doc/devel/uml/classdiagrams.html b/doc/devel/uml/classdiagrams.html index 8e9652413..bfd20dbab 100644 --- a/doc/devel/uml/classdiagrams.html +++ b/doc/devel/uml/classdiagrams.html @@ -20,6 +20,7 @@ Automation Entities Builder Entities Builder Tool (Visitor) +Command structure Controller Entities File MappingShows whats used to access Frames HierarchyLumiera Exception hierarchy diff --git a/doc/devel/uml/classes.html b/doc/devel/uml/classes.html index b30de8c8b..8c54eb58f 100644 --- a/doc/devel/uml/classes.html +++ b/doc/devel/uml/classes.html @@ -38,8 +38,10 @@ Categorytree like classification of Assets Clipbookkeeping (asset) view of a media clip. Clip +CmdClosure Codecdescription of some media data decoder or encoder facility CodecAdapter +CommandinterfaceKey abstraction for all proc/edit operations and UNDO management CompoundClipClip MObject which is actually a compound of several elementary clips,
e.g. the several streams found within multichannels media. CompoundMediacompound of several elementary media tracks,
e.g. the individual media streams found in one media file ConditionI provided a reworked Condition class in my Cinelerra2 repository @@ -52,8 +54,10 @@ DBImplementation of the registry holding all Asset instances known to the Asset Manager subsystem. As of 8/2007 implemented by a hashtable. DefaultsManager DefaultsRegistry +DoAsync DoAttach DoRecurse +DoSync EffectEffect or media processing component Effect Error @@ -77,6 +81,7 @@ FrameDescriptorinterfaceA FrameDescriptor implements the higher level interfaces for frames. Further refinements are made by subclassing and policy classes FrameReference GLBuf +HandlingPatterninterface ImplFacade InstanceHandle InterpolatorProvides the implementation for getting the acutal value of a time varying or automated effect/plugin parameter @@ -97,6 +102,7 @@ Meta MObjectinterface Monitor +Mutationfunc MutexI provided a reworked Mutex class in my Cinelerra2 repository NodeCreatorToolThis Tool implementation plays the central role in the buld process: given a MObject from Session, it is able to attach ProcNodes to the render engine under construction such as to reflect the properties of the MObject in the actual render. NodeWiring @@ -113,7 +119,7 @@ Prefetch Previewalternative version of the media data, probably with lower resolution Prockey abstraction: data processing asset -ProcDispatcher +ProcDispatchercontrol ProcessData ProcNodeinterfaceKey abstraction of the Render Engine: A Data processing Node ProcPattspecial type of structural Asset representing information how to build some part of the render engine's processing nodes network. @@ -126,6 +132,7 @@ QueryHandlerinterface QueryHandlerImpl ReadSource +RedoLast RelativeLocation RelTypeenumthe possible kinds of RelativePlacements RenderEngine @@ -157,6 +164,7 @@ StreamTypeID Structkey abstraction: structural asset STypeManager +Target ThreadWe can basically reuse the Thread class design from Cinelerra2, Thread becomes a baseclass for all Threads Timedenotes a temporal position (time point), based on timeline start.

investigate posix.4 realtime timers, wrap these here Timeline @@ -168,6 +176,8 @@ Trafo TypeHandlerinterface TypeHandler<Pipe> +UndoMutationfunc +UndoSync Unknownplaceholder for unknown or unavailable media source Useractor VFrame diff --git a/doc/devel/uml/classes_list.html b/doc/devel/uml/classes_list.html index 94c71e519..c9f7a4cd0 100644 --- a/doc/devel/uml/classes_list.html +++ b/doc/devel/uml/classes_list.html @@ -39,8 +39,10 @@ Category
Clip
Clip
+CmdClosure
Codec
CodecAdapter
+Command
CompoundClip
CompoundMedia
Condition
@@ -53,8 +55,10 @@ DB
DefaultsManager
DefaultsRegistry
+DoAsync
DoAttach
DoRecurse
+DoSync
Effect
Effect
Error
@@ -78,6 +82,7 @@ FrameDescriptor
FrameReference
GLBuf
+HandlingPattern
ImplFacade
InstanceHandle
Interpolator
@@ -98,6 +103,7 @@ Meta
MObject
Monitor
+Mutation
Mutex
NodeCreatorTool
NodeWiring
@@ -127,6 +133,7 @@ QueryHandler
QueryHandlerImpl
ReadSource
+RedoLast
RelativeLocation
RelType
RenderEngine
@@ -158,6 +165,7 @@ StreamTypeID
Struct
STypeManager
+Target
Thread
Time
Timeline
@@ -169,6 +177,8 @@ Trafo
TypeHandler
TypeHandler<Pipe>
+UndoMutation
+UndoSync
Unknown
User
VFrame
diff --git a/doc/devel/uml/fig134021.png b/doc/devel/uml/fig134021.png new file mode 100644 index 000000000..c3acb3677 Binary files /dev/null and b/doc/devel/uml/fig134021.png differ diff --git a/doc/devel/uml/index.html b/doc/devel/uml/index.html index 5257dd3f7..2e6e4c680 100644 --- a/doc/devel/uml/index.html +++ b/doc/devel/uml/index.html @@ -19,7 +19,7 @@ Documentation

Properties:

@@ -147,7 +147,7 @@ Documentation
Artifact Lumiera

the main executable to be built

Depends on common

Depends on gui

Depends on proc

Depends on backend

Stereotype: executable

-

executable associated with : exitnode, pathmanager, track, meta, fixedlocation, relativelocation, controllerfacade, rendergraph, pluginadapter, explicitplacement, auto, glrender, arender, renderstate, label, nodecreatertool, projector, interpolator, paramprovider, mask, mobject, source, frame, effect, buildertool, segmentationtool, link, parameter, renderengine, glbuf, procnode, stateproxy, edl, fixture, glpipe, main, conmanager, clip, vrender, placement, sessionimpl, builderfacade, aframe, assembler, trafo, allocation, vframe, toolfactory, hub, buildable, abstractmo

+

executable associated with : placement, sessionimpl, builderfacade, aframe, assembler, trafo, allocation, vframe, toolfactory, hub, buildable, abstractmo, exitnode, pathmanager, track, meta, fixedlocation, relativelocation, controllerfacade, rendergraph, pluginadapter, explicitplacement, auto, glrender, arender, renderstate, label, nodecreatertool, projector, interpolator, paramprovider, mask, mobject, source, frame, effect, buildertool, segmentationtool, link, parameter, renderengine, glbuf, procnode, stateproxy, edl, fixture, glpipe, main, conmanager, clip, vrender

Artifact main

Stereotype: source

@@ -774,7 +774,7 @@ Documentation

2.2 Package Control

-
+

Command handling, Proc-Layer dispatcher, controller and administrative facilities

2.2.1 Class View Controller Workings

@@ -829,6 +829,24 @@ reuse exiting Engine

Selection :

    Transformation
    Class RenderState
    Class STypeManager

    + +

    2.2.2 Class View Command Handling

    +
    + +

    +

    Command structure



    +
    Class Command
    +
    Class HandlingPattern
    +
    Class Mutation
    +
    Class UndoMutation
    +
    Class CmdClosure
    +
    Class DoSync
    +
    Class DoAsync
    +
    Class UndoSync
    +
    Class RedoLast
    +
    Class Target
    +
    Class ProcDispatcher
    +

    2.3 Package MObject

    @@ -870,7 +888,6 @@ reuse exiting Engine

    Selection :

    Transformation
    Class ParamProvider
    Class Interpolator
    Class LocatingPin
    -
    Class ProcDispatcher

    2.3.2 Package Builder

    diff --git a/doc/devel/uml/index_67.html b/doc/devel/uml/index_67.html index a17989712..128becdac 100644 --- a/doc/devel/uml/index_67.html +++ b/doc/devel/uml/index_67.html @@ -24,54 +24,60 @@ callDownoperation callDownoperation Callerclass +capturerelation categoryrelationprimary tree like classification of the asset Categoryclasstree like classification of Assets categoryartifacttree like classification of Assets causeattributea copy of the first exception encountered in this exception chain -chainrelationChain of additional Placements further constraining the position of this MObject chainoperationcreate and add another Placement for this media object, thus increasingly constraining the (possible) position of this object. +chainrelationChain of additional Placements further constraining the position of this MObject checked_inrelationchecked_in objects are subject of cache aging and must be not in use checked_outrelationthis list keeps all mappings which are in use, and thus prevents them from Cache aging -class instanceclass instance -class instanceclass instance +class instanceclass instance class instanceclass instance -class instanceclass instance -class instanceclass instance -class instanceclass instance class instanceclass instance class instanceclass instance -class instanceclass instance +class instanceclass instance +class instanceclass instance class instanceclass instance -class instanceclass instance -class instanceclass instance -class instanceclass instance -class instanceclass instance -class instanceclass instance -class instanceclass instance -class instanceclass instance -class instanceclass instance +class instanceclass instance +class instanceclass instance +class instanceclass instance class instanceclass instance -class instanceclass instance -class instanceclass instance +class instanceclass instance +class instanceclass instance +class instanceclass instance class instanceclass instance class instanceclass instance -class instanceclass instance class instanceclass instance +class instanceclass instance +class instanceclass instance +class instanceclass instance +class instanceclass instance +class instanceclass instance class instanceclass instance -class instanceclass instance class instanceclass instance +class instanceclass instance +class instanceclass instance +class instanceclass instance +class instanceclass instance clearoperationclear current session contents
    without resetting overall session config.
    Afterwards, the session will contain only one
    empty EDL, while all Assets are retained.
    client codecomponent Clipclassbookkeeping (asset) view of a media clip. -clipartifacta Media Clip clipartifactbookkeeping (asset) view of a media clip. +clipartifacta Media Clip Clipclass clipsrelation +closureattribute +CmdClosureclass Codecclassdescription of some media data decoder or encoder facility codecartifactdescription of some media data decoder or encoder facility CodecAdapterclass codecadapterartifactProcessing Node for (de)coding media data codegenpackageThis package is used to organize code generation by BOUML. It is considered useless after having generated the initial code skeleton. +CommandclassKey abstraction for all proc/edit operations and UNDO management +Command Handlingclass view +Command structureclass diagram commonpackagesourcecode package

    Common library and helper classes CommonLibcomponent CommonLibpackage @@ -99,7 +105,7 @@ constraintartifactLocatingPin representing an directive by the user that
    must not be violated Constraintclass controlpackagesourcecode package

    The Processing and Render Controller,
    and the Proc-Layer dispatcher -Controlpackage +ControlpackageCommand handling, Proc-Layer dispatcher, controller and administrative facilities Controllercomponent Controller Entitiesclass diagram Controller Workingsclass view diff --git a/doc/devel/uml/index_68.html b/doc/devel/uml/index_68.html index e9e768a1e..40b7b291d 100644 --- a/doc/devel/uml/index_68.html +++ b/doc/devel/uml/index_68.html @@ -32,13 +32,16 @@ designpackage designpackageAll things concering the big picture.
    Not a real code package, rather a container for design drafts, specifications, decisions. detect Channelsuse case -determine Render Paramsopaque activity action determine Render Paramsexpansion region +determine Render Paramsopaque activity action devnullclass instance Dispatchercomponent dispatchOpoperation +doattribute +DoAsyncclass DoAttachclass DoRecurseclass +DoSyncclass diff --git a/doc/devel/uml/index_69.html b/doc/devel/uml/index_69.html index 37fab2669..0c6f365e7 100644 --- a/doc/devel/uml/index_69.html +++ b/doc/devel/uml/index_69.html @@ -43,6 +43,7 @@ errorartifactLumiera Exception Interface establish partitioningexpansion region EXE Deploymentdeployment viewdefines and lists how the Lumiera executable has to be created +executeoperation ExitNodeclassThe output of the render pipeline. Pulling from such exit nodes actually ivokes the render process exitnodeartifactspecial Processing Node providing "pullable" output explicitplacementartifactspecial Placement yielding an absolute location (Time,Track)-location for a MObject diff --git a/doc/devel/uml/index_72.html b/doc/devel/uml/index_72.html index 7e5b73a00..90532e3e5 100644 --- a/doc/devel/uml/index_72.html +++ b/doc/devel/uml/index_72.html @@ -20,11 +20,12 @@ handlerelationweak pointer handlesrelation handles_availableattributeinitialized to the maximum number of filehandles the backend may use for mapped files. When no handles are available, the handle which is last in the handles list is closed and (re-)used.
    Else this number is decremented for each new filehandle used and incremented for any one explicitly freed. +HandlingPatternclass Hierarchyclass diagramLumiera Exception hierarchy howtoProcoperation@return descriptor how to build a render pipeline corresponding to this media hubartifactspecial ProcNode used to build data distributing connections -HUEclass instance HUEclass instance +HUEclass instance diff --git a/doc/devel/uml/index_73.html b/doc/devel/uml/index_73.html index 844b1bf03..8dc64d64b 100644 --- a/doc/devel/uml/index_73.html +++ b/doc/devel/uml/index_73.html @@ -18,12 +18,13 @@ + - + diff --git a/doc/devel/uml/index_77.html b/doc/devel/uml/index_77.html index 56c268d60..bef78819f 100644 --- a/doc/devel/uml/index_77.html +++ b/doc/devel/uml/index_77.html @@ -34,8 +34,8 @@ - + @@ -43,6 +43,7 @@ +
    NameKindDescription
    idattributeAsset primary key.
    IDattribute
    ImplFacadeclass
    In Memory Databaseclass diagram
    inFixtureactivity action pin
    inputclass instance
    inputclass instance
    inputclass instance
    inputclass instance
    instanceoperation
    InstanceHandleclass
    instructionsrelation
    MediaKindclass
    merge activity nodemerge activity node
    Metaclasskey abstraction: metadata and organisational asset
    metaartifactabstract base class of all MObjects representing meta data or processing instructions
    metaartifactkey abstraction: metadata and organisational asset
    metaartifactabstract base class of all MObjects representing meta data or processing instructions
    Metaclass
    mobjectartifactKey Abstraction: A Media Object in the Session
    mobjectpackagesourcecode package

    MObject Subsystem
    including the Session (EDL), Builder and Processing Controller
    MObjectclass
    Monitorclass
    multichannel clipobject diagram
    Mutationclass
    MutexclassI provided a reworked Mutex class in my Cinelerra2 repository
    diff --git a/doc/devel/uml/index_78.html b/doc/devel/uml/index_78.html index 74fa8a9d8..2671839d3 100644 --- a/doc/devel/uml/index_78.html +++ b/doc/devel/uml/index_78.html @@ -18,6 +18,7 @@ + diff --git a/doc/devel/uml/index_80.html b/doc/devel/uml/index_80.html index 5f43290e4..a9a67427a 100644 --- a/doc/devel/uml/index_80.html +++ b/doc/devel/uml/index_80.html @@ -22,6 +22,7 @@ + diff --git a/doc/devel/uml/index_82.html b/doc/devel/uml/index_82.html index 8c7b345eb..3f9b13363 100644 --- a/doc/devel/uml/index_82.html +++ b/doc/devel/uml/index_82.html @@ -18,6 +18,7 @@
    NameKindDescription
    nameattributeelement ID, comprehensible but sanitized. The tuple (category, name, org) is unique.
    nameattribute
    need sub objectuse case
    nextrelationnext additional LocatingPin, if any
    node1class instance
    ParameterclassDescriptor and access object for a plugin parameter. Parameters may be provided with values from the session, and this values may be automated.
    paramproviderartifactinterface denoting a source for actual Parameter values
    ParamProviderclassA facility to get the actual value of a plugin/effect parameter
    paramsrelation
    paramsrelation
    PathManagerclassWhile building a render engine, this Strategy class decides on the actual render strategy in accordance to the current controller settings (system state)
    pathmanagerartifactManager for deciding the actual render strategy
    + diff --git a/doc/devel/uml/index_83.html b/doc/devel/uml/index_83.html index 028888285..ceab40c4a 100644 --- a/doc/devel/uml/index_83.html +++ b/doc/devel/uml/index_83.html @@ -36,8 +36,8 @@ - + @@ -51,8 +51,8 @@ - + diff --git a/doc/devel/uml/index_84.html b/doc/devel/uml/index_84.html index 361bf1d1f..58b8a6bf5 100644 --- a/doc/devel/uml/index_84.html +++ b/doc/devel/uml/index_84.html @@ -17,6 +17,8 @@
    NameKindDescription
    ReadSourceclass
    RedoLastclass
    refPointclass instance
    regoperationregisters an asset object in the internal DB, providing its unique key
    registryrelation@internal Table or DB holding all registered asset instances.
    ServiceImplclass
    Sessioncomponent
    sessionartifactInterface: the session edited by the user
    Sessionclass view
    sessionpackagesourcecode package

    Everything concerning the EDL and Session, within the MObject Subsystem
    Sessionclass view
    SessionclassPrimary Interface for all editing tasks.
    The session contains defaults, all the assets being edited, and a set of EDL with the individual MObjects to be manipulated and rendered.
    Session structureclass diagram
    sessionimplartifactholds the complete session data to be edited by the user
    SimpleClipclassElementary clip consisting of only one media stream
    SmartPointerclass
    SmartPointersclass view
    sourcerelationthe media source this clip referes to
    sourcerelationmedia source of this clip
    sourcerelationthe media source this clip referes to
    SourceclassSource Node: represents a media source to pull data from.
    sourceartifactRepresentation of a Media source
    Source Overviewdeployment diagram
    + + @@ -34,8 +36,8 @@ - + @@ -45,12 +47,12 @@ - + - +
    NameKindDescription
    Targetclass
    targetsrelation
    the render configuration flowactivity diagram
    theApp_attributeholds the single instance and triggers initialization
    theFixturerelation
    Trackclassstructural asset holding the configuration of a track in the EDL
    trackattribute
    trackrelation
    trackartifactstructural asset holding the configuration of a track in the EDL
    trackartifactA grouping device within the EDL. The corresponding Placement
    by which this Track object is refered defines fallback placing
    properties to be used by all objects placed on this track in
    case they don't specify more concrete placements.
    Typically, tracks are used do make default Port connections,
    define a layer or pan for sound and for for disabling groups
    of clips. Note tracks are grouped in a tree like fashion.
    trackartifactstructural asset holding the configuration of a track in the EDL
    trackrelation
    Trackclass
    tracksrelationelementary media assets comprising this compound
    treatoperation
    treatoperationThis operation is to be overloaded for the specific MObject subclasses to be treated.
    treatoperation
    treatoperation
    treatoperation
    treatoperation
    treatoperation
    treatoperation
    treatoperation
    treatoperation
    treatoperation
    TypeHandlerclass
    TypeHandler<Pipe>class
    diff --git a/doc/devel/uml/index_85.html b/doc/devel/uml/index_85.html index dafc717cb..ce1f36dc0 100644 --- a/doc/devel/uml/index_85.html +++ b/doc/devel/uml/index_85.html @@ -17,6 +17,10 @@ + + + + diff --git a/doc/devel/uml/packages.html b/doc/devel/uml/packages.html index 25b52f427..7b039a400 100644 --- a/doc/devel/uml/packages.html +++ b/doc/devel/uml/packages.html @@ -27,7 +27,7 @@ - + diff --git a/doc/devel/uml/public_operations.html b/doc/devel/uml/public_operations.html index fe9b01e39..717b3562d 100644 --- a/doc/devel/uml/public_operations.html +++ b/doc/devel/uml/public_operations.html @@ -32,6 +32,7 @@ + diff --git a/doc/devel/uml/public_properties.html b/doc/devel/uml/public_properties.html index 6fa20439e..58690294f 100644 --- a/doc/devel/uml/public_properties.html +++ b/doc/devel/uml/public_properties.html @@ -19,12 +19,16 @@ + + + +
    NameKindDescription
    undoattribute
    UndoMutationclass
    undoOprelation
    UndoSyncclass
    Unknownclassplaceholder for unknown or unavailable media source
    unknownartifactplaceholder for unknown or unavailable media source
    usageuse case view
    CommonLib
    ConfigQuery
    controlsrcsourcecode package

    The Processing and Render Controller,
    and the Proc-Layer dispatcher
    Control
    ControlCommand handling, Proc-Layer dispatcher, controller and administrative facilities
    design
    designAll things concering the big picture.
    Not a real code package, rather a container for design drafts, specifications, decisions.
    enginesrcsourcecode package

    The Core Render Engine
    currEDLSessionThe EDL currently in focus. In most cases, Session and EDL are almost the same, just EDL emphasizes the collection aspect. But generally (for larger editing projects) one Session can contain several EDLs, which may even be nested. At any given time, only one of these EDLs has focus and recieves the editing commands.
    dispatchOpVisitable
    enableAssetchange the enabled status of this asset. Note the corresponding #isActive predicate may depend on the enablement status of parent assets as well
    executeCommand
    fetchState
    findTypeHandler
    getAppconfigaccess the configuation value for a given key.
    @return empty string for unknown keys, else the corresponding configuration value
    PropertyClassDescription
    categoryAssetprimary tree like classification of the asset
    currentSessionStandard access path to get at the current session via the Session Manager, which acts as a "PImpl" smart pointer
    doCommand
    idAssetAsset primary key.
    IDCommand
    nameAssetelement ID, comprehensible but sanitized. The tuple (category, name, org) is unique.
    nameCommand
    nodesDoAttach
    orgAssetorigin or authorship id. Can be a project abbreviation, a package id or just the authors nickname or UID. This allows for the compnent name to be more generic (e.g. "blur"). Default for all assets provided by the core Lumiera codebase is "lumi".
    pointDoAttachidentifying the point where the nodes should be attached
    subTracksTrackChild tracks in a tree structure
    undoCommand
    versionAssetversion number of the thing or concept represented by this asset. Of each unique tuple (name, category, org) there will be only one version in the whole system. Version 0 is reserved for internal purposes. Versions are considered to be ordered, and any higher version is supposed to be fully backwards compatible to all previous versions.
    diff --git a/uml/lumiera/128261 b/uml/lumiera/128261 index dc029b147..a6af8fb25 100644 --- a/uml/lumiera/128261 +++ b/uml/lumiera/128261 @@ -1,6 +1,6 @@ format 58 "MObject" // ProcessingLayer::MObject - revision 35 + revision 36 modified_by 5 "hiv" // class settings //class diagram settings @@ -1432,21 +1432,6 @@ ${inlines} b parent class_ref 139909 // LocatingPin end end - - class 141957 "ProcDispatcher" - visibility package - cpp_decl "${comment}${template}class ${name}${inherit} - { -${members} }; -${inlines} -" - java_decl "" - php_decl "" - python_2_2 python_decl "" - idl_decl "" - explicit_switch_type "" - - end end package_ref 128901 // Builder diff --git a/uml/lumiera/129029 b/uml/lumiera/129029 index e091ca09b..ffbb809fb 100644 --- a/uml/lumiera/129029 +++ b/uml/lumiera/129029 @@ -1,57 +1,57 @@ -format 40 +format 58 "Control" // ProcessingLayer::Control - revision 7 + revision 8 modified_by 5 "hiv" // class settings //class diagram settings - draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default //use case diagram settings - package_name_in_tab default show_context default auto_label_position default draw_all_relations default shadow default + package_name_in_tab default show_context default auto_label_position default draw_all_relations default class_drawing_mode default shadow default show_stereotype_properties default //sequence diagram settings - show_full_operations_definition default write_horizontally default class_drawing_mode default drawing_language default draw_all_relations default shadow default + show_full_operations_definition default write_horizontally default class_drawing_mode default drawing_language default draw_all_relations default shadow default show_stereotype_properties default //collaboration diagram settings - show_full_operations_definition default show_hierarchical_rank default write_horizontally default drawing_language default package_name_in_tab default show_context default draw_all_relations default shadow default + show_full_operations_definition default show_hierarchical_rank default write_horizontally default drawing_language default package_name_in_tab default show_context default draw_all_relations default shadow default show_stereotype_properties default //object diagram settings - write_horizontally default package_name_in_tab default show_context default auto_label_position default draw_all_relations default shadow default + write_horizontally default package_name_in_tab default show_context default auto_label_position default draw_all_relations default shadow default show_stereotype_properties default //component diagram settings package_name_in_tab default show_context default auto_label_position default draw_all_relations default shadow default - draw_component_as_icon default show_component_req_prov default show_component_rea default + draw_component_as_icon default show_component_req_prov default show_component_rea default show_stereotype_properties default //deployment diagram settings package_name_in_tab default show_context default write_horizontally default auto_label_position default draw_all_relations default shadow default - draw_component_as_icon default show_component_req_prov default show_component_rea default + draw_component_as_icon default show_component_req_prov default show_component_rea default show_stereotype_properties default //state diagram settings package_name_in_tab default show_context default auto_label_position default write_trans_label_horizontally default show_trans_definition default draw_all_relations default shadow default - show_activities default region_horizontally default drawing_language default + show_activities default region_horizontally default drawing_language default show_stereotype_properties default //activity diagram settings package_name_in_tab default show_context default show_opaque_action_definition default auto_label_position default write_flow_label_horizontally default draw_all_relations default shadow default - show_infonote default drawing_language default + show_infonote default drawing_language default show_stereotype_properties default + comment "Command handling, Proc-Layer dispatcher, controller and administrative facilities" classview 128389 "Controller Workings" //class diagram settings - draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default //collaboration diagram settings - show_full_operations_definition default show_hierarchical_rank default write_horizontally default drawing_language default package_name_in_tab default show_context default draw_all_relations default shadow default + show_full_operations_definition default show_hierarchical_rank default write_horizontally default drawing_language default package_name_in_tab default show_context default draw_all_relations default shadow default show_stereotype_properties default //object diagram settings - write_horizontally default package_name_in_tab default show_context default auto_label_position default draw_all_relations default shadow default + write_horizontally default package_name_in_tab default show_context default auto_label_position default draw_all_relations default shadow default show_stereotype_properties default //sequence diagram settings - show_full_operations_definition default write_horizontally default class_drawing_mode default drawing_language default draw_all_relations default shadow default + show_full_operations_definition default write_horizontally default class_drawing_mode default drawing_language default draw_all_relations default shadow default show_stereotype_properties default //state diagram settings package_name_in_tab default show_context default auto_label_position default write_trans_label_horizontally default show_trans_definition default draw_all_relations default shadow default - show_activities default region_horizontally default drawing_language default + show_activities default region_horizontally default drawing_language default show_stereotype_properties default //class settings //activity diagram settings package_name_in_tab default show_context default show_opaque_action_definition default auto_label_position default write_flow_label_horizontally default draw_all_relations default shadow default - show_infonote default drawing_language default - + show_infonote default drawing_language default show_stereotype_properties default classdiagram 128645 "Controller Entities" - draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default size A4 end activity 128133 "configure Render" activitydiagram 129541 "the render configuration flow" package_name_in_tab default show_context default show_opaque_action_definition default auto_label_position default write_flow_label_horizontally default draw_all_relations default shadow default - show_infonote default drawing_language default + show_infonote default drawing_language default show_stereotype_properties default size A4 end @@ -123,6 +123,8 @@ ${members} }; ${inlines} " java_decl "" + php_decl "" + python_2_2 python_decl "" idl_decl "${comment}${abstract}${local}interface ${name}${inherit} { ${members}}; " @@ -139,12 +141,14 @@ ${members} }; ${inlines} " java_decl "" + php_decl "" + python_2_2 python_decl "" idl_decl "" explicit_switch_type "" comment "While building a render engine, this Strategy class decides on the actual render strategy in accordance to the current controller settings (system state)" operation 128261 "buildProcessor" - public return_type class_ref 131461 // Processor + public return_type class_ref 131461 // RenderGraph nparams 0 cpp_decl " ${comment}${friend}${static}${inline}${virtual}${type} ${name} ${(}${)}${const}${volatile} ${throw}${abstract};" cpp_def "${comment}${inline}${type} @@ -156,6 +160,8 @@ ${class}::${name} ${(}${)}${const}${volatile} ${throw}${staticnl} " + + end end @@ -167,6 +173,8 @@ ${members} }; ${inlines} " java_decl "" + php_decl "" + python_2_2 python_decl "" idl_decl "" explicit_switch_type "" @@ -184,6 +192,8 @@ ${class}::${name} ${(}${)}${const}${volatile} ${throw}${staticnl} " + + end end @@ -195,6 +205,387 @@ ${members} }; ${inlines} " java_decl "" + php_decl "" + python_2_2 python_decl "" + idl_decl "" + explicit_switch_type "" + + end + end + + classview 130693 "Command Handling" + //class diagram settings + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default + //collaboration diagram settings + show_full_operations_definition default show_hierarchical_rank default write_horizontally default drawing_language default package_name_in_tab default show_context default draw_all_relations default shadow default show_stereotype_properties default + //object diagram settings + write_horizontally default package_name_in_tab default show_context default auto_label_position default draw_all_relations default shadow default show_stereotype_properties default + //sequence diagram settings + show_full_operations_definition default write_horizontally default class_drawing_mode default drawing_language default draw_all_relations default shadow default show_stereotype_properties default + //state diagram settings + package_name_in_tab default show_context default auto_label_position default write_trans_label_horizontally default show_trans_definition default draw_all_relations default shadow default + show_activities default region_horizontally default drawing_language default show_stereotype_properties default + //class settings + //activity diagram settings + package_name_in_tab default show_context default show_opaque_action_definition default auto_label_position default write_flow_label_horizontally default draw_all_relations default shadow default + show_infonote default drawing_language default show_stereotype_properties default + classdiagram 134021 "Command structure" + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default + size A4 + end + + class 148485 "Command" + visibility public stereotype "interface" + cpp_decl "${comment}${template}class ${name}${inherit} + { +${members} }; +${inlines} +" + java_decl "${comment}${@}${visibility}interface ${name}${extends} { +${members}} +" + php_decl "${comment}${visibility}interface ${name} { +${members}} +" + python_2_2 python_decl "" + idl_decl "${comment}${abstract}${local}interface ${name}${inherit} { +${members}}; +" + explicit_switch_type "" + + comment "Key abstraction for all proc/edit operations and UNDO management" + attribute 132613 "ID" + const_attribute public explicit_type "" + cpp_decl " ${comment}${static}${mutable}${volatile}${const}${type} ${name}${value}; +" + java_decl "" + php_decl "" + python_decl "" + idl_decl "" + end + + attribute 132741 "name" + const_attribute public explicit_type "Symbol" + cpp_decl " ${comment}${static}${mutable}${volatile}${const}${type} ${name}${value}; +" + java_decl "" + php_decl "" + python_decl "" + idl_decl "" + end + + attribute 132869 "do" + public type class_ref 148741 // Mutation + cpp_decl " ${comment}${static}${mutable}${volatile}${const}${type} ${name}${value}; +" + java_decl "" + php_decl "" + python_decl "" + idl_decl "" + end + + attribute 132997 "undo" + public type class_ref 148869 // UndoMutation + cpp_decl " ${comment}${static}${mutable}${volatile}${const}${type} ${name}${value}; +" + java_decl "" + php_decl "" + python_decl "" + idl_decl "" + end + + attribute 133125 "closure" + private type class_ref 148997 // CmdClosure + cpp_decl " ${comment}${static}${mutable}${volatile}${const}${type} ${name}${value}; +" + java_decl "" + php_decl "" + python_decl "" + idl_decl "" + end + + operation 137733 "execute" + public explicit_return_type "void" + nparams 1 + param in name "context" explicit_type "HandlingPattern" + cpp_decl " ${comment}${friend}${static}${inline}${virtual}${type} ${name} ${(}${)}${const}${volatile} ${throw}${abstract};" + cpp_def "${comment}${inline}${type} +${class}::${name} ${(}${)}${const}${volatile} ${throw}${staticnl} +{ + ${body} +} + +" + + + + + end + + classrelation 172805 // + relation 162821 ---> + stereotype "has_a" + a role_name "" multiplicity "1" protected + cpp default " ${comment}${static}${mutable}${volatile}${const}${type}* ${name}${value}; +" + classrelation_ref 172805 // + b multiplicity "1" parent class_ref 148997 // CmdClosure + end + + classrelation 173189 // + relation 163205 ---> + stereotype "has_a" + a role_name "" protected + cpp default " ${comment}${static}${mutable}${volatile}${const}${type}* ${name}${value}; +" + classrelation_ref 173189 // + b parent class_ref 148741 // Mutation + end + + classrelation 173317 // + relation 163333 ---> + a role_name "" protected + cpp default " ${comment}${static}${mutable}${volatile}${const}${type}* ${name}${value}; +" + classrelation_ref 173317 // + b parent class_ref 148869 // UndoMutation + end + + classrelation 173573 // + relation 163589 -_-> + stereotype "invokes" + a package + cpp default "#include in source" + classrelation_ref 173573 // + b parent class_ref 148613 // HandlingPattern + end + end + + class 148613 "HandlingPattern" + abstract visibility public stereotype "interface" + cpp_decl "${comment}${template}class ${name}${inherit} + { +${members} }; +${inlines} +" + java_decl "" + php_decl "" + python_2_2 python_decl "" + idl_decl "" + explicit_switch_type "" + + classrelation 173701 // + relation 163717 -_-> + stereotype "involves" + a package + cpp default "#include in source" + classrelation_ref 173701 // + b parent class_ref 141957 // ProcDispatcher + end + end + + class 148741 "Mutation" + visibility package stereotype "func" + cpp_decl "${comment}${template}class ${name}${inherit} + { +${members} }; +${inlines} +" + java_decl "" + php_decl "" + python_2_2 python_decl "" + idl_decl "" + explicit_switch_type "" + + end + + class 148869 "UndoMutation" + visibility package stereotype "func" + cpp_decl "${comment}${template}class ${name}${inherit} + { +${members} }; +${inlines} +" + java_decl "" + php_decl "" + python_2_2 python_decl "" + idl_decl "" + explicit_switch_type "" + + classrelation 171909 // + relation 161925 ---|> + a public + cpp default "${type}" + classrelation_ref 171909 // + b parent class_ref 148741 // Mutation + end + + classrelation 172933 // capture () + relation 162949 ---> + a role_name "capture" protected + cpp default " ${comment}${static}${mutable}${volatile}${const}${type}* ${name}${value}; +" + classrelation_ref 172933 // capture () + b parent class_ref 148741 // Mutation + end + + classrelation 173061 // undoOp () + relation 163077 ---> + a role_name "undoOp" protected + cpp default " ${comment}${static}${mutable}${volatile}${const}${type}* ${name}${value}; +" + classrelation_ref 173061 // undoOp () + b parent class_ref 148741 // Mutation + end + end + + class 148997 "CmdClosure" + visibility package + cpp_decl "${comment}${template}class ${name}${inherit} + { +${members} }; +${inlines} +" + java_decl "" + php_decl "" + python_2_2 python_decl "" + idl_decl "" + explicit_switch_type "" + + classrelation 172549 // targets () + relation 162565 *--> + stereotype "list" + a role_name "targets" protected + cpp default " ${comment}${static}${mutable}${volatile}${const}${type} ${name}${value}; +" + classrelation_ref 172549 // targets () + b multiplicity "*" parent class_ref 149637 // Target + end + + classrelation 172677 // params () + relation 162693 *--> + stereotype "list" + a role_name "params" protected + cpp default " ${comment}${static}${mutable}${volatile}${const}${type} ${name}${value}; +" + classrelation_ref 172677 // params () + b multiplicity "*" parent class_ref 134533 // Parameter + end + end + + class 149125 "DoSync" + visibility package + cpp_decl "${comment}${template}class ${name}${inherit} + { +${members} }; +${inlines} +" + java_decl "" + php_decl "" + python_2_2 python_decl "" + idl_decl "" + explicit_switch_type "" + + classrelation 172037 // + relation 162053 ---|> + a public + cpp default "${type}" + classrelation_ref 172037 // + b parent class_ref 148613 // HandlingPattern + end + end + + class 149253 "DoAsync" + visibility package + cpp_decl "${comment}${template}class ${name}${inherit} + { +${members} }; +${inlines} +" + java_decl "" + php_decl "" + python_2_2 python_decl "" + idl_decl "" + explicit_switch_type "" + + classrelation 172165 // + relation 162181 ---|> + a public + cpp default "${type}" + classrelation_ref 172165 // + b parent class_ref 148613 // HandlingPattern + end + end + + class 149381 "UndoSync" + visibility package + cpp_decl "${comment}${template}class ${name}${inherit} + { +${members} }; +${inlines} +" + java_decl "" + php_decl "" + python_2_2 python_decl "" + idl_decl "" + explicit_switch_type "" + + classrelation 172293 // + relation 162309 ---|> + a public + cpp default "${type}" + classrelation_ref 172293 // + b parent class_ref 148613 // HandlingPattern + end + end + + class 149509 "RedoLast" + visibility package + cpp_decl "${comment}${template}class ${name}${inherit} + { +${members} }; +${inlines} +" + java_decl "" + php_decl "" + python_2_2 python_decl "" + idl_decl "" + explicit_switch_type "" + + classrelation 172421 // + relation 162437 ---|> + a public + cpp default "${type}" + classrelation_ref 172421 // + b parent class_ref 148613 // HandlingPattern + end + end + + class 149637 "Target" + visibility package + cpp_decl "${comment}${template}class ${name}${inherit} + { +${members} }; +${inlines} +" + java_decl "" + php_decl "" + python_2_2 python_decl "" + idl_decl "" + explicit_switch_type "" + + end + + class 141957 "ProcDispatcher" + visibility package stereotype "control" + cpp_decl "${comment}${template}class ${name}${inherit} + { +${members} }; +${inlines} +" + java_decl "" + php_decl "" + python_2_2 python_decl "" idl_decl "" explicit_switch_type "" diff --git a/uml/lumiera/134021.diagram b/uml/lumiera/134021.diagram new file mode 100644 index 000000000..47e68f995 --- /dev/null +++ b/uml/lumiera/134021.diagram @@ -0,0 +1,146 @@ +format 58 + +classcanvas 128005 class_ref 148485 // Command + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default + color verylightorange + xyz 177 87 1994 +end +classcanvas 128133 class_ref 148613 // HandlingPattern + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default + xyz 424 293 2000 +end +classcanvas 128261 class_ref 148741 // Mutation + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default + xyz 338 102 2000 +end +classcanvas 128389 class_ref 148869 // UndoMutation + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default + xyz 327 173 2000 +end +classcanvas 128517 class_ref 148997 // CmdClosure + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default + xyz 25 178 2000 +end +classcanvas 128773 class_ref 149125 // DoSync + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default + xyz 488 371 2000 +end +classcanvas 128901 class_ref 149253 // DoAsync + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default + xyz 488 416 2000 +end +classcanvas 129029 class_ref 149381 // UndoSync + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default + xyz 488 462 2000 +end +classcanvas 129157 class_ref 149509 // RedoLast + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default + xyz 488 507 2000 +end +classcanvas 130565 class_ref 134533 // Parameter + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default + xyz 112 298 2005 +end +classcanvas 130693 class_ref 149637 // Target + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default + xyz 112 249 2010 +end +classcanvas 133765 class_ref 141957 // ProcDispatcher + draw_all_relations default hide_attributes default hide_operations default show_members_full_definition default show_members_visibility default show_members_stereotype default show_members_multiplicity default show_members_initialization default member_max_width 0 show_parameter_dir default show_parameter_name default package_name_in_tab default class_drawing_mode default drawing_language default show_context_mode default auto_label_position default show_infonote default shadow default show_stereotype_properties default + color lightred + xyz 279 401 2000 +end +relationcanvas 128645 relation_ref 161925 // + from ref 128389 z 1999 to ref 128261 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b +end +relationcanvas 129285 relation_ref 162053 // + geometry VHr + from ref 128773 z 1999 to point 467 388 + line 130309 z 1999 to ref 128133 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b +end +relationcanvas 129669 relation_ref 162181 // + geometry VHr + from ref 128901 z 1999 to point 467 433 + line 129797 z 1999 to ref 128133 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b +end +relationcanvas 129925 relation_ref 162309 // + geometry VHr + from ref 129029 z 1999 to point 467 479 + line 130053 z 1999 to ref 128133 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b +end +relationcanvas 130181 relation_ref 162437 // + geometry VHr + from ref 129157 z 1999 to point 467 524 + line 130437 z 1999 to ref 128133 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b +end +relationcanvas 130821 relation_ref 162565 // + geometry VH + from ref 128517 z 1999 stereotype "<>" xyz 67 239 3000 to point 59 266 + line 130949 z 1999 to ref 130693 + role_a_pos 69 251 3000 no_role_b + no_multiplicity_a multiplicity_b_pos 47 222 3000 +end +relationcanvas 131077 relation_ref 162693 // + geometry VH + from ref 128517 z 1999 stereotype "<>" xyz 66 300 3000 to point 59 327 + line 131205 z 1999 to ref 130565 + role_a_pos 67 312 3000 no_role_b + no_multiplicity_a multiplicity_b_pos 47 222 3000 +end +relationcanvas 131333 relation_ref 162821 // + decenter_begin 780 + from ref 128005 z 1999 stereotype "<>" xyz 110 184 3000 to ref 128517 + no_role_a no_role_b + multiplicity_a_pos 107 202 3000 multiplicity_b_pos 160 202 3000 +end +relationcanvas 131461 relation_ref 162949 // + decenter_begin 543 + from ref 128389 z 1999 to point 453 201 + line 132229 z 1999 to point 453 128 + line 131717 z 1999 to ref 128261 + role_a_pos 410 174 3000 no_role_b + no_multiplicity_a no_multiplicity_b +end +relationcanvas 131845 relation_ref 163077 // + decenter_begin 280 + from ref 128389 z 1999 to point 453 186 + line 131973 z 1999 to point 453 128 + line 132101 z 1999 to ref 128261 + role_a_pos 409 203 3000 no_role_b + no_multiplicity_a no_multiplicity_b +end +relationcanvas 132613 relation_ref 163205 // + from ref 128005 z 1999 stereotype "<>" xyz 255 165 3000 to point 246 162 + line 132741 z 1999 to ref 128261 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b +end +relationcanvas 132869 relation_ref 163333 // + from ref 128005 z 1999 to point 246 180 + line 133125 z 1999 to ref 128389 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b +end +relationcanvas 133509 relation_ref 163589 // + from ref 128005 z 1993 stereotype "<>" xyz 263 248 3000 to point 245 214 + line 133637 z 1993 to ref 128133 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b +end +relationcanvas 133893 relation_ref 163717 // + from ref 128133 z 1999 stereotype "<>" xyz 314 370 3000 to ref 133765 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b +end +preferred_whz 575 622 1 +end diff --git a/uml/lumiera/lumiera.prj b/uml/lumiera/lumiera.prj index a0b1cba7b..c978054a5 100644 --- a/uml/lumiera/lumiera.prj +++ b/uml/lumiera/lumiera.prj @@ -1,6 +1,6 @@ format 58 "lumiera" - revision 51 + revision 52 modified_by 5 "hiv" cpp_root_dir "../../src/" @@ -54,7 +54,7 @@ format 58 " key "CopyrightClaim" value " Copyright (C) Lumiera.org - 2008, Christian Thaeter + 2008, Hermann Vosseler " key "html dir" value "/mnt/Lager/heim/devel/lumi/doc/devel/uml/" diff --git a/wiki/renderengine.html b/wiki/renderengine.html index 229003ee3..14914c15e 100644 --- a/wiki/renderengine.html +++ b/wiki/renderengine.html @@ -951,6 +951,34 @@ TertiaryMid: #99a TertiaryDark: #667 Error: #f88 +
    +
    Within Proc-Layer, a Command is the abstract representation of a single operation or a compound of operations mutating the HighLevelModel.
+Thus, each command is a ''Functor'' and a ''Closure'' ([[command pattern|http://en.wikipedia.org/wiki/Command_pattern]]), allowing commands to be treated uniformly, enqueued in a [[dispatcher|ProcDispatcher]], logged to the SessionStorage and registered with the UndoManager.
+
+&rarr; see CommandHandling
    +
    +
    +
    Organising any ''mutating'' operations executable by the user (via GUI) by means of the [[command pattern|http://en.wikipedia.org/wiki/Command_pattern]] can be considered //state of the art//&nbsp; today. First of all, it allows to discern the specific implementation operations to be called on one or several objects within the HighLevelModel from the operation requested by the user, the latter being rather a concept. A command can be labeled clearly, executed under controlled circumstances, allowing transactional behaviour.
+
+
+!Defining commands
+[>img[Structure of Commands|uml/fig134021.png]] Basically, a command could contain arbitrary operations, but we'll assume that it causes a well defined mutation within the HighLevelModel, which can be ''undone''. Thus, when defining a command, we need to specify not only a function doing the mutation, but also another function which might be called later to reverse the effect of the action. Besides, the action operates on a number of ''target'' objects and additionally may require a set of ''parameter'' values. These are to be stored explicitly within the command object, thus creating a ''closure'' &mdash; the operation //must not//&nbsp; rely on other hidden parameters (maybe with the exception of very generic singleton system services?).
+
+Theoretically, defining the "undo" operation might utilise two different approaches:
+* specifying an //inverse operation,// known to cancel out the effect of the command operation
+* capturing a //state memento,// which can be played back to restore the state found prior to executing the command.
+
+while obviously the first solution is much simpler to implement on behalf of the command framework, the second solution has distinct advantages, especially in the context of an editing application: there might be rounding or calculation errors, the inverse might be difficult to define correctly, the effect of the operation might depend on circumstances, be random, or might even trigger a resolution operation to yield the final result. Thus the decision is within Lumiera to //favour state capturing// &mdash; but in a modified, semi-manual and not completely exclusive way.
+
+!Undo state
+While the usual implementation might automatically capture the whole model (resulting in a lot of data to be stored and some uncertainty about the scope of the model to be captured), in Lumiera we rely instead on the client code to provide a ''capture function'' and a ''playback function'' alongside with the actual operation. To help with this task, we provide a set of standard handlers for common situations. This way, operations might capture very specific information, might provide an "intelligent undo" to restore a given semantic instead of just a fixed value &mdash; and moreover the client code is free actually to employ the "inverse operation" model in special cases where it just makes more sense.
+
+!Handling of commands
+A command may be defined completely from scratch, or it might just instantiate a CommandPrototype with specific targets and parameters. The command could then be serialised and later be recovered and re-bound with the parameters, but usually it will be handed over to the ProcDispatcher, pending execution. When ''invoking'', the handling sequence is to [[log the command|SessionStorage]], then call the ''undo capture function'', followed from calling the actual ''operation function''. After success, the logging and [[undo registration|UndoManager]] is completed. In any case, finally the ''result signal'' (a functor previously stored within the command) is emitted.
+
+By design, commands are single-serving value objects; executing an operation repeatedly requires creating a collection of command objects, one for each invocation.
+
    +
    The Connection Manager is a service for wiring connections and for querying information and deriving decisions regarding various aspects of data streams and the possibility of connections. The purpose of the Connection Manager is to isolate the [[Builder]], which is client of this information and decision services, from the often convoluted details of type information and organizing a connection.
 
@@ -2978,7 +3006,7 @@ We need a way of addressing existing [[pipes|Pipe]]. Besides, as the Pipes and T
 <<tasksum end>>
    -
    +
    //This page is a scrapbook for working out the implementation of the [[Session Datastructure in Memory|SessionDataMem]]//
 This is a difficult untertaking, because there are several dependencies (most of which aren't fully designed yet as of 5/09)
 * the GUI uses an adapted version of the HighLevelModel; these datastructures are intended to be backed by the Session
@@ -2998,6 +3026,8 @@ This is a difficult untertaking, because there are several dependencies (most of
 
 <<tasksum start>>
 <<taskadder below>>
+<<task >> implement a system for defining parameters and targets
+<<task >> implement a system for generating operations
 <<task >> define the general structure of operations
 <<task >> specify the editing operations
 
@@ -3005,6 +3035,8 @@ This is a difficult untertaking, because there are several dependencies (most of
 <<task 1 1 1>> evaluate models for the [[reference problem|MObjectRef]]
 <<task 2 3 3>> implement an hash-ID
 <<task 1 2 2>> incorporate this ID into class Placement
+<<task 2 2>> define PlacementRef and MObjectRef behaviour
+<<task 1 0>> wire up [[Session]] interface as a LayerSeparationInterface
 <<task 1 1 0>> implement PlacementRef
 <<task 2 2 0>> implement MObjectRef
 
@@ -3567,17 +3599,31 @@ Currently as of 5/09, this is an ongoing [[implementation and planning effort|Pl
 
 {{red{TODO...}}}
    -
    -
    {{red{WIP}}}
    +
    +
    "Session Interface", when used in a more general sense, denotes a compound of several interfaces and facilities, together forming the primary access point to the user visible contents and state of the editing project.
+* the API of the session class
+* the accompanying management interface (SessionManager API)
+* an LayerSeparationInterfaces allowing to access these interfaces from outside the Proc-Layer
+* the primary public ~APIs exposed on the objects to be queried and retrieved via the session class API
+** Sequence
+** Placement
+** Clip
+** Track
+** Effect
+** Automation
+* the [[command|CommandHandling]] interface, including the [[undo|UndoManager]] facility
+
+{{red{WIP}}}
    -
    +
    The Session contains all informations, state and objects to be edited by the User (&rarr;[[def|Session]]).
 As such, the SessionInterface is the main entrance point to Proc-Layer functionality, both for the primary EditingOperations and for playback/rendering processes.
 
 Currently (as of 5/09), Ichthyo is [[targeting|PlanningSessionInMem]] a first preliminary implementation of the [[Session in Memory|SessionDataMem]]
 
 !Design and handling of Objects within the Session
-Objects are attached and manipulated by [[placements|Placement]]; thus the organisation of these placements is part of the session data layout. Effectively, such a placement within the session behaves like an //instances// of a given object, and at the same time it defines the "non-substantial" properties of the object, e.g. its positions and relations. [[References|MObjectRef]] to these placement entries are handed out as parameters, both down to the [[Builder]] and from there to the render processes within the engine, but also to external parts within the GUI and in plugins. The actual implementation of these object references is built on top of the PlacementRef tags, thus relying on the PlacementIndex the session maintains to keep track of all placements and their relations.
    +Objects are attached and manipulated by [[placements|Placement]]; thus the organisation of these placements is part of the session data layout. Effectively, such a placement within the session behaves like an //instances// of a given object, and at the same time it defines the "non-substantial" properties of the object, e.g. its positions and relations. [[References|MObjectRef]] to these placement entries are handed out as parameters, both down to the [[Builder]] and from there to the render processes within the engine, but also to external parts within the GUI and in plugins. The actual implementation of these object references is built on top of the PlacementRef tags, thus relying on the PlacementIndex the session maintains to keep track of all placements and their relations. While &mdash; using these references &mdash; an external client can access the objects and structures within the session, any actual ''mutations'' should be done based on the CommandHandling: a single operation of a sequence of operations is defined as [[Command]], to be [[dispatched as mutation operation|ProcDispatcher]]. Following this policy ensures integration with the SessionStorage and provides (unlimited) [[UNDO|UndoManager]]. + 
    <<<
@@ -5232,13 +5278,13 @@ A good starting point for understanding our library implementation of the visito
 ** when creating a new "~Visitable-and-Tool" hierarchy, the user should derive (or typedef) and parametrize the {{{Visitable}}}, {{{Tool}}} and {{{Applicable}}} templates, typically into a new namespace. An example can be seen in {{{proc/mobject/builder/buildertool.hpp}}}
    -
    +
    Using the ''Visitor Design Pattern'' is somewhat controversial, mainly because this pattern is rather complicated, requires certain circumstances to be usefull, and &mdash; especially when used in the original form described by Gamma et al &mdash; puts quite some burden on the implementor. Contrary to some patterns commonly used today (like e.g. singleton or factory), visitor is by no way a popular pattern. Ichthyo thinks that until now it's potential stregths remain still to be discovered, due to obvious and well known weaknesses. This problems can be ameliorated a good deal by using template based library implementation techniques along the lines of the [[Loki library|http://loki-lib.sourceforge.net/]].
 &rarr; [[implementation deatails|VisitingToolImpl]]
 
 !why bothering with visitor?
 In the Lumiera Proc layer, Ichthyo uses the visitor pattern to overcome another notorious problem when dealing with more complex class hierarchies: either, the //interface// (root class) is so unspecific to be almost useless, or, in spite of having a useful contract, this contract will effectively be broken by some subclasses ("problem of elliptical circles"). Initially, when designing the classes, the problems aren't there (obviously, because they could be taken as design flaws). But then, under the pressure of real features, new types are added later on, which //need to be in this hierarchy// and at the same time //need to have this and that special behaviour// and here we go ...
-Visitor helps us to circumvent this trap: the basic operations can be written against the top level interface, such, that they include visiting some object collection internally. Now, on a case-by-case base, local operations can utilize some sub interface or the given concrete type's public interface. So visitor helps to encapsulate cooperating specific technical details within some concrete visiting tool implementation, while forcing them to be implemented against some interface or sub-interface of the target objects.
+Visitor helps us to circumvent this trap: the basic operations can be written against the top level interface, such as to include visiting some object collection internally. Now, on a case-by-case base, local operations can utilise a more specific sub interface or the given concrete type's public interface. So visitor helps to encapsulate specific technical details of cooperating objects within the concrete visiting tool implementation, while still forcing them to be implemented against some interface or sub-interface of the target objects.
 
 !!well suited for using visitors
 generally speaking, visitors are preferable when the underlying element type hierarchy is rather stable, but new operations are to be added frequently.