JUCE: ARAMusicalContext Class Reference

JUCE

- Main Page
- Related Pages
- Modules
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
ARAMusicalContext Class Reference
juce_audio_processors » utilities

Base class representing an ARA musical context. More...

`#include <juce_ARAModelObjects.h>`

Inheritance diagram for ARAMusicalContext:

## Public Types
using | PropertiesPtr = ARA::PlugIn::PropertiesPtr< ARA::ARAMusicalContextProperties >
using | Listener = ARAMusicalContextListener

## Public Member Functions
template<typename Document_t = ARADocument>
Document_t * | getDocument () const noexcept
| Returns the result of ARA::PlugIn::MusicalContext::getDocument() with the pointer cast to ARADocument*.
template<typename RegionSequence_t = ARARegionSequence>
const std::vector< RegionSequence_t * > & | getRegionSequences () const noexcept
| Returns the result of ARA::PlugIn::MusicalContext::getRegionSequences() with the pointers within cast to ARARegionSequence*.
size_t | getNumChildren () const noexcept override
| Returns the number of ARA model objects aggregated by this object.
ARAObject * | getChild (size_t) override
| Returns the child object associated with the given index.
ARAObject * | getParent () override
| Returns the ARA model object that aggregates this object.
void | visit (ARAObjectVisitor &visitor) override
| Allows the retrieval of the concrete type of a model object.
Public Member Functions inherited from ARAListenableModelClass< ARAMusicalContextListener >
| ARAListenableModelClass ()=default
| Constructor.
virtual | ~ARAListenableModelClass ()=default
| Destructor.
void | addListener (ARAMusicalContextListener *l)
| Subscribe `l` to notified by changes to the object.
void | removeListener (ARAMusicalContextListener *l)
| Unsubscribe `l` from object notifications.
void | notifyListeners (Callback &&callback)
| Call the provided callback for each of the added listeners.
Public Member Functions inherited from ARAObject
virtual | ~ARAObject ()=default
| Destructor.
virtual size_t | getNumChildren () const noexcept=0
| Returns the number of ARA model objects aggregated by this object.
virtual ARAObject * | getChild (size_t index)=0
| Returns the child object associated with the given index.
virtual ARAObject * | getParent ()=0
| Returns the ARA model object that aggregates this object.
template<typename Fn >
void | traverse (Fn &&fn)
| Implements a depth first traversal of the ARA model graph starting from the current object, and visiting its children recursively.
virtual void | visit (ARAObjectVisitor &visitor)=0
| Allows the retrieval of the concrete type of a model object.

## Detailed Description

Base class representing an ARA musical context.

## Member Typedef Documentation

## ◆ PropertiesPtr

using ARAMusicalContext::PropertiesPtr = ARA::PlugIn::PropertiesPtr<ARA::ARAMusicalContextProperties>

## ◆ Listener

using ARAMusicalContext::Listener = ARAMusicalContextListener

## Member Function Documentation

## ◆ getDocument()

template<typename Document_t = ARADocument>

Document_t * ARAMusicalContext::getDocument | ( |  | ) | const
| noexcept

Returns the result of ARA::PlugIn::MusicalContext::getDocument() with the pointer cast to ARADocument*.

If you have overridden ARADocumentControllerSpecialisation::doCreateDocument(), then you can use the template parameter to cast the pointers to your subclass of ARADocument.

## ◆ getRegionSequences()

template<typename RegionSequence_t = ARARegionSequence>

const std::vector< RegionSequence_t * > & ARAMusicalContext::getRegionSequences | ( |  | ) | const
| noexcept

Returns the result of ARA::PlugIn::MusicalContext::getRegionSequences() with the pointers within cast to ARARegionSequence*.

If you have overridden ARADocumentControllerSpecialisation::doCreateRegionSequence(), then you can use the template parameter to cast the pointers to your subclass of ARARegionSequence.

## ◆ getNumChildren()

size_t ARAMusicalContext::getNumChildren | ( |  | ) | const
| overridevirtualnoexcept

Returns the number of ARA model objects aggregated by this object.

Objects that are merely referred to, but not aggregated by the current object are not included in this count, e.g. a referenced RegionSequence does not count as a child of the referring PlaybackRegion.

See the ARA documentation's ARA Model Graph Overview for more details.

Implements ARAObject.

## ◆ getChild()

ARAObject * ARAMusicalContext::getChild | ( | size_t | index | ) |
| overridevirtual

Returns the child object associated with the given index.

The index should be smaller than the value returned by getNumChildren().

Note that the index of a particular object may change when the ARA model graph is edited.

Implements ARAObject.

## ◆ getParent()

ARAObject * ARAMusicalContext::getParent | ( |  | ) |
| overridevirtual

Returns the ARA model object that aggregates this object.

Returns nullptr for the ARADocument root object.

Implements ARAObject.

## ◆ visit()

void ARAMusicalContext::visit | ( | ARAObjectVisitor & | visitor | ) |
| overridevirtual

Allows the retrieval of the concrete type of a model object.

To use this, create a new class derived from ARAObjectVisitor and override its functions depending on which concrete types you are interested in.

Calling this function inside the function passed to ARAObject::traverse() allows you to map the entire ARA model graph.

Implements ARAObject.

References ARAObjectVisitor::visitMusicalContext().

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

- juce_ARAModelObjects.h