Files
oak-editor/app/node/block/block.h
T
itsmattkc bc0f01d9a3 make nodes more const friendly and prepare their functions for stateless work
Since the nodes won't be holding any rendering data themselves in this system,
we may as well enforce some level of non-write access by setting all the
functions to const. They were already const-friendly, they just weren't
labelled as such.
2019-12-04 20:10:42 +11:00

123 lines
3.1 KiB
C++

/***
Olive - Non-Linear Video Editor
Copyright (C) 2019 Olive Team
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 3 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, see <http://www.gnu.org/licenses/>.
***/
#ifndef BLOCK_H
#define BLOCK_H
#include "node/node.h"
/**
* @brief A Node that represents a block of time, also displayable on a Timeline
*
* This is an abstract function. Since different types of Block will provide their lengths in different ways, it's
* necessary to subclass and override the length() function for a Block to be usable.
*
* When overriding Node::copy(), the derivative class should also call Block::CopyParameters() on the new Block instance
* which will copy the block's name, length, and media in point. It does not copy any node-specific parameters like any
* input values or connections as per standard with Node::copy().
*/
class Block : public Node
{
Q_OBJECT
public:
Block();
enum Type {
kClip,
kGap,
kTrack
};
virtual Type type() const = 0;
virtual QString Category() const override;
const rational& in() const;
const rational& out() const;
void set_in(const rational& in);
void set_out(const rational& out);
const rational &length() const;
void set_length(const rational &length);
void set_length_and_media_in(const rational &length);
Block* previous();
Block* next();
void set_previous(Block* previous);
void set_next(Block* next);
NodeOutput* buffer_output() const;
NodeOutput* block_output() const;
const rational& media_in() const;
void set_media_in(const rational& media_in);
const QString& block_name() const;
void set_block_name(const QString& name);
static void Link(Block* a, Block* b);
static void Link(QList<Block*> blocks);
static void Unlink(Block* a, Block* b);
static bool AreLinked(Block* a, Block* b);
const QVector<Block*>& linked_clips();
bool HasLinks();
virtual bool IsBlock() const override;
public slots:
signals:
/**
* @brief Signal emitted when this Block is refreshed
*
* Can be used as essentially a "changed" signal for UI widgets to know when to update their views
*/
void Refreshed();
void LengthChanged(const rational& length);
protected:
rational SequenceToMediaTime(const rational& sequence_time) const;
rational MediaToSequenceTime(const rational& media_time) const;
static void CopyParameters(const Block *source, Block* dest);
Block* previous_;
Block* next_;
private:
NodeOutput* block_output_;
NodeOutput* buffer_output_;
rational length_;
rational media_in_;
rational in_point_;
rational out_point_;
QString block_name_;
QVector<Block*> linked_clips_;
};
#endif // BLOCK_H