engine::ProjectItemID Class Reference

An ID representing one of the items in a Project. More...

#include <tracktion_ProjectItemID.h>

Public Member Functions
	ProjectItemID () noexcept=default
	ProjectItemID (const ProjectItemID &) noexcept=default
ProjectItemID &	operator= (const ProjectItemID &) noexcept=default
	~ProjectItemID () noexcept=default
	ProjectItemID (const juce::String &stringID) noexcept
	takes a string created by toString().
	ProjectItemID (int itemID, ProjectID projectID) noexcept
	Creates an ID from the item ID and project ID.
ProjectItemID	withNewProjectID (ProjectID newProjectID) const
ProjectID	getProjectID () const
	Returns the ID of the project this item belongs to.
int	getItemID () const
	Returns the ID of the item within the project.
int64_t	getRawID () const noexcept
	Returns a combined ID as an integer, useful for creating hashes.
bool	isValid () const noexcept
bool	isInvalid () const noexcept
juce::String	toString () const
juce::String	toStringSuitableForFilename () const
bool	operator== (ProjectItemID other) const
bool	operator!= (ProjectItemID other) const
bool	operator< (ProjectItemID other) const

Static Public Member Functions
static ProjectItemID	createNewID (ProjectID projectID) noexcept
	Generates a new ID for a given project.
static ProjectItemID	fromProperty (const juce::ValueTree &, const juce::Identifier &)

Detailed Description

An ID representing one of the items in a Project.

A ProjectItemID consists of two parts: the ID of the project it belongs to, and an ID of the item within that project.

Constructor & Destructor Documentation

ProjectItemID() [1/4]

engine::ProjectItemID::ProjectItemID ( )

defaultnoexcept

ProjectItemID() [2/4]

engine::ProjectItemID::ProjectItemID ( const ProjectItemID &  )

defaultnoexcept

~ProjectItemID()

engine::ProjectItemID::~ProjectItemID ( )

defaultnoexcept

ProjectItemID() [3/4]

engine::ProjectItemID::ProjectItemID ( const juce::String &  stringID )

explicitnoexcept

takes a string created by toString().

ProjectItemID() [4/4]

engine::ProjectItemID::ProjectItemID ( int  itemID, ProjectID  projectID  )

noexcept

Creates an ID from the item ID and project ID.

Member Function Documentation

operator=()

ProjectItemID & engine::ProjectItemID::operator= ( const ProjectItemID &  )

defaultnoexcept

createNewID()

static ProjectItemID engine::ProjectItemID::createNewID ( ProjectID  projectID )

staticnoexcept

Generates a new ID for a given project.

fromProperty()

static ProjectItemID engine::ProjectItemID::fromProperty ( const juce::ValueTree &  , const juce::Identifier &    )

static

withNewProjectID()

ProjectItemID engine::ProjectItemID::withNewProjectID

(

ProjectID

newProjectID

)

const

getProjectID()

ProjectID engine::ProjectItemID::getProjectID

(

)

const

Returns the ID of the project this item belongs to.

getItemID()

int engine::ProjectItemID::getItemID

(

)

const

Returns the ID of the item within the project.

getRawID()

int64_t engine::ProjectItemID::getRawID ( ) const

noexcept

Returns a combined ID as an integer, useful for creating hashes.

isValid()

bool engine::ProjectItemID::isValid ( ) const

noexcept

isInvalid()

bool engine::ProjectItemID::isInvalid ( ) const

noexcept

toString()

juce::String engine::ProjectItemID::toString

(

)

const

toStringSuitableForFilename()

juce::String engine::ProjectItemID::toStringSuitableForFilename

(

)

const

operator==()

bool engine::ProjectItemID::operator==

(

ProjectItemID

other

)

const

operator!=()

bool engine::ProjectItemID::operator!=

(

ProjectItemID

other

)

const

operator<()

bool engine::ProjectItemID::operator<

(

ProjectItemID

other

)

const

---

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

• tracktion_ProjectItemID.h