ID for objects of type EditElement - e.g. More...

#include "tracktion_EditItem.h"

Public Types
using	IDMap = std::map< EditItemID, EditItemID >

Public Member Functions
	EditItemID (const EditItemID &)=default

EditItemID &	operator= (const EditItemID &)=default

bool	isValid () const noexcept

bool	isInvalid () const noexcept

void	writeID (juce::ValueTree &, juce::UndoManager *) const

void	setProperty (juce::ValueTree &, const juce::Identifier &, juce::UndoManager *) const

void	setXML (juce::XmlElement &, const juce::Identifier &attributeName) const

void	setXML (juce::XmlElement &, const char *attributeName) const

	operator juce::var () const

juce::var	toVar () const

juce::String	toString () const

uint64_t	getRawID () const noexcept

bool	operator== (EditItemID other) const noexcept

bool	operator!= (EditItemID other) const noexcept

bool	operator< (EditItemID other) const noexcept

Static Public Member Functions
static EditItemID	fromID (const juce::ValueTree &)

static EditItemID	readOrCreateNewID (Edit &, const juce::ValueTree &)

static EditItemID	fromVar (const juce::var &)

static EditItemID	fromString (const juce::String &)

static EditItemID	fromProperty (const juce::ValueTree &, const juce::Identifier &)

static EditItemID	fromXML (const juce::XmlElement &, const char *attributeName)

static EditItemID	fromXML (const juce::XmlElement &, const juce::Identifier &)

static EditItemID	findFirstIDNotIn (const std::vector< EditItemID > &existingIDsSorted, uint64_t startFrom=1001)

static EditItemID	fromRawID (uint64_t)

static juce::Array< EditItemID >	parseStringList (const juce::String &list)

static juce::String	listToString (const juce::Array< EditItemID > &list)

static std::vector< EditItemID >	findAllIDs (const juce::XmlElement &)

static std::vector< EditItemID >	findAllIDs (const juce::ValueTree &)

static void	remapIDs (juce::XmlElement &, std::function< EditItemID()> createNewID, IDMap *remappedIDs=nullptr)

static void	remapIDs (juce::XmlElement &, Edit &, IDMap *remappedIDs=nullptr)

static void	remapIDs (juce::ValueTree &, juce::UndoManager , std::function< EditItemID()> createNewID, IDMap remappedIDs=nullptr)

static void	remapIDs (juce::ValueTree &, juce::UndoManager , Edit &, IDMap remappedIDs=nullptr)

Static Public Attributes
static std::function< void(juce::ValueTree &, const juce::Identifier &, const std::map< juce::String, EditItemID > &, juce::UndoManager *)>	applyNewIDsToExternalValueTree
	Callback that can be set in order to update any reassigned IDs in ValueTree client code.

static std::function< void(juce::XmlElement &, const juce::String &, const std::map< juce::String, EditItemID > &)>	applyNewIDsToExternalXML
	Callback that can be set in order to update any reassigned IDs in XML client code.

Detailed Description

ID for objects of type EditElement - e.g.

clips, tracks, plugins, etc

Definition at line 18 of file tracktion_EditItem.h.

Member Typedef Documentation

◆ IDMap

using tracktion::engine::EditItemID::IDMap = std::map<EditItemID, EditItemID>

Definition at line 62 of file tracktion_EditItem.h.

Member Function Documentation

◆ findAllIDs() [1/2]

std::vector< EditItemID > tracktion::engine::EditItemID::findAllIDs ( const juce::ValueTree & v )

static

Definition at line 352 of file tracktion_EditItem.cpp.

◆ findAllIDs() [2/2]

std::vector< EditItemID > tracktion::engine::EditItemID::findAllIDs ( const juce::XmlElement & xml )

static

Definition at line 337 of file tracktion_EditItem.cpp.

◆ findFirstIDNotIn()

EditItemID tracktion::engine::EditItemID::findFirstIDNotIn	(	const std::vector< EditItemID > &	existingIDsSorted,
		uint64_t	startFrom = `1001`
	)

static

Definition at line 64 of file tracktion_EditItem.cpp.

◆ fromID()

EditItemID tracktion::engine::EditItemID::fromID ( const juce::ValueTree & v )

static

Definition at line 30 of file tracktion_EditItem.cpp.

◆ fromProperty()

EditItemID tracktion::engine::EditItemID::fromProperty	(	const juce::ValueTree &	v,
		const juce::Identifier &	prop
	)

static

Definition at line 81 of file tracktion_EditItem.cpp.

◆ fromRawID()

EditItemID tracktion::engine::EditItemID::fromRawID ( uint64_t raw )

static

Definition at line 40 of file tracktion_EditItem.cpp.

◆ fromString()

EditItemID tracktion::engine::EditItemID::fromString ( const juce::String & s )

static

Definition at line 25 of file tracktion_EditItem.cpp.

◆ fromVar()

EditItemID tracktion::engine::EditItemID::fromVar ( const juce::var & v )

static

Definition at line 20 of file tracktion_EditItem.cpp.

◆ fromXML() [1/2]

EditItemID tracktion::engine::EditItemID::fromXML	(	const juce::XmlElement &	xml,
		const char *	attributeName
	)

static

Definition at line 86 of file tracktion_EditItem.cpp.

◆ fromXML() [2/2]

EditItemID tracktion::engine::EditItemID::fromXML	(	const juce::XmlElement &	xml,
		const juce::Identifier &	attributeName
	)

static

Definition at line 91 of file tracktion_EditItem.cpp.

◆ getRawID()

uint64_t tracktion::engine::EditItemID::getRawID ( ) const

noexcept

Definition at line 48 of file tracktion_EditItem.h.

◆ isInvalid()

bool tracktion::engine::EditItemID::isInvalid ( ) const

noexcept

Definition at line 25 of file tracktion_EditItem.h.

◆ isValid()

bool tracktion::engine::EditItemID::isValid ( ) const

noexcept

Definition at line 24 of file tracktion_EditItem.h.

◆ listToString()

juce::String tracktion::engine::EditItemID::listToString ( const juce::Array< EditItemID > & list )

static

Definition at line 146 of file tracktion_EditItem.cpp.

◆ operator juce::var()

tracktion::engine::EditItemID::operator juce::var ( ) const

Definition at line 44 of file tracktion_EditItem.h.

◆ operator!=()

bool tracktion::engine::EditItemID::operator!= ( EditItemID other ) const

noexcept

Definition at line 52 of file tracktion_EditItem.h.

◆ operator<()

bool tracktion::engine::EditItemID::operator< ( EditItemID other ) const

noexcept

Definition at line 53 of file tracktion_EditItem.h.

◆ operator==()

bool tracktion::engine::EditItemID::operator== ( EditItemID other ) const

noexcept

Definition at line 51 of file tracktion_EditItem.h.

◆ parseStringList()

juce::Array< EditItemID > tracktion::engine::EditItemID::parseStringList ( const juce::String & list )

static

Definition at line 134 of file tracktion_EditItem.cpp.

◆ readOrCreateNewID()

EditItemID tracktion::engine::EditItemID::readOrCreateNewID	(	Edit &	edit,
		const juce::ValueTree &	v
	)

static

Definition at line 121 of file tracktion_EditItem.cpp.

◆ remapIDs() [1/4]

void tracktion::engine::EditItemID::remapIDs	(	juce::ValueTree &	v,
		juce::UndoManager *	um,
		Edit &	ed,
		IDMap *	remappedIDs = `nullptr`
	)

static

Definition at line 450 of file tracktion_EditItem.cpp.

◆ remapIDs() [2/4]

void tracktion::engine::EditItemID::remapIDs	(	juce::ValueTree &	v,
		juce::UndoManager *	um,
		std::function< EditItemID()>	createNewID,
		IDMap *	remappedIDs = `nullptr`
	)

static

Definition at line 389 of file tracktion_EditItem.cpp.

◆ remapIDs() [3/4]

void tracktion::engine::EditItemID::remapIDs	(	juce::XmlElement &	xml,
		Edit &	ed,
		IDMap *	remappedIDs = `nullptr`
	)

static

Definition at line 444 of file tracktion_EditItem.cpp.

◆ remapIDs() [4/4]

void tracktion::engine::EditItemID::remapIDs	(	juce::XmlElement &	xml,
		std::function< EditItemID()>	createNewID,
		IDMap *	remappedIDs = `nullptr`
	)

static

Definition at line 367 of file tracktion_EditItem.cpp.

◆ setProperty()

void tracktion::engine::EditItemID::setProperty	(	juce::ValueTree &	v,
		const juce::Identifier &	prop,
		juce::UndoManager *	um
	)		const

Definition at line 96 of file tracktion_EditItem.cpp.

◆ setXML() [1/2]

void tracktion::engine::EditItemID::setXML	(	juce::XmlElement &	xml,
		const char *	attributeName
	)		const

Definition at line 106 of file tracktion_EditItem.cpp.

◆ setXML() [2/2]

void tracktion::engine::EditItemID::setXML	(	juce::XmlElement &	xml,
		const juce::Identifier &	attributeName
	)		const

Definition at line 101 of file tracktion_EditItem.cpp.

◆ toString()

juce::String tracktion::engine::EditItemID::toString ( ) const

Definition at line 116 of file tracktion_EditItem.cpp.

◆ toVar()

juce::var tracktion::engine::EditItemID::toVar ( ) const

Definition at line 111 of file tracktion_EditItem.cpp.

◆ writeID()

void tracktion::engine::EditItemID::writeID	(	juce::ValueTree &	v,
		juce::UndoManager *	um
	)		const

Definition at line 35 of file tracktion_EditItem.cpp.

Member Data Documentation

◆ applyNewIDsToExternalValueTree

std::function< void(juce::ValueTree &, const juce::Identifier &, const std::map< juce::String, EditItemID > &, juce::UndoManager *)> tracktion::engine::EditItemID::applyNewIDsToExternalValueTree

static

Callback that can be set in order to update any reassigned IDs in ValueTree client code.

Definition at line 72 of file tracktion_EditItem.h.

◆ applyNewIDsToExternalXML

std::function< void(juce::XmlElement &, const juce::String &, const std::map< juce::String, EditItemID > &)> tracktion::engine::EditItemID::applyNewIDsToExternalXML

static

Callback that can be set in order to update any reassigned IDs in XML client code.

Definition at line 76 of file tracktion_EditItem.h.

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

tracktion_engine/model/edit/tracktion_EditItem.h
tracktion_engine/model/edit/tracktion_EditItem.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ IDMap

Member Function Documentation

◆ findAllIDs() [1/2]

◆ findAllIDs() [2/2]

◆ findFirstIDNotIn()

◆ fromID()

◆ fromProperty()

◆ fromRawID()

◆ fromString()

◆ fromVar()

◆ fromXML() [1/2]

◆ fromXML() [2/2]

◆ getRawID()

◆ isInvalid()

◆ isValid()

◆ listToString()

◆ operator juce::var()

◆ operator!=()

◆ operator<()

◆ operator==()

◆ parseStringList()

◆ readOrCreateNewID()

◆ remapIDs() [1/4]

◆ remapIDs() [2/4]

◆ remapIDs() [3/4]

◆ remapIDs() [4/4]

◆ setProperty()

◆ setXML() [1/2]

◆ setXML() [2/2]

◆ toString()

◆ toVar()

◆ writeID()

Member Data Documentation

◆ applyNewIDsToExternalValueTree

◆ applyNewIDsToExternalXML