LUMIERA.clone/src/proc/mobject/builder/conmanager.hpp
Ichthyostega 48e9b7594a Doxygen: identify all files lacking a @file comment
reason is, only files with a @file comment will be processed
with further documentation commands. For this reason, our Doxygen
documentation is lacking a lot of entries.

HOWTO:
find src -type f \( -name '*.cpp' -or -name '*.hpp' \) -not -exec egrep -q '\*.+@file' {} \; -print -exec sed -i -r -e'\_\*/_,$ { 1,+0 a\
\
\
/** @file §§§\
 ** TODO §§§\
 */
}' {} \;
2016-11-03 18:20:10 +01:00

62 lines
1.9 KiB
C++

/*
CONMANAGER.hpp - manages the creation of data/control connections when building the Renderengine
Copyright (C) Lumiera.org
2008, Hermann Vosseler <Ichthyostega@web.de>
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.
*/
/** @file §§§
** TODO §§§
*/
#ifndef PROC_MOBJECT_BUILDER_CONMANAGER_H
#define PROC_MOBJECT_BUILDER_CONMANAGER_H
namespace proc {
namespace mobject {
namespace builder {
/**
* 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 (automation) in the Session.
* Questions regarding the possibility of a media stream connection are
* delegated internally to the STypeManager.
* \par
* The primary service of the connection manager is to accept a wiring request
* and handle the details of establishing the necessary connections.
*/
class ConManager
{
public:
/**
* TODO just a design sketch, work out signatures etc...
*/
int getConnection () ;
};
}}} // namespace proc::mobject::builder
#endif