diff --git a/doc/devel/uml/class128133.html b/doc/devel/uml/class128133.html index 6d1b08152..788456ce7 100644 --- a/doc/devel/uml/class128133.html +++ b/doc/devel/uml/class128133.html @@ -19,7 +19,7 @@

Declaration :

Directly inherited by : Fixture

Artifact : edl

-
Relation tracks (<directional aggregation by value>)

Declaration :

-
Relation clips (<directional aggregation>)

Declaration :

+
Relation tracks (<directional aggregation by value>)

Declaration :

+
Relation clips (<directional aggregation>)

Declaration :

diff --git a/doc/devel/uml/class128261.html b/doc/devel/uml/class128261.html index b3377fe76..c5dbd585f 100644 --- a/doc/devel/uml/class128261.html +++ b/doc/devel/uml/class128261.html @@ -20,8 +20,8 @@
Relation tracks (<directional aggregation by value>)

Declaration :

Relation timeline (<directional aggregation by value>)

Declaration :

-
Operation getPlaylistForRender

Declaration :

-
Operation getAutomation

Declaration :

+
Operation getPlaylistForRender

Declaration :

+
Operation getAutomation

Declaration :

All public operations : getAutomation , getPlaylistForRender

diff --git a/doc/devel/uml/class128517.html b/doc/devel/uml/class128517.html index b0197fc7b..723bd59f6 100644 --- a/doc/devel/uml/class128517.html +++ b/doc/devel/uml/class128517.html @@ -18,8 +18,10 @@

Declaration :

Directly inherited by : AbstractMO

Artifact : mobject

- -
Relation placement (<association>)

Declaration :

+ +
Attribut length
+

Declaration :

TODO: how to represent?

+
Relation placement (<association>)

Declaration :

All public operations : apply

diff --git a/doc/devel/uml/class128645.html b/doc/devel/uml/class128645.html index 6a74969d3..a00dfada6 100644 --- a/doc/devel/uml/class128645.html +++ b/doc/devel/uml/class128645.html @@ -19,8 +19,8 @@

Declaration :

Directly inherited by : Allocation DirectPlacement ExplicitPlacement RelativePlacement

Artifact : placement

-
Relation subject (<association>)

Declaration :

-
Operation resolve

Declaration :

create an actual (explicite) placement while trying to satisfy the network of adjacent objects and placements.

+
Relation subject (<association>)

Declaration :

+
Operation resolve

Declaration :

create an actual (explicit) placement while trying to satisfy the network of adjacent objects and placements.

All public operations : resolve

diff --git a/doc/devel/uml/class128773.html b/doc/devel/uml/class128773.html index b7d3b1205..81c885f5b 100644 --- a/doc/devel/uml/class128773.html +++ b/doc/devel/uml/class128773.html @@ -18,9 +18,7 @@

Declaration :

Directly inherited by : Clip Effect Meta

Artifact : abstractmo

- -
Attribut length
-

Declaration :

+

All public operations : apply

diff --git a/doc/devel/uml/class128901.html b/doc/devel/uml/class128901.html index a260af90b..ca133c971 100644 --- a/doc/devel/uml/class128901.html +++ b/doc/devel/uml/class128901.html @@ -19,7 +19,7 @@

Declaration :

Artifact : clip

Attribut start
-

Declaration :

startpos in source

+

Declaration :

startpos in source

All public operations : apply

diff --git a/doc/devel/uml/class129413.html b/doc/devel/uml/class129413.html index 96f37f1fd..eb05d79ba 100644 --- a/doc/devel/uml/class129413.html +++ b/doc/devel/uml/class129413.html @@ -18,11 +18,11 @@

Declaration :

Artifact : relativeplacement

-
Relation anchor (<unidirectional association>)

Declaration :

+
Relation anchor (<unidirectional association>)

Declaration :

Attribut relType
-

Declaration :

+

Declaration :

the kind of relation denoted by this Placement

Attribut offset
-

Declaration :

Offset the actual position by this (time) value relative to the anchor point

Class RelType
+

Declaration :

Offset the actual position by this (time) value relative to the anchor point. TODO: Representation?

Class RelType

All public operations : resolve

diff --git a/doc/devel/uml/class129541.html b/doc/devel/uml/class129541.html index ce4ca8263..43f614b48 100644 --- a/doc/devel/uml/class129541.html +++ b/doc/devel/uml/class129541.html @@ -20,7 +20,8 @@

a directive to place a MObject in a specific way

Artifact : allocation

Attribut repr
-

Declaration :

human readable representation of the condition characterizing this allocaton, e.g. "t >= 10"

-

All public operations : resolve

+

Declaration :

human readable representation of the condition characterizing this allocaton, e.g. "t >= 10"

+
Operation get_repr

Declaration :

+

All public operations : get_repr , resolve

diff --git a/doc/devel/uml/class129797.html b/doc/devel/uml/class129797.html index 30156af61..7af02f3ea 100644 --- a/doc/devel/uml/class129797.html +++ b/doc/devel/uml/class129797.html @@ -20,10 +20,10 @@

Artifact : explicitplacement

Attribut time
-

Declaration :

+

Declaration :

Attribut track
-

Declaration :

-
Relation <unidirectional association>

Declaration :

+

Declaration :

+
Relation <unidirectional association>

Declaration :

All public operations : resolve

diff --git a/doc/devel/uml/class129925.html b/doc/devel/uml/class129925.html index f904b001e..ee1a92f29 100644 --- a/doc/devel/uml/class129925.html +++ b/doc/devel/uml/class129925.html @@ -16,9 +16,9 @@ -

Declaration :

Artifact : auto

+

Declaration :

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

Artifact : auto

-
Operation getValue

Declaration :

+
Operation getValue

Declaration :

All public operations : apply , getValue , getValue

diff --git a/doc/devel/uml/class130053.html b/doc/devel/uml/class130053.html index 5dff16ee8..f88d2a19b 100644 --- a/doc/devel/uml/class130053.html +++ b/doc/devel/uml/class130053.html @@ -18,6 +18,6 @@

Declaration :

-

All public operations : resolve

+

All public operations : get_repr , resolve

diff --git a/doc/devel/uml/class130181.html b/doc/devel/uml/class130181.html index f5e9d5dce..c1578a450 100644 --- a/doc/devel/uml/class130181.html +++ b/doc/devel/uml/class130181.html @@ -18,6 +18,6 @@

Declaration :

-

All public operations : resolve

+

All public operations : get_repr , resolve

diff --git a/doc/devel/uml/class130309.html b/doc/devel/uml/class130309.html index 1cf317dcc..9ae730182 100644 --- a/doc/devel/uml/class130309.html +++ b/doc/devel/uml/class130309.html @@ -16,5 +16,5 @@ -

Declaration :

Artifact : controllerfacade

+

Declaration :

Provides unified access to the Proc-Subsystem Controller. Especially, this Facade class provides the functions to get a render engine to carry out actual renderings.

Artifact : controllerfacade

diff --git a/doc/devel/uml/class130437.html b/doc/devel/uml/class130437.html index 90c91c859..bce32e299 100644 --- a/doc/devel/uml/class130437.html +++ b/doc/devel/uml/class130437.html @@ -16,9 +16,9 @@ -

Declaration :

Artifact : pathmanager

+

Declaration :

While building a render engine, this Strategy class decides on the actual render strategy in accordance to the current controller settings (system state)

Artifact : pathmanager

-
Operation buildProcessor

Declaration :

+
Operation buildProcessor

Declaration :

All public operations : buildProcessor

diff --git a/doc/devel/uml/class130565.html b/doc/devel/uml/class130565.html index 8f6a29869..ae8a0ded5 100644 --- a/doc/devel/uml/class130565.html +++ b/doc/devel/uml/class130565.html @@ -16,9 +16,9 @@ -

Declaration :

Artifact : builderfacade

+

Declaration :

Provides 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

Artifact : builderfacade

-
Operation buildEngine

Declaration :

+
Operation buildEngine

Declaration :

Main Operation of the Builder: create a render engine for a given part of the timeline

All public operations : buildEngine

diff --git a/doc/devel/uml/class130693.html b/doc/devel/uml/class130693.html index 616f0a2e2..aaf7fd304 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/class130821.html b/doc/devel/uml/class130821.html index c3fc0a5b5..f5856aaab 100644 --- a/doc/devel/uml/class130821.html +++ b/doc/devel/uml/class130821.html @@ -16,9 +16,9 @@ -

Declaration :

Artifact : conmanager

+

Declaration :

Connection Manager, used to build the connections between render engine nodes, if these nodes need to cooperate besides the normal "data pull" operation. Esp., the Connection Manager knows how to wire up the effect's parameters with the corresponding ParamProviders (autmation) in the Session

Artifact : conmanager

-
Operation getConnection

Declaration :

+
Operation getConnection

Declaration :

TODO

All public operations : getConnection

diff --git a/doc/devel/uml/class130949.html b/doc/devel/uml/class130949.html index 85cd00997..774585ac5 100644 --- a/doc/devel/uml/class130949.html +++ b/doc/devel/uml/class130949.html @@ -16,9 +16,9 @@ -

Declaration :

Artifact : renderstate

+

Declaration :

Encapsulates the logic used to get a "current render process" in accordance to the currentyl applicable controller settings. The provided StateProxy serves to hold any mutalbe state used in the render process, so the rest of the render engine can be stateless.

Artifact : renderstate

-
Operation getStateProxy

Declaration :

+
Operation getStateProxy

Declaration :

All public operations : getStateProxy

diff --git a/doc/devel/uml/class131077.html b/doc/devel/uml/class131077.html index 984edbf63..a5d40eab9 100644 --- a/doc/devel/uml/class131077.html +++ b/doc/devel/uml/class131077.html @@ -16,9 +16,9 @@ -

Declaration :

Artifact : assembler

+

Declaration :

This is the actual building facility: provided the correct tools and associations, it serves to build and connect the individual ProcNode objects

Artifact : assembler

-
Operation build

Declaration :

+
Operation build

Declaration :

All public operations : build

diff --git a/doc/devel/uml/class131333.html b/doc/devel/uml/class131333.html index 8c4bafafc..70d8c0609 100644 --- a/doc/devel/uml/class131333.html +++ b/doc/devel/uml/class131333.html @@ -18,8 +18,8 @@

Declaration :

Artifact : renderengine

-
Operation play

Declaration :

-
Relation renderSegments (<directional aggregation by value>)

Declaration :

+
Operation play

Declaration :

TODO: will probably be handled differently (see Cehteh)

+
Relation renderSegments (<directional aggregation by value>)

Declaration :

All public operations : play

diff --git a/doc/devel/uml/class131461.html b/doc/devel/uml/class131461.html index 21405cdec..da8373b8e 100644 --- a/doc/devel/uml/class131461.html +++ b/doc/devel/uml/class131461.html @@ -21,8 +21,8 @@
Relation output (<unidirectional association>)

Declaration :

Attribut start
-

Declaration :

begin of the timerange covered by this processor

+

Declaration :

begin of the timerange covered by this processor

Attribut end
-

Declaration :

end of the timerange (excl)

+

Declaration :

end of the timerange (excl)

diff --git a/doc/devel/uml/class131589.html b/doc/devel/uml/class131589.html index bb94334b0..c65bef7fb 100644 --- a/doc/devel/uml/class131589.html +++ b/doc/devel/uml/class131589.html @@ -16,7 +16,7 @@ -

Declaration :

Artifact : exitnode

+

Declaration :

The output of the render pipeline. Pulling from such exit nodes actually ivokes the render process

Artifact : exitnode

diff --git a/doc/devel/uml/class131717.html b/doc/devel/uml/class131717.html index dd3d0535a..d03898369 100644 --- a/doc/devel/uml/class131717.html +++ b/doc/devel/uml/class131717.html @@ -17,9 +17,9 @@

Declaration :

Directly inherited by : ExitNode Hub Link Source Trafo

-

Artifact : procnode

+

Key abstraction of the Render Engine: A Data processing Node

Artifact : procnode

Relation datasrc (<unidirectional association>)

Declaration :

The predecessor in a processing pipeline, i.e. a source to get data to be processed

-
Relation <directional aggregation by value>

Declaration :

+
Relation params (<directional aggregation by value>)

Declaration :

diff --git a/doc/devel/uml/class131845.html b/doc/devel/uml/class131845.html index ed84d74d8..278d1cdb1 100644 --- a/doc/devel/uml/class131845.html +++ b/doc/devel/uml/class131845.html @@ -16,7 +16,7 @@ -

Declaration :

Directly inherited by : Mask PluginAdapter Projector

+

Declaration :

Directly inherited by : CodecAdapter Mask PluginAdapter Projector

Artifact : trafo

diff --git a/doc/devel/uml/class131973.html b/doc/devel/uml/class131973.html index fcea8bbf8..39cb21caa 100644 --- a/doc/devel/uml/class131973.html +++ b/doc/devel/uml/class131973.html @@ -16,7 +16,7 @@ -

Declaration :

Directly inherited by : OpenGLPipe

+

Declaration :

Directly inherited by : GLPipe

Artifact : pipe

diff --git a/doc/devel/uml/class132229.html b/doc/devel/uml/class132229.html index 6b6358940..f0ba8e9d7 100644 --- a/doc/devel/uml/class132229.html +++ b/doc/devel/uml/class132229.html @@ -16,7 +16,7 @@ -

Declaration :

Artifact : projector

+

Declaration :

Special video processing node used to scale and translate image data.

Artifact : projector

diff --git a/doc/devel/uml/class132485.html b/doc/devel/uml/class132485.html index f28800a7d..b6389bd12 100644 --- a/doc/devel/uml/class132485.html +++ b/doc/devel/uml/class132485.html @@ -16,7 +16,7 @@ -

Declaration :

Artifact : pluginadapter

+

Declaration :

  • C++ : class PluginAdapter : public Trafo

Adapter used to integrage an effects processor in the render pipeline

Artifact : pluginadapter

diff --git a/doc/devel/uml/class132613.html b/doc/devel/uml/class132613.html index 51b05ca81..33576f2eb 100644 --- a/doc/devel/uml/class132613.html +++ b/doc/devel/uml/class132613.html @@ -4,19 +4,19 @@ -Class OpenGLPipe +Class GLPipe -
Class OpenGLPipe
+
Class GLPipe

-

Declaration :

  • C++ : class OpenGLPipe : public Link

Artifact : openglpipe

+

Declaration :

  • C++ : class GLPipe : public Link

specialized connection node used to handle the transfer of OpenGL data from a image bitmap into texture form

Artifact : openglpipe

diff --git a/doc/devel/uml/class132741.html b/doc/devel/uml/class132741.html index e230fd43b..a7f5baf22 100644 --- a/doc/devel/uml/class132741.html +++ b/doc/devel/uml/class132741.html @@ -16,7 +16,7 @@ -

Declaration :

  • C++ : class StateProxy
  • Java : package interface StateProxy

Directly inherited by : ARender GLRender VRender

+

Declaration :

  • C++ : class StateProxy
  • Java : public interface StateProxy

Directly inherited by : ARender GLRender VRender

Artifact : stateproxy

Relation currFrame (<unidirectional association>)

Declaration :

  • Uml : # currFrame : Frame
  • C++ : protected: Frame * currFrame
diff --git a/doc/devel/uml/class132869.html b/doc/devel/uml/class132869.html index 6b7798036..743378103 100644 --- a/doc/devel/uml/class132869.html +++ b/doc/devel/uml/class132869.html @@ -16,7 +16,7 @@ -

Declaration :

Artifact : arender

+

Declaration :

Representation of a Audio render process

Artifact : arender

diff --git a/doc/devel/uml/class132997.html b/doc/devel/uml/class132997.html index b226dd2d7..7680639be 100644 --- a/doc/devel/uml/class132997.html +++ b/doc/devel/uml/class132997.html @@ -16,7 +16,7 @@ -

Declaration :

Artifact : vrender

+

Declaration :

Representation of a Video render process. (Encapsulates the video buffers for the actual calculations)

Artifact : vrender

diff --git a/doc/devel/uml/class133125.html b/doc/devel/uml/class133125.html index 7b06074f4..140cc4b67 100644 --- a/doc/devel/uml/class133125.html +++ b/doc/devel/uml/class133125.html @@ -16,7 +16,7 @@ -

Declaration :

Artifact : glrender

+

Declaration :

Representation of a OpenGL accelerated Video render process

Artifact : glrender

diff --git a/doc/devel/uml/class133253.html b/doc/devel/uml/class133253.html index 1295d9faa..d34dc0fb5 100644 --- a/doc/devel/uml/class133253.html +++ b/doc/devel/uml/class133253.html @@ -16,6 +16,6 @@ -

Declaration :

  • C++ : class Frame
  • Java : package interface Frame

Directly inherited by : AFrame GLBuf VFrame

-

Artifact : frame

+

Declaration :

  • C++ : class Frame
  • Java : public interface Frame

Directly inherited by : AFrame GLBuf VFrame

+

TODO: how to relate to Cehteh's Frame entity in the Backend?
The latter is the fundamental Frame entity, wheras this Object rather represents a buffer set containing frame date

Artifact : frame

diff --git a/doc/devel/uml/class133765.html b/doc/devel/uml/class133765.html index 890c2031f..af0e6bfb1 100644 --- a/doc/devel/uml/class133765.html +++ b/doc/devel/uml/class133765.html @@ -16,7 +16,7 @@ -

Declaration :

Artifact : source

+

Declaration :

Source Node: represents a media source to pull data from.

Artifact : source

diff --git a/doc/devel/uml/class133893.html b/doc/devel/uml/class133893.html index 5d01aec40..ed2c18147 100644 --- a/doc/devel/uml/class133893.html +++ b/doc/devel/uml/class133893.html @@ -16,7 +16,7 @@ -

Declaration :

  • C++ : enum RelType
  • Java : protected enum RelType

nested in RelativePlacement

+

Declaration :

  • C++ : enum RelType
  • Java : public enum RelType

the possible kinds of RelativePlacements

nested in RelativePlacement

Items :

  • SAMETIME
    • diff --git a/doc/devel/uml/class134021.html b/doc/devel/uml/class134021.html index 5b9db6ab5..0f4c8e720 100644 --- a/doc/devel/uml/class134021.html +++ b/doc/devel/uml/class134021.html @@ -19,7 +19,7 @@

    Declaration :

    • C++ : class Buildable
    • Java : public interface Buildable

    Directly inherited by : MObject

    Artifact : buildable

    -
    Operation apply

    Declaration :

    • Uml : + apply(inout provided_tool : Tool) :
    • C++ : public: apply()
    +
    Operation apply

    Declaration :

    • Uml : + apply(inout provided_tool : Tool) : void
    • C++ : public: void apply (Tool& provided_tool)

All public operations : apply

diff --git a/doc/devel/uml/class134149.html b/doc/devel/uml/class134149.html index 25942f8dd..d405b1b3f 100644 --- a/doc/devel/uml/class134149.html +++ b/doc/devel/uml/class134149.html @@ -17,9 +17,9 @@

Declaration :

  • C++ : class Tool
  • Java : public interface Tool

Directly inherited by : NodeCreatorTool SegmentationTool

-

Artifact : tool

+

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

-
Operation treat

Declaration :

  • Uml : + treat(inout mElement : Buildable) :
  • C++ : public: treat()
+
Operation treat

Declaration :

  • Uml : + treat(in mElement : Buildable) : void
  • C++ : public: void treat (const Buildable& mElement)

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

All public operations : treat

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

Declaration :

  • C++ : class SegmentationTool : public Tool

Artifact : segmentationtool

+

Declaration :

  • C++ : class SegmentationTool : public Tool

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 :

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

Declaration :

  • Uml : + treat(inout clip : Clip) :
  • C++ : public: treat()
-
Operation treat

Declaration :

  • Uml : + treat(inout effect : Effect) :
  • C++ : public: treat()
-
Attribut segments
-

Declaration :

  • Uml : - segments :
  • C++ : private: segments

holds the segemntation to be constructed

+
Operation treat

Declaration :

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

Declaration :

  • Uml : + treat(in clip : Clip) : void
  • C++ : public: void treat (const Clip& clip)
+
Operation treat

Declaration :

  • Uml : + treat(in effect : Effect) : void
  • C++ : public: void treat (const Effect& effect)
+
Relation segments (<directional aggregation by value>)

Declaration :

  • Uml : # segments : Segment, multiplicity : *
  • C++ : protected: list<Segment> segments

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

All public operations : treat , treat , treat , treat

diff --git a/doc/devel/uml/class134405.html b/doc/devel/uml/class134405.html index 2728dba6f..3233a3151 100644 --- a/doc/devel/uml/class134405.html +++ b/doc/devel/uml/class134405.html @@ -16,12 +16,12 @@ -

Declaration :

  • C++ : class NodeCreatorTool : public Tool

Artifact : nodecreatertool

+

Declaration :

  • C++ : class NodeCreatorTool : public Tool

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) :
  • C++ : public: treat()
-
Operation treat

Declaration :

  • Uml : + treat(inout clip : Clip) :
  • C++ : public: treat()
-
Operation treat

Declaration :

  • Uml : + treat(inout effect : Effect) :
  • C++ : public: treat()
-
Operation treat

Declaration :

  • Uml : + treat(inout auto : Auto) :
  • C++ : public: treat()
+
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)
+
Operation treat

Declaration :

  • Uml : + treat(inout effect : Effect) : void
  • C++ : public: void treat (Effect& effect)
+
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

diff --git a/doc/devel/uml/class134533.html b/doc/devel/uml/class134533.html index eb574261a..0a5e1a658 100644 --- a/doc/devel/uml/class134533.html +++ b/doc/devel/uml/class134533.html @@ -16,10 +16,10 @@ -

Declaration :

  • C++ : template<class VAL> class Parameter

Artifact : parameter

+

Declaration :

  • C++ : template<class VAL> class Parameter

Descriptor and access object for a plugin parameter. Parameters may be provided with values from the session, and this values may be automated.

Artifact : parameter

-
Operation getValue

Declaration :

  • Uml : + getValue() : VAL
  • C++ : public: VAL getValue()
-
Relation <association>

Declaration :

+
Operation getValue

Declaration :

  • Uml : + getValue() : VAL
  • C++ : public: VAL getValue () const
+
Relation <association>

Declaration :

All public operations : getValue

diff --git a/doc/devel/uml/class134661.html b/doc/devel/uml/class134661.html index de84ec5f2..811531c79 100644 --- a/doc/devel/uml/class134661.html +++ b/doc/devel/uml/class134661.html @@ -17,11 +17,11 @@

Declaration :

  • C++ : template<class VAL> class ParamProvider
  • Java : public interface ParamProvider<VAL>

Directly inherited by : Auto

-

Artifact : paramprovider

+

A facility to get the actual value of a plugin/effect parameter

Artifact : paramprovider

-
Relation param (<association>)

Declaration :

-
Relation <unidirectional association>

Declaration :

-
Operation getValue

Declaration :

  • Uml : + getValue() : VAL
  • C++ : public: VAL getValue()
+
Relation param (<association>)

Declaration :

+
Relation ipo (<unidirectional association>)

Declaration :

+
Operation getValue

Declaration :

  • Uml : + getValue() : VAL
  • C++ : public: VAL getValue () const

All public operations : getValue

diff --git a/doc/devel/uml/class134789.html b/doc/devel/uml/class134789.html index 90cd286c2..5da6a8542 100644 --- a/doc/devel/uml/class134789.html +++ b/doc/devel/uml/class134789.html @@ -16,5 +16,5 @@ -

Declaration :

  • C++ : template<class VAL> class Interpolator

Artifact : interpolator

+

Declaration :

  • C++ : template<class VAL> class Interpolator

Provides the implementation for getting the acutal value of a time varying or automated effect/plugin parameter

Artifact : interpolator

diff --git a/doc/devel/uml/class134917.html b/doc/devel/uml/class134917.html index d32e78a20..00fdfb1e2 100644 --- a/doc/devel/uml/class134917.html +++ b/doc/devel/uml/class134917.html @@ -16,5 +16,5 @@ -

Declaration :

  • C++ : class Time

denotes a temporal position (time point), based on timeline start.

investigate posix.4 realtime timers, wrap these here

Artifact : mobject

+

Declaration :

  • C++ : class Time

denotes a temporal position (time point), based on timeline start.

investigate posix.4 realtime timers, wrap these here

Artifact : time

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

+ + + + +

Declaration :

  • C++ : class CodecAdapter : public Trafo

Artifact : codecadapter

+
+ + diff --git a/doc/devel/uml/class135173.html b/doc/devel/uml/class135173.html new file mode 100644 index 000000000..7acd8333f --- /dev/null +++ b/doc/devel/uml/class135173.html @@ -0,0 +1,27 @@ + + + + + + +Class Segment + + + + + +
Class Segment
+

+ + + + +

Declaration :

  • C++ : class Segment
+ +
Attribut start
+

Declaration :

  • Uml : # start : Time
  • C++ : protected: Time start
+
Attribut length
+

Declaration :

  • Uml : # length : Time
  • C++ : protected: Time length

duration (span) of this timeline segment.

+
Relation elements (<directional aggregation>)

Declaration :

relevant MObjects comprising this segment. TODO: actually necessary??

+ + diff --git a/doc/devel/uml/classes.html b/doc/devel/uml/classes.html index e4692eb80..3f80fa110 100644 --- a/doc/devel/uml/classes.html +++ b/doc/devel/uml/classes.html @@ -19,20 +19,21 @@ AbstractMO AFrame Allocationa directive to place a MObject in a specific way -ARender -Assembler -Auto +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 +AutoAutomation data for some parameter (i.e. a time varying function) Buildableinterface -BuilderFacadeboundary +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 Clip +CodecAdapter ConditionI provided a reworked Condition class in my cinelerra2 repository -ConManager +ConManagerConnection Manager, used to build the connections between render engine nodes, if these nodes need to cooperate besides the normal "data pull" operation. Esp., the Connection Manager knows how to wire up the effect's parameters with the corresponding ParamProviders (autmation) in the Session Constraint -ControllerFacadeboundary +ControllerFacadeboundaryProvides unified access to the Proc-Subsystem Controller. Especially, this Facade class provides the functions to get a render engine to carry out actual renderings. DirectPlacement EDL Effect -ExitNode +ExitNodeThe output of the render pipeline. Pulling from such exit nodes actually ivokes the render process ExplicitPlacementinterface File FileHandle @@ -43,13 +44,14 @@ FileReference Fixture FrameFrames are just a low level lump of continous memory, most parts are opaque. Frames are memory sensitive, they will be small constant sized structures which can be efficently managed in a pool. -Frameinterface +FrameinterfaceTODO: how to relate to Cehteh's Frame entity in the Backend?
The latter is the fundamental Frame entity, wheras this Object rather represents a buffer set containing frame date FrameDescriptorinterfaceA FrameDescriptor implements the higher level interfaces for frames. Further refinements are made by subclassing and policy classes FrameReference GLBuf -GLRender +GLPipespecialized connection node used to handle the transfer of OpenGL data from a image bitmap into texture form +GLRenderRepresentation of a OpenGL accelerated Video render process Hub -Interpolator +InterpolatorProvides the implementation for getting the acutal value of a time varying or automated effect/plugin parameter Label Link Lock @@ -58,35 +60,35 @@ Meta MObjectinterface MutexI provided a reworked Mutex class in my cinelerra2 repository -NodeCreatorTool -OpenGLPipe -Parameter -ParamProviderinterface -PathManager +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. +ParameterDescriptor and access object for a plugin parameter. Parameters may be provided with values from the session, and this values may be automated. +ParamProviderinterfaceA facility to get the actual value of a plugin/effect parameter +PathManagerWhile building a render engine, this Strategy class decides on the actual render strategy in accordance to the current controller settings (system state) Placementinterface -PluginAdapter +PluginAdapterAdapter used to integrage an effects processor in the render pipeline Prefetch Processor -ProcNodeinterface -Projector +ProcNodeinterfaceKey abstraction of the Render Engine: A Data processing Node +ProjectorSpecial video processing node used to scale and translate image data. RelativePlacement -RelTypeenum +RelTypeenumthe possible kinds of RelativePlacements RenderEngine -RenderState +RenderStateEncapsulates the logic used to get a "current render process" in accordance to the currentyl applicable controller settings. The provided StateProxy serves to hold any mutalbe state used in the render process, so the rest of the render engine can be stateless. Scheduler -SegmentationTool +Segment +SegmentationToolTool 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. Session SmartPointerauxiliary -Source +SourceSource Node: represents a media source to pull data from. StateProxyinterface 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 -Toolinterface +ToolinterfaceUsed according to the visitor pattern: each Tool contains the concrete implementation for one task to be done to the various MObject classes ToolFactory Track Trafo VFrame -VRender +VRenderRepresentation of a Video render process. (Encapsulates the video buffers for the actual calculations) Wish diff --git a/doc/devel/uml/classes_list.html b/doc/devel/uml/classes_list.html index 5c4f434ab..aee95f532 100644 --- a/doc/devel/uml/classes_list.html +++ b/doc/devel/uml/classes_list.html @@ -26,6 +26,7 @@ Buildable
BuilderFacade
Clip
+CodecAdapter
Condition
ConManager
Constraint
@@ -48,6 +49,7 @@ FrameDescriptor
FrameReference
GLBuf
+GLPipe
GLRender
Hub
Interpolator
@@ -60,7 +62,6 @@ MObject
Mutex
NodeCreatorTool
-OpenGLPipe
Parameter
ParamProvider
PathManager
@@ -75,6 +76,7 @@ RenderEngine
RenderState
Scheduler
+Segment
SegmentationTool
Session
SmartPointer
diff --git a/doc/devel/uml/fig128005.png b/doc/devel/uml/fig128005.png index a0fc8780b..68d6a056f 100644 Binary files a/doc/devel/uml/fig128005.png and b/doc/devel/uml/fig128005.png differ diff --git a/doc/devel/uml/fig128133.png b/doc/devel/uml/fig128133.png index 2609d5511..9a1680254 100644 Binary files a/doc/devel/uml/fig128133.png and b/doc/devel/uml/fig128133.png differ diff --git a/doc/devel/uml/fig128389.png b/doc/devel/uml/fig128389.png index 2891b31b9..36521dc8a 100644 Binary files a/doc/devel/uml/fig128389.png and b/doc/devel/uml/fig128389.png differ diff --git a/doc/devel/uml/fig128517.png b/doc/devel/uml/fig128517.png index fa1c38015..61f1341a4 100644 Binary files a/doc/devel/uml/fig128517.png and b/doc/devel/uml/fig128517.png differ diff --git a/doc/devel/uml/fig128773.png b/doc/devel/uml/fig128773.png index c0ad94762..282e0e7b1 100644 Binary files a/doc/devel/uml/fig128773.png and b/doc/devel/uml/fig128773.png differ diff --git a/doc/devel/uml/fig128901.png b/doc/devel/uml/fig128901.png index c37fbe3ff..6bb94e8cc 100644 Binary files a/doc/devel/uml/fig128901.png and b/doc/devel/uml/fig128901.png differ diff --git a/doc/devel/uml/fig129285.png b/doc/devel/uml/fig129285.png index b08d625f1..2c6a4ba97 100644 Binary files a/doc/devel/uml/fig129285.png and b/doc/devel/uml/fig129285.png differ diff --git a/doc/devel/uml/fig129669.png b/doc/devel/uml/fig129669.png index e145d881a..d3bef463a 100644 Binary files a/doc/devel/uml/fig129669.png and b/doc/devel/uml/fig129669.png differ diff --git a/doc/devel/uml/fig129797.png b/doc/devel/uml/fig129797.png index b9edd1d9b..e38a4cb77 100644 Binary files a/doc/devel/uml/fig129797.png and b/doc/devel/uml/fig129797.png differ diff --git a/doc/devel/uml/index.html b/doc/devel/uml/index.html index 64ebaa247..da7ba2469 100644 --- a/doc/devel/uml/index.html +++ b/doc/devel/uml/index.html @@ -62,6 +62,9 @@ Documentation

1.2 Package codegen

+

    +
  • C++ namespace : cinelerra
    • +

This package is used to organize code generation by BOUML. It is considered useless after having generated the initial code skeleton.

1.2.1 Deployment View EXE Deployment

@@ -73,7 +76,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 : mask, main, paramprovider, frame, processor, fixedplacement, glrender, glbuf, controllerfacade, meta, pluginadapter, renderstate, session, vframe, source, exitnode, fixture, track, renderengine, edl, parameter, explicitplacement, projector, builderfacade, toolfactory, buildable, clip, hub, conmanager, relativeplacement, assembler, aframe, label, tool, allocation, stateproxy, segmentationtool, pathmanager, vrender, arender, effect, pipe, interpolator, auto, mobject, placement, trafo, openglpipe, procnode, abstractmo, nodecreatertool

+

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

Artifact main

Artifact source

@@ -88,6 +91,12 @@ Documentation

1.2.2.1 Deployment View gen

defines source files to be generated by BOUML

+
+ +
Artifact time
+

unified representation of a time point, including conversion functions

+

Artifact source associated with : Time

+

1.2.3 Package backend

@@ -110,12 +119,15 @@ Documentation
Artifact stateproxy
+

Key Interface representing a render process and encapsulating state

Artifact source associated with : StateProxy

Artifact controllerfacade
+

Facade and service access point for the Proc Layer Controller

Artifact source associated with : ControllerFacade

Artifact frame
+

Key Abstraction: render process and buffer holding frame data.

Artifact source associated with : Frame

@@ -140,27 +152,35 @@ Documentation
Artifact mobject
-

Artifact source associated with : Time, MObject

+

Key Abstraction: A Media Object in the Session

+

Artifact source associated with : MObject

Artifact placement
+

Key Abstraction: a way to place and locate a Media Object

Artifact source associated with : Placement

Artifact explicitplacement
+

special Placement yielding an absolute location (Time,Track)-location for a MObject

Artifact source associated with : ExplicitPlacement

Artifact builderfacade
+

Facade and service access point for the Builder Subsystem

Artifact source associated with : BuilderFacade

Artifact buildable
+

marker interface denoting any MObject able to be treated by Tools

Artifact source associated with : Buildable

Artifact parameter
+

representation of an automatable effect/plugin parameter

Artifact source associated with : Parameter

Artifact paramprovider
+

interface denoting a source for actual Parameter values

Artifact source associated with : ParamProvider

Artifact interpolator
+

denotes a facility to get (continuously interpolated) parameter values

Artifact source associated with : Interpolator

@@ -175,33 +195,42 @@ Documentation
Artifact session
+

holds the complete session to be edited by the user

Artifact source associated with : Session

Artifact edl
+

the (high level) Edit Decision List within the current Session

Artifact source associated with : EDL

Artifact fixture
+

the (low level) representation of the EDL with concrete placement data

Artifact source associated with : Fixture

Artifact track
+

descriptor for one track in the Session

Artifact source associated with : Track

Artifact abstractmo
+

abstract base class for all Media Objects

Artifact source associated with : AbstractMO

Artifact clip
+

a Media Clip

Artifact source associated with : Clip

Artifact effect
+

EDL representation of a pluggable and automatable effect.

Artifact source associated with : Effect

Artifact meta
+

abstract base class of all MObjects representing meta data or processing instructions

Artifact source associated with : Meta

Artifact fixedplacement

Artifact source associated with : DirectPlacement

Artifact relativeplacement
+

Placement implemnetaion providing various ways of attaching a MObject to another one

Artifact source associated with : RelativePlacement

Artifact allocation
@@ -211,6 +240,7 @@ Documentation

Artifact source associated with : Label

Artifact auto
+

Media Object holding automation data

Artifact source associated with : Auto

@@ -226,21 +256,27 @@ Documentation
Artifact toolfactory
+

supply of Tool implementations for the Builder

Artifact source associated with : ToolFactory

Artifact conmanager
+

manages the creation of additional ProcNode connections for the Renderengine

Artifact source associated with : ConManager

Artifact assembler
+

building facility (implementation of the build process)

Artifact source associated with : Assembler

Artifact tool
+

Interface, any tool for processing MObjects

Artifact source associated with : Tool

Artifact segmentationtool
+

Tool for creating a partitioning of the current timeline

Artifact source associated with : SegmentationTool

Artifact nodecreatertool
+

central Tool implementing the Renderengine building

Artifact source associated with : NodeCreatorTool

@@ -256,9 +292,11 @@ Documentation
Artifact pathmanager
+

Manager for deciding the actual render strategy

Artifact source associated with : PathManager

Artifact renderstate
+

renderengine state manager

Artifact source associated with : RenderState

@@ -275,57 +313,79 @@ Documentation
Artifact renderengine
+

a complete network of processing nodes usable for rendering

Artifact source associated with : RenderEngine

Artifact processor
+

a single render pipeline for one segment of the timeline

Artifact source associated with : Processor

Artifact exitnode
+

special Processing Node providing "pullable" output

Artifact source associated with : ExitNode

Artifact procnode
+

Key abstraction of the Render Engine: a Processing Node

Artifact source associated with : ProcNode

Artifact trafo
+

transforming processing Node

Artifact source associated with : Trafo

Artifact pipe
+

forwarding, adapting or connecting ProcNode

Artifact source associated with : Link

Artifact hub
+

special ProcNode used to build data distributing connections

Artifact source associated with : Hub

Artifact projector
+

video ProcNode for scaling and translating image data

Artifact source associated with : Projector

Artifact mask
+

Video ProcNode for masking regions of the image (automatable)

Artifact source associated with : Mask

Artifact pluginadapter
+

Adapter for integrating various Effect processors in the render pipeline

Artifact source associated with : PluginAdapter

+ +
Artifact codecadapter
+

Processing Node for (de)coding media data

+

Artifact source associated with : CodecAdapter

Artifact openglpipe
-

Artifact source associated with : OpenGLPipe

+

specialized connection element for handling OpenGL implementation details

+

Artifact source associated with : GLPipe

Artifact arender
+

Representation of a Audio Render process

Artifact source associated with : ARender

Artifact vrender
+

Representation of a Video render process

Artifact source associated with : VRender

Artifact glrender
+

Representation of a OpenGL accellerated Video render process

Artifact source associated with : GLRender

Artifact aframe
+

a buffer and render process holding a Audio frame

Artifact source associated with : AFrame

Artifact vframe
+

a buffer and render process holding a Video frame

Artifact source associated with : VFrame

Artifact glbuf
+

a buffer and render process holding a Video frame for OpenGL rendering

Artifact source associated with : GLBuf

Artifact source
+

Representation of a Media source

Artifact source associated with : Source

@@ -369,6 +429,8 @@ Documentation
Class Track
Class MObject
Class Placement
+
Class ExplicitPlacement
+
Class Segment
Class AbstractMO
Class Clip
Class Effect
@@ -377,10 +439,12 @@ Documentation
Class RelativePlacement
Class Allocation
Class Label
-
Class ExplicitPlacement
Class Auto
Class Wish
Class Constraint
+
Class Parameter
+
Class ParamProvider
+
Class Interpolator

2.2.2 Package Builder

@@ -576,7 +640,8 @@ reuse exiting Engine

Selection :

    Transformation
    Class Projector
    Class Mask
    Class PluginAdapter
    -
    Class OpenGLPipe
    +
    Class CodecAdapter
    +
    Class GLPipe
    Class ARender
    Class VRender
    Class GLRender
    @@ -585,9 +650,6 @@ reuse exiting Engine

    Selection :

      Transformation
      Class VFrame
      Class GLBuf
      Class Source
      -
      Class Parameter
      -
      Class ParamProvider
      -
      Class Interpolator

      @@ -618,11 +680,11 @@ reuse exiting Engine

      Selection :

      Transformation
      Class instance audio1

      type :Track

      Class instance video1

      type :Track

      Class instance vid_A

      type :Clip

      attributes :

      Class instance aud_A

      type :Clip

      attributes :

      Class instance audio1

      type :Track

      @@ -633,18 +695,18 @@ reuse exiting Engine

      Selection :

      Transformation
      Class instance video1

      type :Track

      Class instance

      type :Fixture

      Class instance vid_A

      type :Clip

      attributes :

      Class instance

      type :EDL

      Class instance refPoint

      type :Label

      attributes :

      Class instance

      type :Allocation

      attributes :

      Class instance vid_A

      type :Clip

      attributes :

      relations :

      Selection :

      Transformation
      Class instance

      type :RelativePlacement

      attributes :

      relations :

      Class instance

      type :Effect

      attributes :

      relations :

      Selection :

      Transformation

    • offset = +3
    • relType = ATTACH

      • relations :

      Class instance

      type :Effect

      attributes :

      relations :