A class encapsulating a group of AudioProcessorParameters and nested AudioProcessorParameterGroups. More...

#include <juce_AudioProcessorParameterGroup.h>

Collaboration diagram for juce::AudioProcessorParameterGroup:

[legend]

Classes
class	AudioProcessorParameterNode
	A child of an AudioProcessorParameterGroup. More...

Public Member Functions
	AudioProcessorParameterGroup ()
	Creates an empty AudioProcessorParameterGroup with no name or ID. More...

	AudioProcessorParameterGroup (AudioProcessorParameterGroup &&)
	Once a group has been added to an AudioProcessor don't try to mutate it by moving or swapping it - this will crash most hosts. More...

	AudioProcessorParameterGroup (String groupID, String groupName, String subgroupSeparator)
	Creates an empty AudioProcessorParameterGroup. More...

template<typename ParameterOrGroup >
	AudioProcessorParameterGroup (String groupID, String groupName, String subgroupSeparator, std::unique_ptr< ParameterOrGroup > child)
	Creates an AudioProcessorParameterGroup with a single child. More...

template<typename ParameterOrGroup , typename... Args>
	AudioProcessorParameterGroup (String groupID, String groupName, String subgroupSeparator, std::unique_ptr< ParameterOrGroup > firstChild, Args &&... remainingChildren)
	Creates an AudioProcessorParameterGroup with multiple children. More...

	~AudioProcessorParameterGroup ()
	Destructor. More...

template<typename ParameterOrGroup >
void	addChild (std::unique_ptr< ParameterOrGroup > child)
	Adds a child to the group. More...

template<typename ParameterOrGroup , typename... Args>
void	addChild (std::unique_ptr< ParameterOrGroup > firstChild, Args &&... remainingChildren)
	Adds multiple parameters or sub-groups to this group. More...

const AudioProcessorParameterNode const	begin () const noexcept

const AudioProcessorParameterNode const	end () const noexcept

Array< const AudioProcessorParameterGroup * >	getGroupsForParameter (AudioProcessorParameter *) const
	Searches this group recursively for a parameter and returns a depth ordered list of the groups it belongs to. More...

String	getID () const
	Returns the group's ID. More...

String	getName () const
	Returns the group's name. More...

Array< AudioProcessorParameter * >	getParameters (bool recursive) const
	Returns all the parameters in this group. More...

const AudioProcessorParameterGroup *	getParent () const noexcept
	Returns the parent of the group, or nullptr if this is a top-level group. More...

String	getSeparator () const
	Returns the group's separator string. More...

Array< const AudioProcessorParameterGroup * >	getSubgroups (bool recursive) const
	Returns all subgroups of this group. More...

AudioProcessorParameterGroup &	operator= (AudioProcessorParameterGroup &&)
	Once a group has been added to an AudioProcessor don't try to mutate it by moving or swapping it - this will crash most hosts. More...

void	setName (String newName)
	Changes the name of the group. More...

Private Member Functions
void	append (std::unique_ptr< AudioProcessorParameter >)

void	append (std::unique_ptr< AudioProcessorParameterGroup >)

const AudioProcessorParameterGroup *	getGroupForParameter (AudioProcessorParameter *) const

void	getParameters (Array< AudioProcessorParameter * > &, bool recursive) const

void	getSubgroups (Array< const AudioProcessorParameterGroup * > &, bool recursive) const

void	updateChildParentage ()

Private Attributes
OwnedArray< AudioProcessorParameterNode >	children

String	identifier

String	name

AudioProcessorParameterGroup *	parent = nullptr

String	separator

Detailed Description

A class encapsulating a group of AudioProcessorParameters and nested AudioProcessorParameterGroups.

This class is predominantly write-only; there are methods for adding group members but none for removing them. Ultimately you will probably want to add a fully constructed group to an AudioProcessor.

See also: AudioProcessor::addParameterGroup

@tags{Audio}

Constructor & Destructor Documentation

◆ AudioProcessorParameterGroup() [1/5]

juce::AudioProcessorParameterGroup::AudioProcessorParameterGroup ( )

Creates an empty AudioProcessorParameterGroup with no name or ID.

◆ AudioProcessorParameterGroup() [2/5]

juce::AudioProcessorParameterGroup::AudioProcessorParameterGroup	(	String	groupID,
		String	groupName,
		String	subgroupSeparator
	)

Creates an empty AudioProcessorParameterGroup.

Parameters

groupID	A unique identifier for the group. Keep it basic; don't use any special characters like "." and avoid pure integer strings which could collide with legacy parameter IDs.
groupName	The group's name, which will be displayed in the host.
subgroupSeparator	A separator string to use between the name of this group and the name of any subgroups if this group is flattened. AUv3 and VST3 plug-ins can have multiple layers of nested subgroups, but AU plug-ins cannot have any subgroups.

◆ AudioProcessorParameterGroup() [3/5]

template<typename ParameterOrGroup >

juce::AudioProcessorParameterGroup::AudioProcessorParameterGroup	(	String	groupID,
		String	groupName,
		String	subgroupSeparator,
		std::unique_ptr< ParameterOrGroup >	child
	)

inline

Creates an AudioProcessorParameterGroup with a single child.

Parameters

groupID	A unique identifier for the group. Keep it basic; don't use any special characters like "." and avoid pure integer strings which could collide with legacy parameter IDs.
groupName	The group's name, which will be displayed in the host.
subgroupSeparator	A separator string to use between the name of this group and the name of any subgroups if this group is flattened. AUv3 and VST3 plug-ins can have multiple layers of nested subgroups, but AU plug-ins cannot have any subgroups.
child	An AudioProcessorParameter or an AudioProcessorParameterGroup to add to the group.

References addChild().

◆ AudioProcessorParameterGroup() [4/5]

template<typename ParameterOrGroup , typename... Args>

juce::AudioProcessorParameterGroup::AudioProcessorParameterGroup	(	String	groupID,
		String	groupName,
		String	subgroupSeparator,
		std::unique_ptr< ParameterOrGroup >	firstChild,
		Args &&...	remainingChildren
	)

inline

Creates an AudioProcessorParameterGroup with multiple children.

Parameters

groupID	A unique identifier for the group. Keep it basic; don't use any special characters like "." and avoid pure integer strings which could collide with legacy parameter IDs.
groupName	The group's name, which will be displayed in the host.
subgroupSeparator	A separator string to use between the name of this group and the name of any subgroups if this group is flattened. AUv3 and VST3 plug-ins can have multiple layers of nested subgroups, but AU plug-ins cannot have any subgroups.
firstChild	An AudioProcessorParameter or an AudioProcessorParameterGroup to add to the group.
remainingChildren	A list of more AudioProcessorParameters or AudioProcessorParameterGroups to add to the group.

References addChild().

◆ AudioProcessorParameterGroup() [5/5]

juce::AudioProcessorParameterGroup::AudioProcessorParameterGroup ( AudioProcessorParameterGroup && )

Once a group has been added to an AudioProcessor don't try to mutate it by moving or swapping it - this will crash most hosts.

◆ ~AudioProcessorParameterGroup()

juce::AudioProcessorParameterGroup::~AudioProcessorParameterGroup ( )

Destructor.

Member Function Documentation

◆ addChild() [1/2]

template<typename ParameterOrGroup >

void juce::AudioProcessorParameterGroup::addChild ( std::unique_ptr< ParameterOrGroup > child )

inline

Adds a child to the group.

Do not add children to a group which has itself already been added to the AudioProcessor - the new elements will be ignored.

References append().

Referenced by addChild(), and AudioProcessorParameterGroup().

◆ addChild() [2/2]

template<typename ParameterOrGroup , typename... Args>

void juce::AudioProcessorParameterGroup::addChild	(	std::unique_ptr< ParameterOrGroup >	firstChild,
		Args &&...	remainingChildren
	)

inline

Adds multiple parameters or sub-groups to this group.

Do not add children to a group which has itself already been added to the AudioProcessor - the new elements will be ignored.

References addChild().

◆ append() [1/2]

void juce::AudioProcessorParameterGroup::append ( std::unique_ptr< AudioProcessorParameter > )

private

Referenced by addChild().

◆ append() [2/2]

void juce::AudioProcessorParameterGroup::append ( std::unique_ptr< AudioProcessorParameterGroup > )

private

◆ begin()

const AudioProcessorParameterNode* const* juce::AudioProcessorParameterGroup::begin ( ) const

noexcept

◆ end()

const AudioProcessorParameterNode* const* juce::AudioProcessorParameterGroup::end ( ) const

noexcept

◆ getGroupForParameter()

const AudioProcessorParameterGroup* juce::AudioProcessorParameterGroup::getGroupForParameter ( AudioProcessorParameter * ) const

private

◆ getGroupsForParameter()

Array<const AudioProcessorParameterGroup*> juce::AudioProcessorParameterGroup::getGroupsForParameter ( AudioProcessorParameter * ) const

Searches this group recursively for a parameter and returns a depth ordered list of the groups it belongs to.

◆ getID()

String juce::AudioProcessorParameterGroup::getID ( ) const

Returns the group's ID.

◆ getName()

String juce::AudioProcessorParameterGroup::getName ( ) const

Returns the group's name.

◆ getParameters() [1/2]

void juce::AudioProcessorParameterGroup::getParameters	(	Array< AudioProcessorParameter * > &	,
		bool	recursive
	)		const

private

◆ getParameters() [2/2]

Array<AudioProcessorParameter*> juce::AudioProcessorParameterGroup::getParameters ( bool recursive ) const

Returns all the parameters in this group.

Parameters

recursive If this is true then this method will fetch all nested parameters using a depth first search.

◆ getParent()

const AudioProcessorParameterGroup* juce::AudioProcessorParameterGroup::getParent ( ) const

noexcept

Returns the parent of the group, or nullptr if this is a top-level group.

◆ getSeparator()

String juce::AudioProcessorParameterGroup::getSeparator ( ) const

Returns the group's separator string.

◆ getSubgroups() [1/2]

void juce::AudioProcessorParameterGroup::getSubgroups	(	Array< const AudioProcessorParameterGroup * > &	,
		bool	recursive
	)		const

private

◆ getSubgroups() [2/2]

Array<const AudioProcessorParameterGroup*> juce::AudioProcessorParameterGroup::getSubgroups ( bool recursive ) const

Returns all subgroups of this group.

Parameters

recursive If this is true then this method will fetch all nested subgroups using a depth first search.

◆ operator=()

AudioProcessorParameterGroup& juce::AudioProcessorParameterGroup::operator= ( AudioProcessorParameterGroup && )

Once a group has been added to an AudioProcessor don't try to mutate it by moving or swapping it - this will crash most hosts.

◆ setName()

void juce::AudioProcessorParameterGroup::setName ( String newName )

Changes the name of the group.

If you do this after the group has been added to an AudioProcessor, call updateHostDisplay() to inform the host of the change. Not all hosts support dynamic group name changes.

◆ updateChildParentage()

void juce::AudioProcessorParameterGroup::updateChildParentage ( )

private

Member Data Documentation

◆ children

OwnedArray<AudioProcessorParameterNode> juce::AudioProcessorParameterGroup::children

private

◆ identifier

String juce::AudioProcessorParameterGroup::identifier

private

◆ name

String juce::AudioProcessorParameterGroup::name

private

◆ parent

AudioProcessorParameterGroup* juce::AudioProcessorParameterGroup::parent = nullptr

private

◆ separator

String juce::AudioProcessorParameterGroup::separator

private

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

juce_AudioProcessorParameterGroup.h

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AudioProcessorParameterGroup() [1/5]

◆ AudioProcessorParameterGroup() [2/5]

◆ AudioProcessorParameterGroup() [3/5]

◆ AudioProcessorParameterGroup() [4/5]

◆ AudioProcessorParameterGroup() [5/5]

◆ ~AudioProcessorParameterGroup()

Member Function Documentation

◆ addChild() [1/2]

◆ addChild() [2/2]

◆ append() [1/2]

◆ append() [2/2]

◆ begin()

◆ end()

◆ getGroupForParameter()

◆ getGroupsForParameter()

◆ getID()

◆ getName()

◆ getParameters() [1/2]

◆ getParameters() [2/2]

◆ getParent()

◆ getSeparator()

◆ getSubgroups() [1/2]

◆ getSubgroups() [2/2]

◆ operator=()

◆ setName()

◆ updateChildParentage()

Member Data Documentation

◆ children

◆ identifier

◆ name

◆ parent

◆ separator