diff --git a/doc/devel/uml/class128517.html b/doc/devel/uml/class128517.html index f82e4009d..9b18007fc 100644 --- a/doc/devel/uml/class128517.html +++ b/doc/devel/uml/class128517.html @@ -21,6 +21,6 @@
Attribut length

Declaration :

TODO: how to represent time intervals?

-

All public operations : apply

+

All public operations : apply , apply , dispatchOp

diff --git a/doc/devel/uml/class128773.html b/doc/devel/uml/class128773.html index 81c885f5b..4d2eb1713 100644 --- a/doc/devel/uml/class128773.html +++ b/doc/devel/uml/class128773.html @@ -19,6 +19,6 @@

Declaration :

Directly inherited by : Clip Effect Meta

Artifact : abstractmo

-

All public operations : apply

+

All public operations : apply , apply , dispatchOp

diff --git a/doc/devel/uml/class128901.html b/doc/devel/uml/class128901.html index a4c14a225..3258b0d8f 100644 --- a/doc/devel/uml/class128901.html +++ b/doc/devel/uml/class128901.html @@ -22,6 +22,6 @@
Attribut start

Declaration :

startpos in source

Relation source (<unidirectional association>)

Declaration :

the media source this clip referes to

-

All public operations : apply

+

All public operations : apply , apply , dispatchOp

diff --git a/doc/devel/uml/class129029.html b/doc/devel/uml/class129029.html index e6ec7aa31..f9a14681d 100644 --- a/doc/devel/uml/class129029.html +++ b/doc/devel/uml/class129029.html @@ -20,6 +20,6 @@
Attribut plugID

Declaration :

Identifier of the Plugin to be used

-

All public operations : apply

+

All public operations : apply , apply , dispatchOp

diff --git a/doc/devel/uml/class129157.html b/doc/devel/uml/class129157.html index b29f58556..fb8effd05 100644 --- a/doc/devel/uml/class129157.html +++ b/doc/devel/uml/class129157.html @@ -19,6 +19,6 @@

Declaration :

Directly inherited by : Auto Label

Artifact : meta

-

All public operations : apply

+

All public operations : apply , apply , dispatchOp

diff --git a/doc/devel/uml/class129669.html b/doc/devel/uml/class129669.html index 832aed5e2..8653baa45 100644 --- a/doc/devel/uml/class129669.html +++ b/doc/devel/uml/class129669.html @@ -18,6 +18,6 @@

Declaration :

Artifact : label

-

All public operations : apply

+

All public operations : apply , apply , dispatchOp

diff --git a/doc/devel/uml/class129925.html b/doc/devel/uml/class129925.html index ee1a92f29..3052beb5b 100644 --- a/doc/devel/uml/class129925.html +++ b/doc/devel/uml/class129925.html @@ -19,6 +19,6 @@

Declaration :

Automation data for some parameter (i.e. a time varying function)

Artifact : auto

Operation getValue

Declaration :

-

All public operations : apply , getValue , getValue

+

All public operations : apply , apply , dispatchOp , getValue , getValue

diff --git a/doc/devel/uml/class130693.html b/doc/devel/uml/class130693.html index aaf7fd304..a40a37ad4 100644 --- a/doc/devel/uml/class130693.html +++ b/doc/devel/uml/class130693.html @@ -18,7 +18,7 @@

Declaration :

Artifact : toolfactory

-
Operation configure

Declaration :

+
Operation configure

Declaration :

All public operations : configure

diff --git a/doc/devel/uml/class134021.html b/doc/devel/uml/class134021.html index 0f4c8e720..01a81da6f 100644 --- a/doc/devel/uml/class134021.html +++ b/doc/devel/uml/class134021.html @@ -16,10 +16,10 @@ -

Declaration :

Directly inherited by : MObject

+

Declaration :

Directly inherited by : MObject

Artifact : buildable

-
Operation apply

Declaration :

-

All public operations : apply

+
Operation apply

Declaration :

+

All public operations : apply , apply , dispatchOp

diff --git a/doc/devel/uml/class134149.html b/doc/devel/uml/class134149.html index d405b1b3f..ec9c026f4 100644 --- a/doc/devel/uml/class134149.html +++ b/doc/devel/uml/class134149.html @@ -4,22 +4,22 @@ -Class Tool +Class BuilderTool -
Class Tool
+
Class BuilderTool

-

Declaration :

Directly inherited by : NodeCreatorTool SegmentationTool

-

Used according to the visitor pattern: each Tool contains the concrete implementation for one task to be done to the various MObject classes

Artifact : tool

+

Declaration :

Directly inherited by : NodeCreatorTool SegmentationTool

+

Used according to the visitor pattern: each Tool contains the concrete implementation for one task to be done to the various MObject classes

Artifact : buildertool

-
Operation treat

Declaration :

This operation is to be overloaded for the specific MObject subclasses to be treated.

-

All public operations : treat

+
Operation treat

Declaration :

This operation is to be overloaded for the specific MObject subclasses to be treated.

+

All public operations : treat , treat

diff --git a/doc/devel/uml/class134277.html b/doc/devel/uml/class134277.html index ca5d2bff7..6c87e8635 100644 --- a/doc/devel/uml/class134277.html +++ b/doc/devel/uml/class134277.html @@ -16,12 +16,12 @@ -

Declaration :

Tool implementation for deriving a partitioning of the current timeline such, that each segement has a constant configuration. "Constant" means here, that any remaining changes over time can be represented by automation solely, without the need to change the node connections.

Artifact : segmentationtool

+

Declaration :

Tool implementation for deriving a partitioning of the current timeline such, that each segement has a constant configuration. "Constant" means here, that any remaining changes over time can be represented by automation solely, without the need to change the node connections.

Artifact : segmentationtool

Operation treat

Declaration :

Operation treat

Declaration :

Operation treat

Declaration :

Relation segments (<directional aggregation by value>)

Declaration :

the partitioning of the Timeline to be created by this tool.

-

All public operations : treat , treat , treat , treat

+

All public operations : treat , treat , treat , treat , treat

diff --git a/doc/devel/uml/class134405.html b/doc/devel/uml/class134405.html index 3233a3151..8030835d6 100644 --- a/doc/devel/uml/class134405.html +++ b/doc/devel/uml/class134405.html @@ -16,7 +16,7 @@ -

Declaration :

This 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.

Artifact : nodecreatertool

+

Declaration :

This 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.

Artifact : nodecreatertool

Operation treat

Declaration :

  • Uml : + treat(inout something : Buildable) : void
  • C++ : public: void treat (Buildable& something)
Operation treat

Declaration :

  • Uml : + treat(inout clip : Clip) : void
  • C++ : public: void treat (Clip& clip)
@@ -24,6 +24,6 @@
Operation treat

Declaration :

  • Uml : + treat(inout auto : Auto) : void
  • C++ : public: void treat (Auto& auto)
Attribut proc

Declaration :

holds the Processor (Render Engine Element) to be built by the current build step

-

All public operations : treat , treat , treat , treat , treat

+

All public operations : treat , treat , treat , treat , treat , treat

diff --git a/doc/devel/uml/class138629.html b/doc/devel/uml/class138629.html index 9bc8209f7..83cab8165 100644 --- a/doc/devel/uml/class138629.html +++ b/doc/devel/uml/class138629.html @@ -19,6 +19,6 @@

Declaration :

Clip MObject which is actually a compound of several elementary clips,
e.g. the several streams found within multichannels media.

Artifact : compoundclip, Diagram : Session structure

Relation components (<directional aggregation>)

Declaration :

  • Uml : # components : Clip, multiplicity : 1..*
  • C++ : protected: Clip* components
-

All public operations : apply

+

All public operations : apply , apply , dispatchOp

diff --git a/doc/devel/uml/class138885.html b/doc/devel/uml/class138885.html index 987c50371..ce532c0e7 100644 --- a/doc/devel/uml/class138885.html +++ b/doc/devel/uml/class138885.html @@ -18,6 +18,6 @@

Declaration :

Elementary clip consisting of only one media stream

Artifact : simpleclip

-

All public operations : apply

+

All public operations : apply , apply , dispatchOp

diff --git a/doc/devel/uml/class140037.html b/doc/devel/uml/class140037.html new file mode 100644 index 000000000..78d699a6c --- /dev/null +++ b/doc/devel/uml/class140037.html @@ -0,0 +1,24 @@ + + + + + + +Class Tool + + + + + +
Class Tool
+

+ + + + +

Declaration :

Directly inherited by : BuilderTool

+

Artifact : visitor

+ +
Operation ~Tool

Declaration :

  • Uml : + ~Tool() :
  • C++ : public: virtual ~Tool ()
+ + diff --git a/doc/devel/uml/class140165.html b/doc/devel/uml/class140165.html new file mode 100644 index 000000000..d6e4f6a5e --- /dev/null +++ b/doc/devel/uml/class140165.html @@ -0,0 +1,27 @@ + + + + + + +Class Visitable + + + + + +
Class Visitable
+

+ + + + +

Declaration :

Directly inherited by : Buildable

+

Artifact : visitor

+ +
Operation ~Visitable

Declaration :

  • Uml : # ~Visitable() :
  • C++ : protected: virtual ~Visitable ()
+
Operation apply

Declaration :

  • Uml : abstract, + apply(inout providedTool : Tool) : void
  • C++ : public: virtual void apply (Tool& providedTool) = 0
+
Operation dispatchOp

Declaration :

  • Uml : static, + dispatchOp(inout target : TAR, inout t : Tool) : void
  • C++ : public: static void dispatchOp (TAR& target, Tool& t)
+

All public operations : apply , dispatchOp

+ + diff --git a/doc/devel/uml/class140293.html b/doc/devel/uml/class140293.html new file mode 100644 index 000000000..2c824ca50 --- /dev/null +++ b/doc/devel/uml/class140293.html @@ -0,0 +1,25 @@ + + + + + + +Class Applicable + + + + + +
Class Applicable
+

+ + + + +

Declaration :

Directly inherited by : BuilderTool NodeCreatorTool SegmentationTool

+

Artifact : visitor

+ +
Operation treat

Declaration :

  • Uml : abstract, + treat(inout visitable : TAR) :
  • C++ : public: virtual treat (TAR& visitable) = 0
+

All public operations : treat

+ + diff --git a/doc/devel/uml/classes.html b/doc/devel/uml/classes.html index a93cd61e0..a411e8c2e 100644 --- a/doc/devel/uml/classes.html +++ b/doc/devel/uml/classes.html @@ -20,6 +20,7 @@ AFrame Allocationa directive to place a MObject in a specific way AppconfigsingletonSingleton to hold inevitable global flags and constants and for performing erarly (static) global initialization tasks. +Applicable ARenderRepresentation of a Audio render process AssemblerThis is the actual building facility: provided the correct tools and associations, it serves to build and connect the individual ProcNode objects AssetinterfaceSuperinterface describing especially the bookeeping properties of Assets @@ -27,6 +28,7 @@ AutoAutomation data for some parameter (i.e. a time varying function) Buildableinterface BuilderFacadeboundaryProvides unified access to the builder functionality. While individual components of the builder subsystem may be called if necessary or suitable, it is usually better to do all extern invocations via the high level methods of this Facade +BuilderToolinterfaceUsed according to the visitor pattern: each Tool contains the concrete implementation for one task to be done to the various MObject classes BuildInstruct(Interface) building instructions to be executed by the Builder on the render node network under construction. Categorytree like classification of Assets Clipbookkeeping (asset) view of a media clip. @@ -118,13 +120,14 @@ Structkey abstraction: structural asset 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 -ToolinterfaceUsed according to the visitor pattern: each Tool contains the concrete implementation for one task to be done to the various MObject classes +Tool ToolFactory Trackstructural asset holding the configuration of a track in the EDL Track Trafo Unknownplaceholder for unknown or unavailable media source VFrame +Visitable VRenderRepresentation of a Video render process. (Encapsulates the video buffers for the actual calculations) Wish WriteBuffer diff --git a/doc/devel/uml/classes_list.html b/doc/devel/uml/classes_list.html index d5c17b7d5..b91453124 100644 --- a/doc/devel/uml/classes_list.html +++ b/doc/devel/uml/classes_list.html @@ -21,6 +21,7 @@ AFrame
Allocation
Appconfig
+Applicable
ARender
Assembler
Asset
@@ -28,6 +29,7 @@ Auto
Buildable
BuilderFacade
+BuilderTool
BuildInstruct
Category
Clip
@@ -119,13 +121,14 @@ Struct
Thread
Time
-Tool
+Tool
ToolFactory
Track
Track
Trafo
Unknown
VFrame
+Visitable
VRender
Wish
WriteBuffer
diff --git a/doc/devel/uml/fig129285.png b/doc/devel/uml/fig129285.png index 248d56153..20e099fca 100644 Binary files a/doc/devel/uml/fig129285.png and b/doc/devel/uml/fig129285.png differ diff --git a/doc/devel/uml/index.html b/doc/devel/uml/index.html index 7cd9d2895..888b6b49c 100644 --- a/doc/devel/uml/index.html +++ b/doc/devel/uml/index.html @@ -112,7 +112,7 @@ Documentation
Artifact Cinelerra3

Depends on common

Depends on gui

Depends on proc

Depends on backend

the main executable to be built

-

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

+

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

Artifact main

Artifact source

@@ -128,6 +128,10 @@ Documentation

1.3.2.1 Deployment View gen

defines source files to be generated by BOUML

+ +
Artifact visitor
+

Acyclic Visitor library

+

Artifact source associated with : Visitable, Tool, Applicable

Artifact error

Cinelerra Exception Interface

@@ -146,7 +150,12 @@ Documentation

  • C++ namespace : cinelerra::error
-

Namespace for Exception Kinds

+

Namespace for Exception Kinds

+

1.3.2.3 Package visitor

+

+

sub-namespace for visitor library implementation

1.3.3 Package backend

@@ -1132,6 +1141,9 @@ reuse exiting Engine

Selection :

Transformation

5.2 Class View Service Components

+
Class Applicable
+
Class Tool
+
Class Visitable
Class Time
Class Factory
Class Appconfig
diff --git a/doc/devel/uml/index_126.html b/doc/devel/uml/index_126.html new file mode 100644 index 000000000..24ae2f606 --- /dev/null +++ b/doc/devel/uml/index_126.html @@ -0,0 +1,24 @@ + + + + + + +~ + + + + + +
~
+

+ + + + + + + +
NameKindDescription
~Tooloperation
~Visitableoperation
+ + diff --git a/doc/devel/uml/index_60.html b/doc/devel/uml/index_60.html index 0a78be5d0..75ccc147d 100644 --- a/doc/devel/uml/index_60.html +++ b/doc/devel/uml/index_60.html @@ -17,8 +17,8 @@ - + @@ -30,8 +30,8 @@ - + diff --git a/doc/devel/uml/index_65.html b/doc/devel/uml/index_65.html index 5984e789e..d570a1c71 100644 --- a/doc/devel/uml/index_65.html +++ b/doc/devel/uml/index_65.html @@ -31,7 +31,9 @@ + + @@ -49,12 +51,12 @@ - + + - diff --git a/doc/devel/uml/index_66.html b/doc/devel/uml/index_66.html index 5ed3d76c4..9158c65e4 100644 --- a/doc/devel/uml/index_66.html +++ b/doc/devel/uml/index_66.html @@ -40,6 +40,8 @@ + + diff --git a/doc/devel/uml/index_67.html b/doc/devel/uml/index_67.html index f3abdcc6c..269befa2c 100644 --- a/doc/devel/uml/index_67.html +++ b/doc/devel/uml/index_67.html @@ -29,34 +29,34 @@ - - - - - + - - - - - - - + + + + - - + + + - + - + + + + + + + diff --git a/doc/devel/uml/index_68.html b/doc/devel/uml/index_68.html index cdeda3e68..68da1dfbd 100644 --- a/doc/devel/uml/index_68.html +++ b/doc/devel/uml/index_68.html @@ -28,10 +28,11 @@ - + +
NameKindDescription
<flow>transition
<flow>transition
<flow>transition
<flow>transition
<flow>transition
<flow>transition
<flow>transition
<flow>transition
<flow>transition
<flow>transition
<flow>transition
<flow>transition
<flow>transition
<flow>transition
<flow>transition
Appconfigoperationperform initialization on first access.
A call is placed in static initialization code
included in cinelerra.h; thus it will happen
ubiquitous very early.
appconfigartifactfor global initialization and configuration
AppconfigclassSingleton to hold inevitable global flags and constants and for performing erarly (static) global initialization tasks.
Applicableclass
applyoperation
applyoperation
Architecturecomponent viewThe various Components comprising the Cinelerra3 Video editing Application
ARenderclassRepresentation of a Audio render process
arenderartifactRepresentation of a Audio Render process
Assetsclass view
ATTACHattributeattach subject to anchor (e.g. an effect to a clip)
au1class instance
aud_aclass instance
aud_Aclass instance
aud_aclass instance
audioclass instance
audio1class instance
audio1class instance
audio1class instance
audio1class instance
autoartifactMedia Object holding automation data
AutoclassAutomation data for some parameter (i.e. a time varying function)
Automation Entitiesclass diagram
Builder Workingsclass view
BuilderFacadeclassProvides unified access to the builder functionality. While individual components of the builder subsystem may be called if necessary or suitable, it is usually better to do all extern invocations via the high level methods of this Facade
builderfacadeartifactFacade and service access point for the Builder Subsystem
BuilderToolclassUsed according to the visitor pattern: each Tool contains the concrete implementation for one task to be done to the various MObject classes
buildertoolartifactInterface, any tool for processing MObjects
building the Engineactivity
BuildInstructclass(Interface) building instructions to be executed by the Builder on the render node network under construction.
buildinstructartifactInstructions for building some configuration of render nodes.
checked_outrelationthis list keeps all mappings which are in use, and thus prevents them from Cache aging
Cinelerra3artifactthe main executable to be built
cinelerra3package
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.
Clipclassbookkeeping (asset) view of a media clip.
clipartifactbookkeeping (asset) view of a media clip.
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 Paramsexpansion region
determine Render Paramsopaque activity action
determine Render Paramsexpansion region
devnullclass instance
Dispatchercomponent
dispatchOpoperation
DoAttachclass
DoRecurseclass
diff --git a/doc/devel/uml/index_79.html b/doc/devel/uml/index_79.html index 4902abfdc..9ba074764 100644 --- a/doc/devel/uml/index_79.html +++ b/doc/devel/uml/index_79.html @@ -19,9 +19,9 @@ NameKindDescription offsetattributeOffset the actual position by this (time) value relative to the anchor point. TODO: Representation? orgattributeorigin 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 cinelerra-3 codebase is "cin3". +ouputclass instance ouputclass instance ouputclass instance -ouputclass instance OutPortclassstructural asset corresponding to some port generating media output outportartifactstructural asset corresponding to some port generating media output outputrelation diff --git a/doc/devel/uml/index_82.html b/doc/devel/uml/index_82.html index 3a3a83808..a76e8f590 100644 --- a/doc/devel/uml/index_82.html +++ b/doc/devel/uml/index_82.html @@ -22,8 +22,8 @@ registryrelation@internal Table or DB holding all registered asset instances. relativelocationartifactPlacement implemnetaion providing various ways of attaching a MObject to another one RelativeLocationclass -RelTypeclassthe possible kinds of RelativePlacements relTypeattributethe kind of relation denoted by this Placement +RelTypeclassthe possible kinds of RelativePlacements removeoperationremove the given asset <i>together with all its dependants</i> from the internal DB Render Entitiesclass diagram Render Requestactivity parameter diff --git a/doc/devel/uml/index_83.html b/doc/devel/uml/index_83.html index 5c1a18530..eb3719cf0 100644 --- a/doc/devel/uml/index_83.html +++ b/doc/devel/uml/index_83.html @@ -31,8 +31,8 @@ Service Componentsclass view Sessioncomponent sessionartifactInterface: the session edited by the user -sessionpackagesourcecode package

Everything concerning the EDL and Session, within the MObject Subsystem Sessionclass view +sessionpackagesourcecode package

Everything concerning the EDL and Session, within the MObject Subsystem 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 @@ -46,8 +46,8 @@ 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 diff --git a/doc/devel/uml/index_84.html b/doc/devel/uml/index_84.html index 686d34aef..00c40c769 100644 --- a/doc/devel/uml/index_84.html +++ b/doc/devel/uml/index_84.html @@ -25,9 +25,8 @@ Timeclassdenotes a temporal position (time point), based on timeline start.

investigate posix.4 realtime timers, wrap these here timelinenode timelinerelation -ToolclassUsed according to the visitor pattern: each Tool contains the concrete implementation for one task to be done to the various MObject classes toolpackagesourcecode package

Tools and Utilities
(separate from the main cinelrra binary) -toolartifactInterface, any tool for processing MObjects +Toolclass ToolFactoryclass toolfactoryartifactsupply of Tool implementations for the Builder Trackclassstructural asset holding the configuration of a track in the EDL @@ -40,14 +39,15 @@ tracksrelation Trafoclass trafoartifacttransforming processing Node -treatoperation -treatoperation +treatoperation +treatoperationThis operation is to be overloaded for the specific MObject subclasses to be treated. treatoperation treatoperation -treatoperation +treatoperation +treatoperation treatoperation treatoperation -treatoperationThis operation is to be overloaded for the specific MObject subclasses to be treated. +treatoperation diff --git a/doc/devel/uml/index_86.html b/doc/devel/uml/index_86.html index ce992fef4..8695a80a4 100644 --- a/doc/devel/uml/index_86.html +++ b/doc/devel/uml/index_86.html @@ -20,23 +20,26 @@ versionattributeversion 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. VFrameclass vframeartifacta buffer and render process holding a Video frame -vid1class instance vid1class instance -vid_Aclass instance -vid_Aclass instance +vid1class instance vid_aclass instance -vid_Aclass instance +vid_Aclass instance vid_aclass instance +vid_Aclass instance +vid_Aclass instance videoclass instance -videoclass instance videoclass instance +videoclass instance videoclass instance -video1class instance -video1class instance -video1class instance -video1class instance video1class instance video1class instance +video1class instance +video1class instance +video1class instance +video1class instance +Visitableclass +visitorpackagesub-namespace for visitor library implementation +visitorartifactAcyclic Visitor library VRenderclassRepresentation of a Video render process. (Encapsulates the video buffers for the actual calculations) vrenderartifactRepresentation of a Video render process diff --git a/doc/devel/uml/navig.html b/doc/devel/uml/navig.html index 1d6f86b34..facf4a06c 100644 --- a/doc/devel/uml/navig.html +++ b/doc/devel/uml/navig.html @@ -12,6 +12,6 @@

-Top- -Classes- -Public Operations- -Public properties- -Packages- -Use Cases- -Activities- -Class Diagrams- -Object Diagrams- -Activity Diagrams- -Use Case Diagrams- -Collaboration Diagrams- -Component Diagrams- -Deployment Diagrams-

-

< A B C D E F G H I K L M N O P R S T U V W

+

< A B C D E F G H I K L M N O P R S T U V W ~

diff --git a/doc/devel/uml/packages.html b/doc/devel/uml/packages.html index 0a87e3bd1..aac0bc389 100644 --- a/doc/devel/uml/packages.html +++ b/doc/devel/uml/packages.html @@ -20,8 +20,8 @@ Asset backendsrcsourcecode package

Data backend classes here... BackendLayer -Builder buildersrcsourcecode package

The Builder creating the Render Engine,
located within the MObject Subsystem +Builder cinelerra3 codegenThis package is used to organize code generation by BOUML. It is considered useless after having generated the initial code skeleton. commonsrcsourcecode package

Common library and helper classes @@ -41,6 +41,7 @@ RenderEngine sessionsrcsourcecode package

Everything concerning the EDL and Session, within the MObject Subsystem toolsrcsourcecode package

Tools and Utilities
(separate from the main cinelrra binary) +visitorsub-namespace for visitor library implementation diff --git a/doc/devel/uml/public_operations.html b/doc/devel/uml/public_operations.html index 745c339b7..d0aedd4c7 100644 --- a/doc/devel/uml/public_operations.html +++ b/doc/devel/uml/public_operations.html @@ -18,6 +18,7 @@ + @@ -26,6 +27,7 @@ + @@ -52,18 +54,20 @@ - - + + - + + + - +
OperationClassDescription
applyBuildable
applyVisitable
buildAssembler
buildEngineBuilderFacadeMain Operation of the Builder: create a render engine for a given part of the timeline
buildProcessorPathManager
configureToolFactory
createClipMediacreate a (possibly compound) Clip refering to this media, ready to be added to the EDL.
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
getAppconfigaccess the configuation value for a given key.
@return empty string for unknown keys, else the corresponding configuration value
get_reprAllocation
resolvePlacementcreate an actual (explicit) placement while trying to satisfy the network of adjacent objects and placements.
rootCauseErrorIf this exception was caused by a chain of further exceptions,
return the first one registered in this throw sequence.
This works only, if every exceptions thrown as a consequence
of another exception is propperly constructed by passing
the original exception to the constructor
saveSessManagercreate a complete, serialized representation
of the current session config and contents.
@todo how to serialize, prameters, return value?
treatNodeCreatorTool
treatNodeCreatorTool
treatApplicable
treatBuilderToolThis operation is to be overloaded for the specific MObject subclasses to be treated.
treatNodeCreatorTool
treatNodeCreatorTool
treatSegmentationTool
treatNodeCreatorTool
treatNodeCreatorTool
treatSegmentationTool
treatSegmentationTool
treatSegmentationTool
treatToolThis operation is to be overloaded for the specific MObject subclasses to be treated.
useFileFileProviderAnnounces that the application intends to use this file with mode (READ|WRITE|READWRITE)
useTemporaryStorageFileProviderProvides a pool for interminate frames
whatError
whatstd::exceptionthe base class of all exceptions thrown by the standard library
~ToolTool
diff --git a/src/common/visitor.cpp b/src/common/visitor.cpp new file mode 100644 index 000000000..4903b6d5d --- /dev/null +++ b/src/common/visitor.cpp @@ -0,0 +1,35 @@ +/* + Vistitable,Tool,Applicable - Acyclic Visitor library + + Copyright (C) CinelerraCV + 2007, Hermann Vosseler + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License as + published by the Free Software Foundation; either version 2 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +* *****************************************************/ + + +#include "common/visitor.hpp" + +namespace cinelerra + { + namespace visitor + { + + + + } // namespace visitor + +} // namespace cinelerra diff --git a/src/common/visitor.hpp b/src/common/visitor.hpp new file mode 100644 index 000000000..b3323bc8a --- /dev/null +++ b/src/common/visitor.hpp @@ -0,0 +1,121 @@ +/* + VISITOR.hpp - Acyclic Visitor library + + Copyright (C) CinelerraCV + 2007, Hermann Vosseler + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License as + published by the Free Software Foundation; either version 2 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +==================================================================== +This code is heavily inspired by + The Loki Library (loki-lib/trunk/include/loki/Visitor.h) + Copyright (c) 2001 by Andrei Alexandrescu + This Loki code accompanies the book: + Alexandrescu, Andrei. "Modern C++ Design: Generic Programming + and Design Patterns Applied". + Copyright (c) 2001. Addison-Wesley. ISBN 0201704315 + +*/ + + + +#ifndef CINELERRA_VISITOR_H +#define CINELERRA_VISITOR_H + + + +namespace cinelerra + { + namespace visitor + { + + + /** Marker interface / base class for all "visiting tools". + * When applying such a tool to some concrete instance + * derived from Visitable, a special function treating + * this concrete subclass can be selected on the visiting + * tool instance. + */ + class Tool + { + public: + virtual ~Tool () { }; ///< use RTTI for all visiting tools + }; + + + + /** mixin template to declare that some "visiting tool" + * wants to treat a concrete subclass of Visitable + */ + template + < class TAR, + typename RET = void + > + class Applicable + { + public: + typedef RET ReturnType; + + /** to be implemented by concrete tools + * wanting to visit type TAR */ + virtual RET treat (TAR& visitable) = 0; + }; + + + + /** Marker interface / base class for all types + * to be treated by a "visiting tool" or visitor. + */ + template + class Visitable + { + public: + typedef RET ReturnType; + + protected: + virtual ~Visitable () { }; + + /** @internal used by the DEFINE_VISITABLE macro. + * Dispatches to the actual operation on the + * "visiting tool" (acyclic visitor implementation) + */ + template + static RET dispatchOp(TAR& target, Tool& tool) + { + if (Applicable* concreteTool + = dynamic_cast*> (&tool)) + + return concreteTool->treat (target); + + else + return ReturnType(); + } + }; + + +/** mark a Visitable subclass as actually treatable + * by some "visiting tool". Defines the apply-function, + * which is the actual access point to invoke the visiting + */ +#define DEFINE_VISITABLE() \ + virtual ReturnType apply (Tool& tool) \ + { return dispatchOp (*this, tool); } + + + + } // namespace visitor + +} // namespace cinelerra +#endif diff --git a/src/proc/mobject/buildable.cpp b/src/proc/mobject/buildable.cpp index 9f11ef017..e37e9f7d0 100644 --- a/src/proc/mobject/buildable.cpp +++ b/src/proc/mobject/buildable.cpp @@ -22,7 +22,7 @@ #include "proc/mobject/buildable.hpp" -#include "proc/mobject/builder/tool.hpp" +#include "proc/mobject/builder/buildertool.hpp" namespace mobject { @@ -32,10 +32,10 @@ namespace mobject * contain overloaded fuctions for treating * different Buildable subclasses specifically */ - void - Buildable::apply (builder::Tool& provided_tool) + Buildable::ReturnType + Buildable::apply (builder::BuilderTool& tool) { - provided_tool.treat( *this); //// TODO: how to call??? (ref or pointer??) + return dispatchOp (*this, tool); } diff --git a/src/proc/mobject/buildable.hpp b/src/proc/mobject/buildable.hpp index 17c6ad0ff..4e8d4df6c 100644 --- a/src/proc/mobject/buildable.hpp +++ b/src/proc/mobject/buildable.hpp @@ -25,24 +25,34 @@ #define MOBJECT_BUILDABLE_H +#include "common/visitor.hpp" + namespace mobject { - namespace builder{ class Tool; } + namespace builder{ class BuilderTool; } + using cinelerra::visitor::Visitable; + /** * All Buidables support double-dispatch of given Tool operations. * The actual operation is thus selected at runtime based both on the * actual type of the Tool class /and/ the actual type of the Buildabele. */ - class Buildable + class Buildable : public Visitable<> { public: - void apply (builder::Tool& provided_tool) ; + /** Catch-all implementation for applying any builder tool + * to some (uspecified) buildable object. Typically the provided + * actual Tool class will contain overloaded fuctions for treating + * different Buildable subclasses specifically and the concrete Buildables + * will define explicitly to be specifically visitable. + */ + virtual ReturnType apply (builder::BuilderTool&); }; diff --git a/src/proc/mobject/builder/tool.cpp b/src/proc/mobject/builder/buildertool.cpp similarity index 89% rename from src/proc/mobject/builder/tool.cpp rename to src/proc/mobject/builder/buildertool.cpp index 2afbfd2f4..a5d91c6b0 100644 --- a/src/proc/mobject/builder/tool.cpp +++ b/src/proc/mobject/builder/buildertool.cpp @@ -1,5 +1,5 @@ /* - Tool - Interface, any tool for processing MObjects + BuilderTool - Interface, (visiting) tool for processing MObjects Copyright (C) CinelerraCV 2007, Hermann Vosseler @@ -21,7 +21,7 @@ * *****************************************************/ -#include "proc/mobject/builder/tool.hpp" +#include "proc/mobject/builder/buildertool.hpp" namespace mobject diff --git a/src/proc/mobject/builder/tool.hpp b/src/proc/mobject/builder/buildertool.hpp similarity index 88% rename from src/proc/mobject/builder/tool.hpp rename to src/proc/mobject/builder/buildertool.hpp index 0d158c2fb..330a4a8da 100644 --- a/src/proc/mobject/builder/tool.hpp +++ b/src/proc/mobject/builder/buildertool.hpp @@ -1,5 +1,5 @@ /* - TOOL.hpp - Interface, any tool for processing MObjects + BUILDERTOOL.hpp - Interface, (visiting) tool for processing MObjects Copyright (C) CinelerraCV 2007, Hermann Vosseler @@ -24,6 +24,7 @@ #ifndef MOBJECT_BUILDER_TOOL_H #define MOBJECT_BUILDER_TOOL_H +#include "common/visitor.hpp" #include "proc/mobject/buildable.hpp" @@ -32,13 +33,15 @@ namespace mobject { namespace builder { + + using cinelerra::visitor::Tool; /** * Used according to the visitor pattern: each Tool contains * the concrete implementation for one task to be done to the various MObject classes */ - class Tool + class BuilderTool : public Tool { protected: typedef mobject::Buildable Buildable; diff --git a/src/proc/mobject/builder/nodecreatertool.hpp b/src/proc/mobject/builder/nodecreatertool.hpp index b4aa19297..59e5cc831 100644 --- a/src/proc/mobject/builder/nodecreatertool.hpp +++ b/src/proc/mobject/builder/nodecreatertool.hpp @@ -24,7 +24,7 @@ #ifndef MOBJECT_BUILDER_NODECREATERTOOL_H #define MOBJECT_BUILDER_NODECREATERTOOL_H -#include "proc/mobject/builder/tool.hpp" +#include "proc/mobject/builder/buildertool.hpp" #include "proc/mobject/buildable.hpp" #include "proc/engine/processor.hpp" @@ -53,8 +53,11 @@ namespace mobject * render engine under construction such as to reflect the properties * of the MObject in the actual render. */ - class NodeCreatorTool : public Tool + class NodeCreatorTool : public BuilderTool { + + //////////////////////////////////////////////TODO: switch to acyclic visitior!!!!!!!!!!!!! + public: virtual void treat (mobject::session::Clip& clip) ; virtual void treat (mobject::session::Effect& effect) ; diff --git a/src/proc/mobject/builder/segmentationtool.hpp b/src/proc/mobject/builder/segmentationtool.hpp index 0a58276ef..7ed4f65f2 100644 --- a/src/proc/mobject/builder/segmentationtool.hpp +++ b/src/proc/mobject/builder/segmentationtool.hpp @@ -27,7 +27,7 @@ #include #include "proc/mobject/buildable.hpp" -#include "proc/mobject/builder/tool.hpp" +#include "proc/mobject/builder/buildertool.hpp" #include "proc/mobject/session/segment.hpp" using std::list; @@ -54,8 +54,11 @@ namespace mobject * can be represented by automation solely, without the need * to change the node connections. */ - class SegmentationTool : public Tool + class SegmentationTool : public BuilderTool { + + //////////////////////////////////////////////TODO: switch to acyclic visitior!!!!!!!!!!!!! + public: void treat (mobject::session::Clip& clip) ; void treat (mobject::session::Effect& effect) ; diff --git a/src/proc/mobject/builder/toolfactory.cpp b/src/proc/mobject/builder/toolfactory.cpp index 6601162e3..456ee568b 100644 --- a/src/proc/mobject/builder/toolfactory.cpp +++ b/src/proc/mobject/builder/toolfactory.cpp @@ -30,7 +30,7 @@ namespace mobject - Tool & + BuilderTool & ToolFactory::configure () { } diff --git a/src/proc/mobject/builder/toolfactory.hpp b/src/proc/mobject/builder/toolfactory.hpp index 65b1a1eb2..d39b0e7c7 100644 --- a/src/proc/mobject/builder/toolfactory.hpp +++ b/src/proc/mobject/builder/toolfactory.hpp @@ -24,7 +24,7 @@ #ifndef MOBJECT_BUILDER_TOOLFACTORY_H #define MOBJECT_BUILDER_TOOLFACTORY_H -#include "proc/mobject/builder/tool.hpp" +#include "proc/mobject/builder/buildertool.hpp" @@ -37,7 +37,7 @@ namespace mobject class ToolFactory { public: - Tool & configure () ; + BuilderTool & configure () ; }; diff --git a/tests/50components.tests b/tests/50components.tests index 7435f21b0..10de4c7b4 100644 --- a/tests/50components.tests +++ b/tests/50components.tests @@ -182,3 +182,7 @@ out: --> remaining=SingleTestID spam --eggs END +PLANNED "VisitingTool_test" VisitingTool_test < + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License as + published by the Free Software Foundation; either version 2 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +* *****************************************************/ + + +#include "common/test/run.hpp" +#include "common/visitor.hpp" +//#include "common/factory.hpp" +//#include "common/util.hpp" + +//#include +#include + +//using boost::format; +using std::string; +using std::cout; + + +namespace mobject + { + namespace builder + { + namespace test + { + + + + + /************************************************************************* + * @test our lib implementation of the acyclic visitor pattern. + * Defines a hierarchy of test classes to check the following cases + *
  • calling the correct visiting tool specialized function + * for given concrete hierarchy classes
    • + *
  • visiting tool not declaring to visit some class
    • + *
  • newly added class causes the catch-all to be invoked + * when visited by known visitor
    • + *
+ */ + class VisitingTool_test : public Test + { + virtual void run(Arg arg) + { + UNIMPLEMENTED ("testing the generic visitor pattern"); + known_visitor_known_class(); + visitor_not_visiting_some_class(); + visitor_treating_new_subclass(); + } + + void known_visitor_known_class() + { + UNIMPLEMENTED ("testing the generic visitor pattern"); + } + + void visitor_not_visiting_some_class() + { + UNIMPLEMENTED ("testing the generic visitor pattern"); + } + + void visitor_treating_new_subclass() + { + UNIMPLEMENTED ("testing the generic visitor pattern"); + } + }; + + + /** Register this test class... */ + LAUNCHER (VisitingTool_test, "unit common"); + + + + } // namespace test + + } // namespace builder + +} // namespace mobject diff --git a/tests/components/proc/mobject/builder/buildertooltest.cpp b/tests/components/proc/mobject/builder/buildertooltest.cpp new file mode 100644 index 000000000..6e277441a --- /dev/null +++ b/tests/components/proc/mobject/builder/buildertooltest.cpp @@ -0,0 +1,73 @@ +/* + BuilderTool(Test) - specialized form of the acyclic visitor + + Copyright (C) CinelerraCV + 2007, Hermann Vosseler + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License as + published by the Free Software Foundation; either version 2 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +* *****************************************************/ + + +#include "common/test/run.hpp" +#include "proc/mobject/builder/buildertool.hpp" +//#include "common/factory.hpp" +//#include "common/util.hpp" + +//#include +#include + +//using boost::format; +using std::string; +using std::cout; + + +namespace mobject + { + namespace builder + { + namespace test + { + + + + + /******************************************************************* + * @test the generic visitor pattern specialized for treating + * MObjects in the builder. Because the generic visitor + * implementation is already covered by + * \link VisitingTool_test, it is sufficient to test + * the specialisation to the builder + * @todo work out what this means haha.... + */ + class BuilderTool_test : public Test + { + virtual void run(Arg arg) + { + UNIMPLEMENTED ("testing the visitor pattern for the builder"); + } + }; + + + /** Register this test class... */ + LAUNCHER (BuilderTool_test, "unit builder"); + + + + } // namespace test + + } // namespace builder + +} // namespace mobject diff --git a/uml/cinelerra3/128517 b/uml/cinelerra3/128517 index 60ea7208b..6a6b8ee00 100644 --- a/uml/cinelerra3/128517 +++ b/uml/cinelerra3/128517 @@ -1,6 +1,6 @@ format 40 "CommonLib" // CommonLib - revision 9 + revision 11 modified_by 5 "hiv" // class settings //class diagram settings @@ -253,6 +253,89 @@ ${inlines} 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 + class 140293 "Applicable" + abstract visibility package + nformals 1 + formal name "TAR" type "class" explicit_default_value "" + explicit_extends "" + cpp_decl "${comment}${template}class ${name}${inherit} + { +${members} }; +${inlines} +" + java_decl "" + idl_decl "" + explicit_switch_type "" + + operation 134405 "treat" + abstract cpp_virtual public explicit_return_type "" + nparams 1 + param inout name "visitable" explicit_type "TAR" + cpp_decl " ${comment}${friend}${static}${inline}${virtual}${type} ${name} ${(}${t0}& ${p0}${)}${const}${volatile} ${throw}${abstract};" + + + end + end + + class 140037 "Tool" + visibility package + cpp_decl "${comment}${template}class ${name}${inherit} + { +${members} }; +${inlines} +" + java_decl "" + idl_decl "" + explicit_switch_type "" + + operation 134533 "~Tool" + cpp_virtual public explicit_return_type "" + nparams 0 + cpp_decl " ${comment}${inline}${virtual}${name} ${(}${)}${volatile} ${throw} { };" + + + end + end + + class 140165 "Visitable" + abstract visibility package + cpp_decl "${comment}${template}class ${name}${inherit} + { +${members} }; +${inlines} +" + java_decl "" + idl_decl "" + explicit_switch_type "" + + operation 134661 "~Visitable" + cpp_virtual protected explicit_return_type "" + nparams 0 + cpp_decl " ${comment}${inline}${virtual}${name} ${(}${)}${volatile} ${throw}{};" + + + end + + operation 134789 "apply" + abstract cpp_virtual public explicit_return_type "void" + nparams 1 + param inout name "providedTool" type class_ref 140037 // Tool + cpp_decl " ${comment}${friend}${static}${inline}${virtual}${type} ${name} ${(}${t0}& ${p0}${)}${const}${volatile} ${throw}${abstract};" + + + end + + operation 134917 "dispatchOp" + class_operation public explicit_return_type "void" + nparams 2 + param inout name "target" explicit_type "TAR" + param inout name "t" type class_ref 140037 // Tool + cpp_decl " ${comment}${friend}${static}${inline}${virtual}${type} ${name} ${(}${t0}& ${p0}, ${t1}& ${p1}${)}${const}${volatile} ${throw}${abstract};" + + + end + end + class 134917 "Time" visibility public cpp_decl "${comment}${template}class ${name}${inherit} diff --git a/uml/cinelerra3/128901 b/uml/cinelerra3/128901 index c3a70f751..e4d919380 100644 --- a/uml/cinelerra3/128901 +++ b/uml/cinelerra3/128901 @@ -1,6 +1,6 @@ format 40 "Builder" // ProcessingLayer::MObject::Builder - revision 12 + revision 14 modified_by 5 "hiv" // class settings //class diagram settings @@ -219,7 +219,7 @@ ${inlines} explicit_switch_type "" operation 128773 "configure" - public return_type class_ref 134149 // Tool + public return_type class_ref 134149 // BuilderTool nparams 0 cpp_decl " ${comment}${friend}${static}${inline}${virtual}${type} ${name} ${(}${)}${const}${volatile} ${throw}${abstract};" cpp_def "${comment}${inline}${type} @@ -238,7 +238,7 @@ ${class}::${name} ${(}${)}${const}${volatile} ${throw}${staticnl} a package cpp default "#include in source" classrelation_ref 137221 // - b multiplicity "" parent class_ref 134149 // Tool + b multiplicity "" parent class_ref 134149 // BuilderTool end end @@ -340,24 +340,28 @@ ${members}}; explicit_switch_type "" operation 129669 "apply" - public explicit_return_type "void" + abstract cpp_virtual public explicit_return_type "void" nparams 1 - param inout name "provided_tool" explicit_type "Tool" + param inout name "providedTool" type class_ref 134149 // BuilderTool cpp_decl " ${comment}${friend}${static}${inline}${virtual}${type} ${name} ${(}${t0}& ${p0}${)}${const}${volatile} ${throw}${abstract};" - cpp_def "${comment}${inline}${type} -${class}::${name} ${(}${t0}& ${p0}${)}${const}${volatile} ${throw}${staticnl} -{ - ${body} -} - -" end + + classrelation 146437 // + relation 144261 ---|> + a public + cpp default "${type}" + classrelation_ref 146437 // + b multiplicity "" parent class_ref 140165 // Visitable + end end - class 134149 "Tool" + class 134149 "BuilderTool" abstract visibility public stereotype "interface" + nactuals 1 + actual class class_ref 140293 // Applicable + rank 0 explicit_value "" cpp_decl "${comment}${template}class ${name}${inherit} { ${members} }; @@ -373,25 +377,37 @@ ${members}}; comment "Used according to the visitor pattern: each Tool contains the concrete implementation for one task to be done to the various MObject classes" operation 129797 "treat" - public explicit_return_type "void" + abstract cpp_virtual public explicit_return_type "void" nparams 1 param in name "mElement" type class_ref 134021 // Buildable cpp_decl " ${comment}${friend}${static}${inline}${virtual}${type} ${name} ${(}const ${t0}& ${p0}${)}${const}${volatile} ${throw}${abstract};" - cpp_def "${comment}${inline}${type} -${class}::${name} ${(}const ${t0}& ${p0}${)}${const}${volatile} ${throw}${staticnl} -{ - ${body} -} - -" comment "This operation is to be overloaded for the specific MObject subclasses to be treated." end + + classrelation 146565 // + relation 144389 ---|> + a public + cpp default "${type}" + classrelation_ref 146565 // + b multiplicity "" parent class_ref 140037 // Tool + end + + classrelation 146693 // + relation 144517 ---|> + a public + cpp default "${type}" + classrelation_ref 146693 // + b multiplicity "" parent class_ref 140293 // Applicable + end end class 134277 "SegmentationTool" visibility package + nactuals 1 + actual class class_ref 140293 // Applicable + rank 0 explicit_value "" cpp_decl "${comment}${template}class ${name}${inherit} { ${members} }; @@ -407,7 +423,7 @@ ${inlines} a public cpp default "${type}" classrelation_ref 137605 // - b multiplicity "" parent class_ref 134149 // Tool + b multiplicity "" parent class_ref 134149 // BuilderTool end operation 129925 "treat" @@ -468,10 +484,21 @@ ${class}::${name} ${(}const ${t0}& ${p0}${)}${const}${volatile} ${throw}${static classrelation_ref 139013 // segments () b multiplicity "" parent class_ref 135173 // Segment end + + classrelation 146821 // + relation 144645 ---|> + a public + cpp default "${type}" + classrelation_ref 146821 // + b multiplicity "" parent class_ref 140293 // Applicable + end end class 134405 "NodeCreatorTool" visibility package + nactuals 1 + actual class class_ref 140293 // Applicable + rank 0 explicit_value "" cpp_decl "${comment}${template}class ${name}${inherit} { ${members} }; @@ -487,7 +514,7 @@ ${inlines} a public cpp default "${type}" classrelation_ref 137733 // - b multiplicity "" parent class_ref 134149 // Tool + b multiplicity "" parent class_ref 134149 // BuilderTool end operation 130309 "treat" @@ -562,6 +589,14 @@ ${class}::${name} ${(}${t0}& ${p0}${)}${const}${volatile} ${throw}${staticnl} idl_decl "" comment "holds the Processor (Render Engine Element) to be built by the current build step" end + + classrelation 146949 // + relation 144773 ---|> + a public + cpp default "${type}" + classrelation_ref 146949 // + b multiplicity "" parent class_ref 140293 // Applicable + end end end end diff --git a/uml/cinelerra3/129285 b/uml/cinelerra3/129285 index 26d96af1d..7b8ccd808 100644 --- a/uml/cinelerra3/129285 +++ b/uml/cinelerra3/129285 @@ -1,6 +1,6 @@ format 40 "ProcessingLayer" // ProcessingLayer - revision 7 + revision 9 modified_by 5 "hiv" // class settings //class diagram settings diff --git a/uml/cinelerra3/129285.diagram b/uml/cinelerra3/129285.diagram index b4b7dc366..0dbfb65e7 100644 --- a/uml/cinelerra3/129285.diagram +++ b/uml/cinelerra3/129285.diagram @@ -2,58 +2,75 @@ format 40 classcanvas 128005 class_ref 134021 // Buildable 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 - xyz 101 86 2000 + xyz 87 207 2000 end classcanvas 128133 class_ref 128517 // MObject 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 - xyz 80 228 2000 + xyz 81 349 2000 end -classcanvas 128517 class_ref 134149 // Tool +classcanvas 128517 class_ref 134149 // BuilderTool 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 - xyz 305 86 2000 + xyz 306 207 2000 end classcanvas 128645 class_ref 130693 // ToolFactory 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 - xyz 571 96 2000 + xyz 555 217 2000 end classcanvas 128901 class_ref 128901 // Clip 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 - xyz 146 404 2000 + xyz 147 525 2000 end classcanvas 129029 class_ref 129157 // Meta 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 - xyz 24 492 2000 + xyz 25 613 2000 end classcanvas 129157 class_ref 129029 // Effect 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 - xyz 105 472 2000 + xyz 106 593 2000 end classcanvas 129285 class_ref 129925 // Auto 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 - xyz 86 582 2005 + xyz 87 703 2005 end classcanvas 129413 class_ref 129669 // Label 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 - xyz 24 582 2000 + xyz 25 703 2000 end classcanvas 129541 class_ref 128773 // AbstractMO 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 - xyz 82 326 2000 + xyz 83 447 2000 end classcanvas 130565 class_ref 134277 // SegmentationTool 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 - xyz 303 362 2000 + xyz 304 483 2000 end classcanvas 130949 class_ref 134405 // NodeCreatorTool 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 - xyz 371 469 2004 + xyz 372 590 2004 end note 134277 "{ provided_tool.treat(this); }" - xyzwh 182 191 2000 159 39 + xyzwh 183 312 2000 159 39 classcanvas 134661 class_ref 135173 // Segment 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 - xyz 605 371 2000 + xyz 606 492 2000 end +classcanvas 134917 class_ref 140037 // Tool + 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 + xyz 370 53 2000 + end +classcanvas 135045 class_ref 140165 // Visitable + 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 + xyz 86 53 2000 + end +fragment 135173 "acyclic Visitor Lib" + xyzwh 69 17 1994 578 150 +end +classcanvas 135557 class_ref 140293 // Applicable + 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 + xyz 474 53 2005 + end +note 137861 "mixin for each concrete type to visit" + xyzwh 491 335 2008 137 53 relationcanvas 128261 relation_ref 135557 // from ref 128133 z 1999 to ref 128005 no_role_a no_role_b @@ -91,41 +108,66 @@ relationcanvas 130693 relation_ref 135941 // no_role_a no_role_b no_multiplicity_a no_multiplicity_b relationcanvas 131077 relation_ref 136069 // - from ref 130949 z 1999 to point 453 296 + from ref 130949 z 1999 to point 454 417 line 131205 z 1999 to ref 128517 no_role_a no_role_b no_multiplicity_a no_multiplicity_b relationcanvas 134789 relation_ref 137221 // - from ref 130565 z 1999 stereotype "<>" xyz 542 409 3000 to ref 134661 - role_a_pos 546 385 3000 no_role_b - multiplicity_a_pos 590 418 3000 no_multiplicity_b + from ref 130565 z 1999 stereotype "<>" xyz 543 530 3000 to ref 134661 + role_a_pos 547 506 3000 no_role_b + multiplicity_a_pos 591 539 3000 no_multiplicity_b +relationcanvas 135301 relation_ref 144261 // + from ref 128005 z 1999 to ref 135045 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b +relationcanvas 135429 relation_ref 144389 // + from ref 128517 z 1999 to ref 134917 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b +relationcanvas 135685 relation_ref 144517 // + from ref 128517 z 1999 to point 389 187 + line 136453 z 1999 to point 527 148 + line 136325 z 1999 to ref 135557 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b +relationcanvas 136581 relation_ref 144645 // + from ref 130565 z 1999 to point 388 404 + line 137221 z 1999 to point 527 337 + line 136965 z 1999 to ref 135557 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b +relationcanvas 136709 relation_ref 144773 // + from ref 130949 z 2003 to point 527 463 + line 136837 z 2003 to ref 135557 + no_role_a no_role_b + no_multiplicity_a no_multiplicity_b line 131461 -_-_ - from ref 130565 z 1999 to point 301 409 - line 132101 z 1999 to point 264 407 + from ref 130565 z 1999 to point 302 530 + line 132101 z 1999 to point 265 528 line 132229 z 1999 to ref 128005 line 131589 -_-_ - from ref 130565 z 1999 to point 301 429 + from ref 130565 z 1999 to point 302 550 line 131845 z 1999 to ref 128901 line 131717 -_-_ - from ref 130565 z 1999 to point 300 449 + from ref 130565 z 1999 to point 301 570 line 131973 z 1999 to ref 129157 line 132357 -_-_ - from ref 128005 z 1999 to point 295 514 - line 132613 z 1999 to point 382 524 + from ref 128005 z 1999 to point 296 635 + line 132613 z 1999 to point 383 645 line 132485 z 1999 to ref 130949 line 132741 -_-_ - from ref 128901 z 1999 to point 294 534 - line 132997 z 1999 to point 382 544 + from ref 128901 z 1999 to point 295 655 + line 132997 z 1999 to point 383 665 line 132869 z 1999 to ref 130949 line 133125 -_-_ - from ref 129157 z 1999 to point 291 556 - line 133637 z 1999 to point 381 565 + from ref 129157 z 1999 to point 292 677 + line 133637 z 1999 to point 382 686 line 133765 z 1999 to ref 130949 line 133893 -_-_ - from ref 129285 z 2003 to point 287 578 - line 134149 z 2003 to point 380 585 + from ref 129285 z 2003 to point 288 699 + line 134149 z 2003 to point 381 706 line 134021 z 2003 to ref 130949 line 134405 -_-_ - from ref 128005 z 1999 to point 259 158 + from ref 128005 z 1999 to point 260 279 line 134533 z 1999 to ref 134277 end diff --git a/uml/cinelerra3/129413 b/uml/cinelerra3/129413 index fa3bd529e..efe41073b 100644 --- a/uml/cinelerra3/129413 +++ b/uml/cinelerra3/129413 @@ -1,6 +1,6 @@ format 40 "common" // design::codegen::common - revision 13 + revision 14 modified_by 5 "hiv" // class settings //class diagram settings @@ -39,6 +39,47 @@ Common library and helper classes" 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 comment "defines source files to be generated by BOUML" + artifact 139141 "visitor" + stereotype "source" + cpp_h "/* + ${NAME}.hpp - ${description} +@{CopyrightClaim}@{GPLHeader} +*/ + + +#ifndef ${NAMESPACE}_${NAME}_H +#define ${NAMESPACE}_${NAME}_H + +${includes} +${declarations} + + +${namespace_start} + +${definition} +${namespace_end} +#endif +" + cpp_src "/* + ${Name} - ${description} +@{CopyrightClaim}@{GPLHeader} +* *****************************************************/ + + +${includes} +${namespace_start} + + +${members} +${namespace_end}" + associated_classes + class_ref 140165 // Visitable + class_ref 140037 // Tool + class_ref 140293 // Applicable + end + comment "Acyclic Visitor library" + end + artifact 135813 "error" stereotype "source" cpp_h "/* @@ -163,4 +204,6 @@ ${namespace_end}" end package_ref 130821 // error + + package_ref 130949 // visitor end diff --git a/uml/cinelerra3/130565 b/uml/cinelerra3/130565 index 5da60b0f9..7061b3e4b 100644 --- a/uml/cinelerra3/130565 +++ b/uml/cinelerra3/130565 @@ -1,6 +1,6 @@ format 40 "builder" // design::codegen::proc::mobject::builder - revision 6 + revision 7 modified_by 5 "hiv" // class settings //class diagram settings @@ -156,7 +156,7 @@ ${namespace_end}" comment "building facility (implementation of the build process)" end - artifact 131205 "tool" + artifact 131205 "buildertool" stereotype "source" cpp_h "/* ${NAME}.hpp - ${description} @@ -190,7 +190,7 @@ ${namespace_start} ${members} ${namespace_end}" associated_classes - class_ref 134149 // Tool + class_ref 134149 // BuilderTool end comment "Interface, any tool for processing MObjects" end diff --git a/uml/cinelerra3/130949 b/uml/cinelerra3/130949 new file mode 100644 index 000000000..16a88747b --- /dev/null +++ b/uml/cinelerra3/130949 @@ -0,0 +1,33 @@ +format 40 +"visitor" // design::codegen::common::visitor + revision 1 + 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 + //use case diagram settings + package_name_in_tab default show_context default auto_label_position default draw_all_relations default shadow 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 + //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 + //object diagram settings + write_horizontally default package_name_in_tab default show_context default auto_label_position default draw_all_relations default shadow 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 + //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 + //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 + //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 + + cpp_h_dir "common" + cpp_src_dir "common" + cpp_namespace "cinelerra::visitor" + comment "sub-namespace for visitor library implementation" +end diff --git a/uml/cinelerra3/5.session b/uml/cinelerra3/5.session index 7ce3a373f..a2742eb7a 100644 --- a/uml/cinelerra3/5.session +++ b/uml/cinelerra3/5.session @@ -1,25 +1,30 @@ -window_sizes 1140 783 270 860 633 71 +window_sizes 1140 830 270 860 680 71 diagrams classdiagram_ref 130309 // Asset Kinds - 860 633 100 4 120 0 + 860 633 100 4 0 0 classdiagram_ref 128133 // Session structure 860 633 100 4 0 0 classdiagram_ref 128389 // Render Entities 688 506 100 4 120 0 - active classdiagram_ref 130437 // Media-Asset Relations - 859 616 100 4 0 0 + active classdiagram_ref 129285 // Builder Entities + 860 680 100 4 0 0 end show_stereotypes selected package_ref 129 // cinelerra3 open + deploymentview_ref 128261 // gen + deploymentview_ref 129029 // gen class_ref 137477 // Unknown class_ref 137605 // Preview class_ref 128645 // Placement class_ref 129413 // RelativeLocation class_ref 129541 // Allocation class_ref 139909 // LocatingPin - classview_ref 129029 // Interface - usecaseview_ref 128133 // usage + class_ref 134021 // Buildable + class_ref 134149 // BuilderTool + class_ref 134405 // NodeCreatorTool + classview_ref 128773 // error + class_ref 140165 // Visitable end end diff --git a/uml/cinelerra3/cinelerra3.prj b/uml/cinelerra3/cinelerra3.prj index a6f8a2a7f..47e92b6e0 100644 --- a/uml/cinelerra3/cinelerra3.prj +++ b/uml/cinelerra3/cinelerra3.prj @@ -1,6 +1,6 @@ format 40 "cinelerra3" - revision 37 + revision 39 modified_by 5 "hiv" cpp_root_dir "../../src/" diff --git a/wiki/renderengine.html b/wiki/renderengine.html index 3ffb052d6..dca965c99 100644 --- a/wiki/renderengine.html +++ b/wiki/renderengine.html @@ -703,7 +703,7 @@ Note, //we still have to work out how exactly building, rendering and playback w The Builder is part of the [[Builder Pattern|http://en.wikipedia.org/wiki/Builder_pattern]]
-
+
* the MObjects implement //Buildable//
 * each Buildable can "recieve" a Tool object and aply it
 * the different Tool objects are iterated/mapped onto the list of MObjects in the [[Timeline]]
@@ -712,7 +712,7 @@ The Builder is part of the [[Builder Pattern|http://en.wikipedia.org/wiki/Builde
   * so this design makes it easy to add new Tool subclasses, and within each Tool subclass, all operations on the different MObject classes are grouped together, so it is easy to see what is going on.
   * a given Tool instance can carry state while beeing iterated, so we don't need any global (or object-global) variables to hold the result of the build process
 
-This programming technique is often refered to as //double dispatch// or //visitor//
+This programming technique is often refered to as //double dispatch// or //visitor//. We use a special implementation variant of this pattern, known as "acyclic visitor". This technique was first invented by Robert Martin (1996) &mdash; our code is heavily inspired by the [[Loki library|http://loki-lib.sourceforge.net/]]. We use this approach not only for the builder, but also for carrying out operations on the objects in the EDL in a typesafe manner.
 {{red{TODO:flesh out the actual Operations needed}}}