Clip.h

Go to the documentation of this file.

/*
 * TrackConteintObject.h - declaration of Clip class
 *
 * Copyright (c) 2004-2014 Tobias Doerffel <tobydox/at/users.sourceforge.net>
 *
 * This file is part of LMMS - https://lmms.io
 *
 * 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 (see COPYING); if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301 USA.
 *
 */
 
#ifndef LMMS_CLIP_H
#define LMMS_CLIP_H
 
#include <optional>
 
#include <QColor>
 
#include "AutomatableModel.h"
 
 
namespace lmms
{
 
class Track;
 
namespace gui
{
 
class ClipView;
class TrackView;
 
} // namespace gui
 
 
class LMMS_EXPORT Clip : public Model, public JournallingObject
{
    Q_OBJECT
    mapPropertyFromModel(bool,isMuted,setMuted,m_mutedModel);
    mapPropertyFromModel(bool,isSolo,setSolo,m_soloModel);
public:
    Clip(Track* track);
    ~Clip() override; 
 
    inline Track * getTrack() const
    {
        return m_track;
    }
 
    inline const QString & name() const
    {
        return m_name;
    }
 
    inline void setName( const QString & name )
    {
        m_name = name;
        emit dataChanged();
    }
 
    QString displayName() const override
    {
        return name();
    }
 
 
    inline const TimePos & startPosition() const
    {
        return m_startPosition;
    }
 
    inline TimePos endPosition() const
    {
        const int sp = m_startPosition;
        return sp + m_length;
    }
 
    inline const TimePos & length() const
    {
        return m_length;
    }
 
 
    bool hasTrackContainer() const;
 
    bool isInPattern() const;
 
    bool manuallyResizable() const;

    void setAutoResize(const bool r) { m_autoResize = r; }
 
    bool getAutoResize() const
    {
        return m_autoResize;
    }
 
    auto color() const -> const std::optional<QColor>& { return m_color; }
    void setColor(const std::optional<QColor>& color);

    virtual void movePosition(const TimePos& pos);

    virtual void changeLength(const TimePos& length);
    virtual void updateLength() {};
 
    virtual gui::ClipView * createView( gui::TrackView * tv ) = 0;
 
    inline void selectViewOnCreate( bool select )
    {
        m_selectViewOnCreate = select;
    }
 
    inline bool getSelectViewOnCreate()
    {
        return m_selectViewOnCreate;
    }

    static bool comparePosition(const Clip* a, const Clip* b);
 
    TimePos startTimeOffset() const;
    virtual void setStartTimeOffset(const TimePos& startTimeOffset);

    static void copyStateTo(Clip* src, Clip* dst);

    virtual Clip* clone() = 0;
 
public slots:
    void toggleMute(); 
 
signals:
    void lengthChanged();
    void positionChanged();
    void destroyedClip();
    void colorChanged();
 
protected:

    Clip(const Clip& other);
 
private:
    Track * m_track;
    QString m_name;
 
    TimePos m_startPosition;
    TimePos m_length;
    TimePos m_startTimeOffset;
 
    BoolModel m_mutedModel;
    BoolModel m_soloModel;
    bool m_autoResize = true;
 
    bool m_selectViewOnCreate;
 
    std::optional<QColor> m_color;
 
    friend class ClipView;
};
 
 
} // namespace lmms
 
#endif // LMMS_CLIP_H