Utility class for defining the scope of a content update.
Classes | |
| class | ARA::ContentUpdateScopes |
| Utility class to conveniently deal with ARAContentUpdateFlags. This class contains static constants that can be combined with operator+ to describe any given change, for example notesAreAffected () + timelineIsAffected (). Likewise, its member functions allow for testing these conditions. More... | |
| class ARA::ContentUpdateScopes |
Utility class to conveniently deal with ARAContentUpdateFlags. This class contains static constants that can be combined with operator+ to describe any given change, for example notesAreAffected () + timelineIsAffected (). Likewise, its member functions allow for testing these conditions.
Receiving content updates. | |
These functions can be used by receivers of content updates to query the scope of what's affected by the update. | |
| constexpr bool | affectSamples () const noexcept |
| The actual signal is affected by the change. | |
| constexpr bool | affectNotes () const noexcept |
| Content information for notes, beat-markers etc. is affected by the change. | |
| constexpr bool | affectTimeline () const noexcept |
| Content information for tempo, bar signatures etc. is affected by the change. | |
| constexpr bool | affectTuning () const noexcept |
| Content readers for tuning etc. are affected by the change. | |
| constexpr bool | affectHarmonies () const noexcept |
| Content readers for key signatures, chords etc. are affected by the change. | |
| constexpr bool | affectEverything () const noexcept |
| Everything is affected by the change. | |
Sending content updates. | |
These constants are meant to be used when sending a content update notification. They can be combined using operator+ and operator+= to define a particular update scope. | |
| static constexpr ContentUpdateScopes | nothingIsAffected () noexcept |
| Nothing is affected by the change. | |
| static constexpr ContentUpdateScopes | samplesAreAffected () noexcept |
| The actual signal is affected by the change. | |
| static constexpr ContentUpdateScopes | notesAreAffected () noexcept |
| Content information for notes, beat-markers etc. is affected by the change. | |
| static constexpr ContentUpdateScopes | timelineIsAffected () noexcept |
| Content information for tempo, bar signatures etc. is affected by the change. | |
| static constexpr ContentUpdateScopes | tuningIsAffected () noexcept |
| Content readers for tuning etc. are affected by the change. | |
| static constexpr ContentUpdateScopes | harmoniesAreAffected () noexcept |
| Content readers for key signatures, chords etc. are affected by the change. | |
| static constexpr ContentUpdateScopes | everythingIsAffected () noexcept |
| Everything is affected by the change. | |
Creating update scopes. | |
| constexpr | ContentUpdateScopes () noexcept |
| Default constructor sets flags to nothingIsAffected. This sets flags to mean nothing has changed, and is rarely to be used directly. | |
| constexpr | ContentUpdateScopes (const ARAContentUpdateFlags flags) noexcept |
| Construct from ARAContentFlags. | |
| constexpr | operator ARAContentUpdateFlags () const noexcept |
| Conversion to ARAContentUpdateFlags. | |
| ContentUpdateScopes | operator+= (const ContentUpdateScopes &other) noexcept |
| Combine two scopes into a single ContentUpdateScopes. | |
| constexpr ContentUpdateScopes | operator+ (const ContentUpdateScopes &other) const noexcept |
| Combine two scopes into a single ContentUpdateScopes. | |