#include <Clip.h>

Inheritance diagram for lmms::Clip:

Public Slots
void	toggleMute ()
	Mutes this Clip.

Signals
void	lengthChanged ()
void	positionChanged ()
void	destroyedClip ()
void	colorChanged ()
Signals inherited from lmms::Model
void	dataChanged ()
void	dataUnchanged ()
void	propertiesChanged ()

Public Member Functions
	Clip (Track *track)
	Creates a new clip for the given track `track`.
	~Clip () override
	Destroys the given clip.
Track *	getTrack () const
const QString &	name () const
void	setName (const QString &name)
QString	displayName () const override
const TimePos &	startPosition () const
TimePos	endPosition () const
const TimePos &	length () const
bool	hasTrackContainer () const
bool	isInPattern () const
bool	manuallyResizable () const
void	setAutoResize (const bool r)
	Set whether a clip has been resized yet by the user or the knife tool.
bool	getAutoResize () const
auto	color () const -> const std::optional< QColor > &
void	setColor (const std::optional< QColor > &color)
virtual void	movePosition (const TimePos &pos)
	Move this Clip's position in time.
virtual void	changeLength (const TimePos &length)
	Change the length of this Clip.
virtual void	updateLength ()
virtual gui::ClipView *	createView (gui::TrackView *tv)=0
void	selectViewOnCreate (bool select)
bool	getSelectViewOnCreate ()
TimePos	startTimeOffset () const
virtual void	setStartTimeOffset (const TimePos &startTimeOffset)
virtual Clip *	clone ()=0
	Creates a copy of this clip.
Public Member Functions inherited from lmms::Model
	Model (Model *parent, QString displayName=QString(), bool defaultConstructed=false)
	~Model () override=default
bool	isDefaultConstructed () const
Model *	parentModel () const
virtual void	setDisplayName (const QString &displayName)
virtual QString	fullDisplayName () const
Public Member Functions inherited from lmms::JournallingObject
	JournallingObject ()
	~JournallingObject () override
jo_id_t	id () const
void	saveJournallingState (const bool newState)
void	restoreJournallingState ()
void	addJournalCheckPoint ()
QDomElement	saveState (QDomDocument &_doc, QDomElement &_parent) override
void	restoreState (const QDomElement &_this) override
bool	isJournalling () const
void	setJournalling (const bool _sr)
bool	testAndSetJournalling (const bool newState)
bool	isJournallingStateStackEmpty () const
Public Member Functions inherited from lmms::SerializingObject
	SerializingObject ()
virtual	~SerializingObject ()
virtual QString	nodeName () const =0
void	setHook (SerializingObjectHook *_hook)
SerializingObjectHook *	hook ()

Static Public Member Functions
static bool	comparePosition (const Clip a, const Clip b)
	Returns true if and only if a->startPosition() < b->startPosition().
static void	copyStateTo (Clip src, Clip dst)
	Copies the state of a clip to another clip.

Protected Member Functions
	Clip (const Clip &other)
	Creates a duplicate clip of the one provided.
Protected Member Functions inherited from lmms::JournallingObject
void	changeID (jo_id_t _id)
Protected Member Functions inherited from lmms::SerializingObject
virtual void	saveSettings (QDomDocument &doc, QDomElement &element)=0
virtual void	loadSettings (const QDomElement &element)=0

Private Member Functions
	mapPropertyFromModel (bool, isMuted, setMuted, m_mutedModel)
	mapPropertyFromModel (bool, isSolo, setSolo, m_soloModel)

Private Attributes
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

Friends
class	ClipView

Constructor & Destructor Documentation

◆ Clip() [1/2]

lmms::Clip::Clip ( Track * track )

Creates a new clip for the given track track.

Parameters

track The track that will contain the new object

◆ ~Clip()

lmms::Clip::~Clip ( )

override

Destroys the given clip.

◆ Clip() [2/2]

lmms::Clip::Clip ( const Clip & other )

protected

Creates a duplicate clip of the one provided.

Parameters

other The clip object which will be copied.

Member Function Documentation

◆ changeLength()

void lmms::Clip::changeLength ( const TimePos & length )

virtual

Change the length of this Clip.

If the clip's length has changed, update it. We also add a journal entry for undo and update the display.

Parameters

length The new length of the clip.

Reimplemented in lmms::SampleClip.

◆ clone()

virtual Clip * lmms::Clip::clone ( )

pure virtual

Creates a copy of this clip.

Returns: Pointer to the new clip object

Implemented in lmms::AutomationClip, lmms::MidiClip, lmms::PatternClip, and lmms::SampleClip.

◆ color()

auto lmms::Clip::color ( ) const -> const std::optional< QColor > &

inline

◆ colorChanged

void lmms::Clip::colorChanged ( )

signal

◆ comparePosition()

bool lmms::Clip::comparePosition	(	const Clip *	a,
		const Clip *	b )

static

Returns true if and only if a->startPosition() < b->startPosition().

◆ copyStateTo()

void lmms::Clip::copyStateTo	(	Clip *	src,
		Clip *	dst )

static

Copies the state of a clip to another clip.

◆ createView()

virtual gui::ClipView * lmms::Clip::createView ( gui::TrackView * tv )

pure virtual

Implemented in lmms::AutomationClip, lmms::MidiClip, lmms::PatternClip, and lmms::SampleClip.

◆ destroyedClip

void lmms::Clip::destroyedClip ( )

signal

◆ displayName()

QString lmms::Clip::displayName ( ) const

inlineoverridevirtual

Reimplemented from lmms::Model.

◆ endPosition()

TimePos lmms::Clip::endPosition ( ) const

inline

◆ getAutoResize()

bool lmms::Clip::getAutoResize ( ) const

inline

◆ getSelectViewOnCreate()

bool lmms::Clip::getSelectViewOnCreate ( )

inline

◆ getTrack()

Track * lmms::Clip::getTrack ( ) const

inline

◆ hasTrackContainer()

bool lmms::Clip::hasTrackContainer ( ) const

◆ isInPattern()

bool lmms::Clip::isInPattern ( ) const

◆ length()

const TimePos & lmms::Clip::length ( ) const

inline

◆ lengthChanged

void lmms::Clip::lengthChanged ( )

signal

◆ manuallyResizable()

bool lmms::Clip::manuallyResizable ( ) const

◆ mapPropertyFromModel() [1/2]

lmms::Clip::mapPropertyFromModel	(	bool	,
		isMuted	,
		setMuted	,
		m_mutedModel	)

private

◆ mapPropertyFromModel() [2/2]

lmms::Clip::mapPropertyFromModel	(	bool	,
		isSolo	,
		setSolo	,
		m_soloModel	)

private

◆ movePosition()

void lmms::Clip::movePosition ( const TimePos & pos )

virtual

Move this Clip's position in time.

If the clip has moved, update its position. We also add a journal entry for undo and update the display.

Parameters

pos	The new position of the clip.

◆ name()

const QString & lmms::Clip::name ( ) const

inline

◆ positionChanged

void lmms::Clip::positionChanged ( )

signal

◆ selectViewOnCreate()

void lmms::Clip::selectViewOnCreate ( bool select )

inline

◆ setAutoResize()

void lmms::Clip::setAutoResize ( const bool r )

inline

Set whether a clip has been resized yet by the user or the knife tool.

If a clip has been resized previously, it will not automatically resize when editing it.

◆ setColor()

void lmms::Clip::setColor ( const std::optional< QColor > & color )

◆ setName()

void lmms::Clip::setName ( const QString & name )

inline

◆ setStartTimeOffset()

void lmms::Clip::setStartTimeOffset ( const TimePos & startTimeOffset )

virtual

Reimplemented in lmms::SampleClip.

◆ startPosition()

const TimePos & lmms::Clip::startPosition ( ) const

inline

◆ startTimeOffset()

TimePos lmms::Clip::startTimeOffset ( ) const

◆ toggleMute

void lmms::Clip::toggleMute ( )

slot

Mutes this Clip.

◆ updateLength()

virtual void lmms::Clip::updateLength ( )

inlinevirtual

Reimplemented in lmms::AutomationClip, lmms::MidiClip, and lmms::SampleClip.

◆ ClipView

friend class ClipView

friend

Member Data Documentation

◆ m_autoResize

bool lmms::Clip::m_autoResize = true

private

◆ m_color

std::optional<QColor> lmms::Clip::m_color

private

◆ m_length

TimePos lmms::Clip::m_length

private

◆ m_mutedModel

BoolModel lmms::Clip::m_mutedModel

private

◆ m_name

QString lmms::Clip::m_name

private

◆ m_selectViewOnCreate

bool lmms::Clip::m_selectViewOnCreate

private

◆ m_soloModel

BoolModel lmms::Clip::m_soloModel

private

◆ m_startPosition

TimePos lmms::Clip::m_startPosition

private

◆ m_startTimeOffset

TimePos lmms::Clip::m_startTimeOffset

private

◆ m_track

Track* lmms::Clip::m_track

private

The documentation for this class was generated from the following files:

include/Clip.h
src/core/Clip.cpp

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Constructor & Destructor Documentation

◆ Clip() [1/2]

◆ ~Clip()

◆ Clip() [2/2]

Member Function Documentation

◆ changeLength()

◆ clone()

◆ color()

◆ colorChanged

◆ comparePosition()

◆ copyStateTo()

◆ createView()

◆ destroyedClip

◆ displayName()

◆ endPosition()

◆ getAutoResize()

◆ getSelectViewOnCreate()

◆ getTrack()

◆ hasTrackContainer()

◆ isInPattern()

◆ length()

◆ lengthChanged

◆ manuallyResizable()

◆ mapPropertyFromModel() [1/2]

◆ mapPropertyFromModel() [2/2]

◆ movePosition()

◆ name()

◆ positionChanged

◆ selectViewOnCreate()

◆ setAutoResize()

◆ setColor()

◆ setName()

◆ setStartTimeOffset()

◆ startPosition()

◆ startTimeOffset()

◆ toggleMute

◆ updateLength()

Friends And Related Symbol Documentation

◆ ClipView

Member Data Documentation

◆ m_autoResize

◆ m_color

◆ m_length

◆ m_mutedModel

◆ m_name

◆ m_selectViewOnCreate

◆ m_soloModel

◆ m_startPosition

◆ m_startTimeOffset

◆ m_track