The SFModulatorItem class represents a modulator. More...

#include <modulator_item.hpp>

Public Member Functions
	SFModulatorItem ()
	Constructs a new SFModulatorItem.

	SFModulatorItem (SFModulator source_op, SFGenerator destination_op, int16_t amount, SFModulator amount_source_op, SFTransform transform_op)
	Constructs a new SFModulatorItem using the specified controllers. More...

	SFModulatorItem (const SFModulatorItem &origin)=default
	Constructs a new copy of specified SFModulatorItem. More...

SFModulatorItem &	operator= (const SFModulatorItem &origin)=default
	Copy-assigns a new value to the SFModulatorItem, replacing its current contents. More...

	SFModulatorItem (SFModulatorItem &&origin)=default
	Acquires the contents of specified SFModulatorItem. More...

SFModulatorItem &	operator= (SFModulatorItem &&origin)=default
	Move-assigns a new value to the SFModulatorItem, replacing its current contents. More...

	~SFModulatorItem ()=default
	Destructs the SFModulatorItem.

SFModulatorKey	key () const noexcept
	Returns the unique key of the modulator. More...

void	set_key (SFModulatorKey key)
	Sets the unique key of the modulator. More...

SFModulator	source_op () const noexcept
	Returns the source of data for the modulator. More...

void	set_source_op (SFModulator source_op)
	Sets the source of data for the modulator. More...

SFGenerator	destination_op () const noexcept
	Returns the destination of the modulator. More...

void	set_destination_op (SFGenerator destination_op)
	Sets the destination of the modulator. More...

int16_t	amount () const noexcept
	Returns the constant of modulation amount. More...

void	set_amount (int16_t amount)
	Sets the constant of modulation amount. More...

SFModulator	amount_source_op () const noexcept
	Returns the modulation source to be applied to the modulation amount. More...

void	set_amount_source_op (SFModulator amount_source_op)
	Sets the modulation source to be applied to the modulation amount. More...

SFTransform	transform_op () const noexcept
	Returns the transform type to be applied to the modulation source. More...

void	set_transform_op (SFTransform transform_op)
	Sets the transform type to be applied to the modulation source. More...

Detailed Description

The SFModulatorItem class represents a modulator.

Remarks: This class represents the official sfModList/sfInstModList type.

See also: "7.4 The PMOD Sub-chunk". In SoundFont Technical Specification 2.04.; "7.8 The IMOD Sub-chunk". In SoundFont Technical Specification 2.04.

Constructor & Destructor Documentation

sf2cute::SFModulatorItem::SFModulatorItem	(	SFModulator	source_op,
		SFGenerator	destination_op,
		int16_t	amount,
		SFModulator	amount_source_op,
		SFTransform	transform_op
	)

Constructs a new SFModulatorItem using the specified controllers.

Parameters

source_op	the source of data for the modulator.
destination_op	the destination of the modulator.
amount	the degree to which the source modulates the destination.
amount_source_op	the modulation source to be applied to the modulation amount.
transform_op	the transform type to be applied to the modulation source.

sf2cute::SFModulatorItem::SFModulatorItem ( const SFModulatorItem & origin )

default

Constructs a new copy of specified SFModulatorItem.

Parameters

origin a SFModulatorItem object.

sf2cute::SFModulatorItem::SFModulatorItem ( SFModulatorItem && origin )

default

Acquires the contents of specified SFModulatorItem.

Parameters

origin a SFModulatorItem object.

Member Function Documentation

int16_t sf2cute::SFModulatorItem::amount ( ) const

noexcept

Returns the constant of modulation amount.

Returns: the constant of modulation amount.

SFModulator sf2cute::SFModulatorItem::amount_source_op ( ) const

noexcept

Returns the modulation source to be applied to the modulation amount.

Returns: the modulation source to be applied to the modulation amount.

SFGenerator sf2cute::SFModulatorItem::destination_op ( ) const

noexcept

Returns the destination of the modulator.

Returns: the destination of the modulator.

SFModulatorKey sf2cute::SFModulatorItem::key ( ) const

noexcept

Returns the unique key of the modulator.

Returns: the unique key of the modulator.

Remarks: Using source_op(), destination_op() or amount_source_op() is recommended for an individual member access.

See also: source_op(); destination_op(); amount_source_op()

SFModulatorItem& sf2cute::SFModulatorItem::operator= ( const SFModulatorItem & origin )

default

Copy-assigns a new value to the SFModulatorItem, replacing its current contents.

Parameters

origin a SFModulatorItem object.

SFModulatorItem& sf2cute::SFModulatorItem::operator= ( SFModulatorItem && origin )

default

Move-assigns a new value to the SFModulatorItem, replacing its current contents.

Parameters

origin a SFModulatorItem object.

void sf2cute::SFModulatorItem::set_amount ( int16_t amount )

Sets the constant of modulation amount.

Parameters

amount the degree to which the source modulates the destination.

void sf2cute::SFModulatorItem::set_amount_source_op ( SFModulator amount_source_op )

Sets the modulation source to be applied to the modulation amount.

Parameters

amount_source_op the modulation source to be applied to the modulation amount.

void sf2cute::SFModulatorItem::set_destination_op ( SFGenerator destination_op )

Sets the destination of the modulator.

Parameters

destination_op the destination of the modulator.

void sf2cute::SFModulatorItem::set_key ( SFModulatorKey key )

Sets the unique key of the modulator.

Parameters

key	the unique key of the modulator.

Remarks: Using set_source_op(SFModulator), set_destination_op(SFGenerator) or set_amount_source_op(SFModulator) is recommended for an individual member access.

See also: set_source_op(SFModulator); set_destination_op(SFGenerator); set_amount_source_op(SFModulator)

void sf2cute::SFModulatorItem::set_source_op ( SFModulator source_op )

Sets the source of data for the modulator.

Parameters

source_op the source of data for the modulator.

void sf2cute::SFModulatorItem::set_transform_op ( SFTransform transform_op )

Sets the transform type to be applied to the modulation source.

Parameters

transform_op the transform type to be applied to the modulation source.

SFModulator sf2cute::SFModulatorItem::source_op ( ) const

noexcept

Returns the source of data for the modulator.

Returns: the source of data for the modulator.

SFTransform sf2cute::SFModulatorItem::transform_op ( ) const

noexcept

Returns the transform type to be applied to the modulation source.

Returns: the transform type to be applied to the modulation source.

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

include/sf2cute/modulator_item.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation