LUMIERA.clone/src/steam/fixture/node-graph-attachment.hpp
Ichthyostega 806db414dd Copyright: clarify and simplify the file headers
* Lumiera source code always was copyrighted by individual contributors
 * there is no entity "Lumiera.org" which holds any copyrights
 * Lumiera source code is provided under the GPL Version 2+

== Explanations ==
Lumiera as a whole is distributed under Copyleft, GNU General Public License Version 2 or above.
For this to become legally effective, the ''File COPYING in the root directory is sufficient.''

The licensing header in each file is not strictly necessary, yet considered good practice;
attaching a licence notice increases the likeliness that this information is retained
in case someone extracts individual code files. However, it is not by the presence of some
text, that legally binding licensing terms become effective; rather the fact matters that a
given piece of code was provably copyrighted and published under a license. Even reformatting
the code, renaming some variables or deleting parts of the code will not alter this legal
situation, but rather creates a derivative work, which is likewise covered by the GPL!

The most relevant information in the file header is the notice regarding the
time of the first individual copyright claim. By virtue of this initial copyright,
the first author is entitled to choose the terms of licensing. All further
modifications are permitted and covered by the License. The specific wording
or format of the copyright header is not legally relevant, as long as the
intention to publish under the GPL remains clear. The extended wording was
based on a recommendation by the FSF. It can be shortened, because the full terms
of the license are provided alongside the distribution, in the file COPYING.
2024-11-17 23:42:55 +01:00

86 lines
2.8 KiB
C++
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*
NODE-GRAPH-ATTACHMENT.hpp - Binding from a Fixture-Segment into the low-level-Model
Copyright (C)
2023, Hermann Vosseler <Ichthyostega@web.de>
  **Lumiera** 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. See the file COPYING for further details.
*/
/** @file node-graph-attachment.hpp
** Link from the Fixture datastructure into the render node network.
** The Segmentation is a partitioning of the effective timeline into segments with
** uniform processing structure; however this structure itself is defined as a graph
** of [render nodes](\ref engine::ProcNode); any specifics and decisions how rendering
** actually happens are represented in the way some ModelPort is connected to the model,
** which is the purpose of this binding object, stored as part of each Segment.
**
** @todo 2023 WIP-WIP-WIP »Playback Vertical Slice« need at least a drafted model
*/
#ifndef STEAM_FIXTURE_NODE_GRAPH_ATTACHMENT_H
#define STEAM_FIXTURE_NODE_GRAPH_ATTACHMENT_H
#include "steam/engine/exit-node.hpp"
//#include "lib/time/timevalue.hpp"
#include "lib/util.hpp"
#include <utility>
namespace steam {
namespace fixture {
using engine::ExitNode;
using engine::ExitNodes;
/**
* Binding and access point from a given Segment to access the actual render nodes.
* For each ModelPort, we can expect to get an ExitNode (the number of ports is fixed
* for the complete Timeline). However, this ExitNode does not need to be active, since
* parts of the timeline can be empty, or partially empty for some ModelPort.
* @warning while this descriptor object is freely copyable, the referred ExitNode(s) are
* move-only, and will be referred by the JobTicket. Thus a Segment in the Fixture
* must remain fixed in memory as long as any derived render jobs are alive.
*
* @todo WIP-WIP as of 4/2023 -- starting with a fake implementation /////////////////////TICKET #1306 : create an actual link to the low-level Model
*/
class NodeGraphAttachment
{
ExitNodes exitNodes_;
public:
NodeGraphAttachment()
: exitNodes_{}
{ }
NodeGraphAttachment (ExitNodes&& exitNodes)
: exitNodes_{std::move (exitNodes)}
{ }
// default copy acceptable
ExitNode const&
operator[] (size_t idx) const
{
return idx < exitNodes_.size()? exitNodes_[idx]
: ExitNode::NIL;
}
bool
empty() const
{
return util::isnil (exitNodes_);
}
};
}} // namespace steam::fixture
#endif /*STEAM_FIXTURE_NODE_GRAPH_ATTACHMENT_H*/