tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
tracktion::engine::PitchSetting Class Reference
Inheritance diagram for tracktion::engine::PitchSetting:
tracktion::engine::TrackItem tracktion::engine::ValueTreeAllEventListener tracktion::engine::EditItem tracktion::engine::Selectable juce::ReferenceCountedObject

Public Types

using Ptr = juce::ReferenceCountedObjectPtr< PitchSetting >
 
using Array = juce::ReferenceCountedArray< PitchSetting >
 
- Public Types inherited from tracktion::engine::TrackItem
enum class  Type {
  unknown , wave , midi , edit ,
  step , marker , pitch , timeSig ,
  collection , video , recording , chord ,
  arranger , container
}
 Defines the types of item that can live on Track[s]. More...
 
- Public Types inherited from tracktion::engine::Selectable
using WeakRef = juce::WeakReference< Selectable >
 

Public Member Functions

 PitchSetting (Edit &, const juce::ValueTree &)
 
juce::String getSelectableDescription () override
 Subclasses must return a description of what they are.
 
BeatPosition getStartBeatNumber () const
 
void setStartBeat (BeatPosition)
 
int getPitch () const
 
void setPitch (int)
 
Scale::ScaleType getScale () const
 
void setScaleID (Scale::ScaleType)
 
void removeFromEdit ()
 
juce::String getName () const override
 
TrackgetTrack () const override
 Must return the track this item lives on.
 
ClipPosition getPosition () const override
 Must return the position of this item.
 
- Public Member Functions inherited from tracktion::engine::TrackItem
 TrackItem (Edit &, EditItemID, Type)
 Creates a TrackItem with an ID and type.
 
 ~TrackItem ()
 Destructor.
 
virtual bool isGrouped () const
 Should return true if this clip is part of a group.
 
virtual TrackItemgetGroupParent () const
 If this clip is part of a group, this should return the parent item it belongs to.
 
TimeRange getEditTimeRange () const
 Returns the time range of this item.
 
BeatRange getEditBeatRange () const
 Returns the beat range of this item.
 
BeatPosition getStartBeat () const
 Returns the start beat in the Edit of this item.
 
BeatPosition getContentStartBeat () const
 Returns the start beat of the content in the Edit of this item.
 
BeatPosition getEndBeat () const
 Returns the end beat in the Edit of this item.
 
BeatDuration getLengthInBeats () const
 Returns the duration in beats the of this item.
 
TimePosition getTimeOfRelativeBeat (BeatDuration) const
 Returns an Edit time point for a given number of beats from the start of this item.
 
BeatPosition getBeatOfRelativeTime (TimeDuration) const
 Returns an Edit beat point for a given number of seconds from the start of this item.
 
BeatDuration getOffsetInBeats () const
 Returns an the offset of this item in beats.
 
EditItemID getTrackID () const
 Returns the ID of the Track this item lives on.
 
- Public Member Functions inherited from tracktion::engine::EditItem
 EditItem (EditItemID, Edit &)
 
- Public Member Functions inherited from tracktion::engine::Selectable
virtual void selectionStatusChanged (bool isNowSelected)
 Can be overridden to tell this object that it has just been selected or deselected.
 
virtual void changed ()
 This should be called to send a change notification to any SelectableListeners that are registered with this object.
 
virtual void selectableAboutToBeDeleted ()
 Called just before the selectable is about to be deleted so any subclasses should still be valid at this point.
 
void addListener (SelectableListener *)
 
void removeListener (SelectableListener *)
 
void addSelectableListener (SelectableListener *)
 
void removeSelectableListener (SelectableListener *)
 
void cancelAnyPendingUpdates ()
 If changed() has been called, this will cancel any pending async change notificaions.
 
void deselect ()
 
void propertiesChanged ()
 
void notifyListenersOfDeletion ()
 
WeakRef getWeakRef ()
 
- Public Member Functions inherited from juce::ReferenceCountedObject
void incReferenceCount () noexcept
 
void decReferenceCount () noexcept
 
bool decReferenceCountWithoutDeleting () noexcept
 
int getReferenceCount () const noexcept
 

Public Attributes

juce::ValueTree state
 
juce::CachedValue< BeatPositionstartBeat
 
juce::CachedValue< intpitch
 
juce::CachedValue< bool > accidentalsSharp
 
juce::CachedValue< Scale::ScaleType > scale
 
- Public Attributes inherited from tracktion::engine::TrackItem
const Type type
 The type of this item.
 
- Public Attributes inherited from tracktion::engine::EditItem
Editedit
 
const EditItemID itemID
 Every EditItem has an ID which is unique within the edit.
 
- Public Attributes inherited from tracktion::engine::Selectable
WeakRef::Master masterReference
 

Additional Inherited Members

- Static Public Member Functions inherited from tracktion::engine::TrackItem
static const chartypeToString (Type)
 Returns the string version of a TrackItem::Type.
 
static juce::Identifier clipTypeToXMLType (Type)
 Returns an Identifier version of a TrackItem::Type.
 
static TrackItem::Type xmlTagToType (juce::StringRef)
 Returns the TrackItem::Type of a type string.
 
static TrackItem::Type stringToType (const juce::String &)
 Returns the TrackItem::Type of a type string.
 
static juce::String getSuggestedNameForNewItem (Type)
 Returns a text string for a new clip of the given type.
 
template<typename ArrayType >
static void sortByTime (ArrayType &items)
 Helper function to sort an array of TrackItem[s] by their start time.
 
template<typename ArrayType >
static void stableSortByTime (ArrayType &items)
 Helper function to sort an array of TrackItem[s] by their start time without changing the order of items at the same time.
 
- Static Public Member Functions inherited from tracktion::engine::Selectable
static void initialise ()
 
static bool isSelectableValid (const Selectable *) noexcept
 checks whether this object has been deleted.
 
- Protected Member Functions inherited from juce::ReferenceCountedObject
 ReferenceCountedObject (const ReferenceCountedObject &) noexcept
 
 ReferenceCountedObject (ReferenceCountedObject &&) noexcept
 
ReferenceCountedObjectoperator= (const ReferenceCountedObject &) noexcept
 
ReferenceCountedObjectoperator= (ReferenceCountedObject &&) noexcept
 
void resetReferenceCount () noexcept
 

Detailed Description

Definition at line 17 of file tracktion_PitchSetting.h.

Member Typedef Documentation

◆ Array

Definition at line 25 of file tracktion_PitchSetting.h.

◆ Ptr

Definition at line 24 of file tracktion_PitchSetting.h.

Constructor & Destructor Documentation

◆ PitchSetting()

tracktion::engine::PitchSetting::PitchSetting ( Edit ed,
const juce::ValueTree v 
)

Definition at line 14 of file tracktion_PitchSetting.cpp.

◆ ~PitchSetting()

tracktion::engine::PitchSetting::~PitchSetting ( )
override

Definition at line 27 of file tracktion_PitchSetting.cpp.

Member Function Documentation

◆ getName()

juce::String tracktion::engine::PitchSetting::getName ( ) const
overridevirtual

Implements tracktion::engine::EditItem.

Definition at line 34 of file tracktion_PitchSetting.cpp.

◆ getPitch()

int tracktion::engine::PitchSetting::getPitch ( ) const

Definition at line 32 of file tracktion_PitchSetting.h.

◆ getPosition()

ClipPosition tracktion::engine::PitchSetting::getPosition ( ) const
overridevirtual

Must return the position of this item.

Implements tracktion::engine::TrackItem.

Definition at line 50 of file tracktion_PitchSetting.cpp.

◆ getScale()

Scale::ScaleType tracktion::engine::PitchSetting::getScale ( ) const

Definition at line 35 of file tracktion_PitchSetting.h.

◆ getSelectableDescription()

juce::String tracktion::engine::PitchSetting::getSelectableDescription ( )
overridevirtual

Subclasses must return a description of what they are.

Implements tracktion::engine::Selectable.

Definition at line 40 of file tracktion_PitchSetting.cpp.

◆ getStartBeatNumber()

BeatPosition tracktion::engine::PitchSetting::getStartBeatNumber ( ) const

Definition at line 29 of file tracktion_PitchSetting.h.

◆ getTrack()

Track * tracktion::engine::PitchSetting::getTrack ( ) const
overridevirtual

Must return the track this item lives on.

Implements tracktion::engine::TrackItem.

Definition at line 45 of file tracktion_PitchSetting.cpp.

◆ removeFromEdit()

void tracktion::engine::PitchSetting::removeFromEdit ( )

Definition at line 79 of file tracktion_PitchSetting.cpp.

◆ setPitch()

void tracktion::engine::PitchSetting::setPitch ( int  p)

Definition at line 69 of file tracktion_PitchSetting.cpp.

◆ setScaleID()

void tracktion::engine::PitchSetting::setScaleID ( Scale::ScaleType  st)

Definition at line 74 of file tracktion_PitchSetting.cpp.

◆ setStartBeat()

void tracktion::engine::PitchSetting::setStartBeat ( BeatPosition  beat)

Definition at line 62 of file tracktion_PitchSetting.cpp.

Member Data Documentation

◆ accidentalsSharp

juce::CachedValue<bool> tracktion::engine::PitchSetting::accidentalsSharp

Definition at line 47 of file tracktion_PitchSetting.h.

◆ pitch

juce::CachedValue<int> tracktion::engine::PitchSetting::pitch

Definition at line 46 of file tracktion_PitchSetting.h.

◆ scale

juce::CachedValue<Scale::ScaleType> tracktion::engine::PitchSetting::scale

Definition at line 48 of file tracktion_PitchSetting.h.

◆ startBeat

juce::CachedValue<BeatPosition> tracktion::engine::PitchSetting::startBeat

Definition at line 45 of file tracktion_PitchSetting.h.

◆ state

juce::ValueTree tracktion::engine::PitchSetting::state

Definition at line 44 of file tracktion_PitchSetting.h.


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