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

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
tracktion::engine::EditTimeRange Struct Reference

Represents a time range in an Edit stored as either time or beats. More...

#include "tracktion_EditTime.h"

Public Member Functions

 EditTimeRange (TimeRange)
 Creates an EditTimeRange from a TimeRange.
 
 EditTimeRange (TimePosition, TimePosition)
 Creates an EditTimeRange from a TimeRange.
 
 EditTimeRange (TimePosition, TimeDuration)
 Creates an EditTimeRange from a TimeRange.
 
 EditTimeRange (BeatRange)
 Creates an EditTimeRange from a BeatRange.
 
 EditTimeRange (BeatPosition, BeatPosition)
 Creates an EditTimeRange from a BeatRange.
 
 EditTimeRange (BeatPosition, BeatDuration)
 Creates an EditTimeRange from a BeatRange.
 
bool isBeats () const
 Returns true if the time is stored as beats, false if stored as a TimePosition.
 

Friends

TimeRange toTime (EditTimeRange, const TempoSequence &)
 Converts an EditTimeRange to a TimeRange.
 
BeatRange toBeats (EditTimeRange, const TempoSequence &)
 Converts an EditTimeRange to a BeatRange.
 

Detailed Description

Represents a time range in an Edit stored as either time or beats.

This is basically a variant to simplify APIs that can accept either time base.

Definition at line 74 of file tracktion_EditTime.h.

Constructor & Destructor Documentation

◆ EditTimeRange() [1/6]

tracktion::engine::EditTimeRange::EditTimeRange ( TimeRange  r)

Creates an EditTimeRange from a TimeRange.

Definition at line 244 of file tracktion_EditTime.h.

◆ EditTimeRange() [2/6]

tracktion::engine::EditTimeRange::EditTimeRange ( TimePosition  start,
TimePosition  end 
)

Creates an EditTimeRange from a TimeRange.

Definition at line 254 of file tracktion_EditTime.h.

◆ EditTimeRange() [3/6]

tracktion::engine::EditTimeRange::EditTimeRange ( TimePosition  start,
TimeDuration  length 
)

Creates an EditTimeRange from a TimeRange.

Definition at line 259 of file tracktion_EditTime.h.

◆ EditTimeRange() [4/6]

tracktion::engine::EditTimeRange::EditTimeRange ( BeatRange  r)

Creates an EditTimeRange from a BeatRange.

Definition at line 249 of file tracktion_EditTime.h.

◆ EditTimeRange() [5/6]

tracktion::engine::EditTimeRange::EditTimeRange ( BeatPosition  start,
BeatPosition  end 
)

Creates an EditTimeRange from a BeatRange.

Definition at line 264 of file tracktion_EditTime.h.

◆ EditTimeRange() [6/6]

tracktion::engine::EditTimeRange::EditTimeRange ( BeatPosition  start,
BeatDuration  length 
)

Creates an EditTimeRange from a BeatRange.

Definition at line 269 of file tracktion_EditTime.h.

Member Function Documentation

◆ isBeats()

bool tracktion::engine::EditTimeRange::isBeats ( ) const

Returns true if the time is stored as beats, false if stored as a TimePosition.

Definition at line 274 of file tracktion_EditTime.h.

Friends And Related Symbol Documentation

◆ toBeats

BeatRange toBeats ( EditTimeRange  r,
const TempoSequence ts 
)
friend

Converts an EditTimeRange to a BeatRange.

N.B. This may be a slow operation if this was created using a TimeRange.

Definition at line 289 of file tracktion_EditTime.h.

◆ toTime

TimeRange toTime ( EditTimeRange  r,
const TempoSequence ts 
)
friend

Converts an EditTimeRange to a TimeRange.

N.B. This may be a slow operation if this was created using a BeatRange.

Definition at line 280 of file tracktion_EditTime.h.


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