TracktionEngine
Public Types | Public Member Functions | Public Attributes | List of all members
tracktion::engine::TimeSigSetting Class Reference
Inheritance diagram for tracktion::engine::TimeSigSetting:

Public Types

using Ptr = juce::ReferenceCountedObjectPtr< TimeSigSetting >
 
using Array = juce::ReferenceCountedArray< TimeSigSetting >
 
- 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

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

Public Attributes

juce::ValueTree state
 
TempoSequenceownerSequence
 
juce::CachedValue< BeatPosition > startBeatNumber
 
juce::CachedValue< int > numerator
 
juce::CachedValue< int > denominator
 
juce::CachedValue< bool > triplets
 
TimePosition startTime
 
TimePosition endTime
 
- Public Attributes inherited from tracktion::engine::TrackItem
const Type type
 The type of this item. More...
 
- Public Attributes inherited from tracktion::engine::EditItem
Editedit
 
const EditItemID itemID
 Every EditItem has an ID which is unique within the edit. More...
 
- Public Attributes inherited from tracktion::engine::Selectable
WeakRef::Master masterReference
 

Additional Inherited Members

- Static Public Member Functions inherited from tracktion::engine::TrackItem
static const char * typeToString (Type)
 Returns the string version of a TrackItem::Type. More...
 
static juce::Identifier clipTypeToXMLType (Type)
 Returns an Identifier version of a TrackItem::Type. More...
 
static TrackItem::Type xmlTagToType (juce::StringRef)
 Returns the TrackItem::Type of a type string. More...
 
static TrackItem::Type stringToType (const juce::String &)
 Returns the TrackItem::Type of a type string. More...
 
static juce::String getSuggestedNameForNewItem (Type)
 Returns a text string for a new clip of the given type. More...
 
template<typename ArrayType >
static void sortByTime (ArrayType &items)
 Helper function to sort an array of TrackItem[s] by their start time. More...
 
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. More...
 
- 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. More...
 

Member Typedef Documentation

◆ Ptr

using tracktion::engine::TimeSigSetting::Ptr = juce::ReferenceCountedObjectPtr<TimeSigSetting>

◆ Array

using tracktion::engine::TimeSigSetting::Array = juce::ReferenceCountedArray<TimeSigSetting>

Constructor & Destructor Documentation

◆ TimeSigSetting()

tracktion::engine::TimeSigSetting::TimeSigSetting ( TempoSequence ,
const juce::ValueTree &   
)

◆ ~TimeSigSetting()

tracktion::engine::TimeSigSetting::~TimeSigSetting ( )
override

Member Function Documentation

◆ getPosition()

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

Must return the position of this item.

Implements tracktion::engine::TrackItem.

◆ getStartBeat()

BeatPosition tracktion::engine::TimeSigSetting::getStartBeat ( ) const

References startBeatNumber.

◆ getStringTimeSig()

juce::String tracktion::engine::TimeSigSetting::getStringTimeSig ( ) const

◆ setStringTimeSig()

void tracktion::engine::TimeSigSetting::setStringTimeSig ( const juce::String &  )

◆ removeFromEdit()

void tracktion::engine::TimeSigSetting::removeFromEdit ( )

◆ getTrack()

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

Must return the track this item lives on.

Implements tracktion::engine::TrackItem.

◆ getName()

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

◆ getSelectableDescription()

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

Subclasses must return a description of what they are.

Implements tracktion::engine::Selectable.

Member Data Documentation

◆ state

juce::ValueTree tracktion::engine::TimeSigSetting::state

◆ ownerSequence

TempoSequence& tracktion::engine::TimeSigSetting::ownerSequence

◆ startBeatNumber

juce::CachedValue<BeatPosition> tracktion::engine::TimeSigSetting::startBeatNumber

Referenced by getStartBeat().

◆ numerator

juce::CachedValue<int> tracktion::engine::TimeSigSetting::numerator

◆ denominator

juce::CachedValue<int> tracktion::engine::TimeSigSetting::denominator

◆ triplets

juce::CachedValue<bool> tracktion::engine::TimeSigSetting::triplets

◆ startTime

TimePosition tracktion::engine::TimeSigSetting::startTime

◆ endTime

TimePosition tracktion::engine::TimeSigSetting::endTime

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