PluginSpan Class Reference

Span of plugins that offers helper methods. More...

#include <src/gui/dsp/plugin_span.h>

Inheritance diagram for PluginSpan:

Collaboration diagram for PluginSpan:

Public Types
using	Base = utils::UuidIdentifiableObjectView<plugins::PluginRegistry>
using	VariantType = typename Base::VariantType
using	PluginUuid = typename Base::UuidType
Public Types inherited from zrythm::utils::UuidIdentifiableObjectView< plugins::PluginRegistry >
using	UuidType
using	VariantType
using	UuidRefType

Public Member Functions
bool	contains_uninstantiated_due_to_failure () const
std::vector< VariantType >	create_snapshots (QObject &owner) const
	Creates a snapshot of the plugin collection.
bool	can_be_pasted (const plugins::PluginSlot &slot) const
	Returns whether the plugins can be pasted to the given slot.
Public Member Functions inherited from zrythm::utils::UuidIdentifiableObjectView< plugins::PluginRegistry >
	UuidIdentifiableObjectView (std::span< const VariantType > objects)
	Constructor for direct object range.
Iterator	begin () const
Iterator	end () const
VariantType	operator[] (size_t index) const
VariantType	front () const
VariantType	back () const
VariantType	at (size_t index) const
size_t	size () const
bool	empty () const
auto	get_elements_by_type () const
auto	as_base_type () const
bool	contains_type () const
auto	as_type () const
auto	get_elements_derived_from () const

Static Public Member Functions
static auto	name_projection (const VariantType &pl_var)
static auto	visible_projection (const VariantType &pl_var)
static auto	state_dir_projection (const VariantType &pl_var)
static auto	instantiation_failed_projection (const VariantType &pl_var)
Static Public Member Functions inherited from zrythm::utils::UuidIdentifiableObjectView< plugins::PluginRegistry >
static UuidType	uuid_projection (const VariantType &var)
static plugins::PluginRegistry::BaseType *	base_projection (const VariantType &var)
static auto	type_projection (const VariantType &var)
static auto	derived_from_type_projection (const VariantType &var)
static auto	type_transformation (const VariantType &var)
static auto	derived_from_type_transformation (const VariantType &var)

Detailed Description

Span of plugins that offers helper methods.

Definition at line 12 of file plugin_span.h.

Member Typedef Documentation

Base

using PluginSpan::Base = utils::UuidIdentifiableObjectView<plugins::PluginRegistry>

Definition at line 16 of file plugin_span.h.

PluginUuid

using PluginSpan::PluginUuid = typename Base::UuidType

Definition at line 18 of file plugin_span.h.

VariantType

using PluginSpan::VariantType = typename Base::VariantType

Definition at line 17 of file plugin_span.h.

Member Function Documentation

contains_uninstantiated_due_to_failure()

bool PluginSpan::contains_uninstantiated_due_to_failure ( ) const

inline

Definition at line 44 of file plugin_span.h.

create_snapshots()

std::vector< VariantType > PluginSpan::create_snapshots ( QObject & owner ) const

inline

Creates a snapshot of the plugin collection.

Intended to be used in undoable actions.

Returns

A vector of plugin variants.

Definition at line 56 of file plugin_span.h.

instantiation_failed_projection()

auto PluginSpan::instantiation_failed_projection ( const VariantType & pl_var )

inlinestatic

Definition at line 34 of file plugin_span.h.

name_projection()

auto PluginSpan::name_projection ( const VariantType & pl_var )

inlinestatic

Definition at line 21 of file plugin_span.h.

state_dir_projection()

auto PluginSpan::state_dir_projection ( const VariantType & pl_var )

inlinestatic

Definition at line 29 of file plugin_span.h.

visible_projection()

auto PluginSpan::visible_projection ( const VariantType & pl_var )

inlinestatic

Definition at line 25 of file plugin_span.h.

---

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

• src/gui/dsp/plugin_span.h