UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
FMusicalTime Struct Reference

#include <MusicalTime.h>

Public Member Functions

 FMusicalTime ()
 
 FMusicalTime (int32 InBar, int32 InTickInBar=0, int32 InTicksPerBar=MusicalTime::TicksPerQuarterNote *4, int32 InTicksPerBeat=MusicalTime::TicksPerQuarterNote)
 
bool IsValid () const
 
double FractionalBeatInBar () const
 
double FractionalBar () const
 
bool Serialize (FArchive &Ar)
 
double operator- (const FMusicalTime &Other)
 

Static Public Member Functions

static FMusicalTime FloorBar (const FMusicalTime &InMusicalTime)
 
static FMusicalTime FloorBeat (const FMusicalTime &InMusicalTime)
 

Public Attributes

int32 Bar
 
int32 TickInBar
 
int32 TicksPerBar
 
int32 TicksPerBeat
 

Friends

FArchive & operator<< (FArchive &Ar, FMusicalTime &MusicalTime)
 
UE_FORCEINLINE_HINT bool operator== (const FMusicalTime &A, const FMusicalTime &B)
 
UE_FORCEINLINE_HINT bool operator!= (const FMusicalTime &A, const FMusicalTime &B)
 
UE_FORCEINLINE_HINT bool operator> (const FMusicalTime &A, const FMusicalTime &B)
 
UE_FORCEINLINE_HINT bool operator>= (const FMusicalTime &A, const FMusicalTime &B)
 
UE_FORCEINLINE_HINT bool operator< (const FMusicalTime &A, const FMusicalTime &B)
 
UE_FORCEINLINE_HINT bool operator<= (const FMusicalTime &A, const FMusicalTime &B)
 

Constructor & Destructor Documentation

◆ FMusicalTime() [1/2]

FMusicalTime::FMusicalTime ( )
inline

◆ FMusicalTime() [2/2]

FMusicalTime::FMusicalTime ( int32  InBar,
int32  InTickInBar = 0,
int32  InTicksPerBar = MusicalTime::TicksPerQuarterNote * 4,
int32  InTicksPerBeat = MusicalTime::TicksPerQuarterNote 
)
inline

Member Function Documentation

◆ FloorBar()

static FMusicalTime FMusicalTime::FloorBar ( const FMusicalTime &  InMusicalTime)
inlinestatic

◆ FloorBeat()

static FMusicalTime FMusicalTime::FloorBeat ( const FMusicalTime &  InMusicalTime)
inlinestatic

◆ FractionalBar()

double FMusicalTime::FractionalBar ( ) const
inline

◆ FractionalBeatInBar()

double FMusicalTime::FractionalBeatInBar ( ) const
inline

◆ IsValid()

bool FMusicalTime::IsValid ( ) const
inline

Verify that this musical time is valid to use

◆ operator-()

double FMusicalTime::operator- ( const FMusicalTime &  Other)
inline

return fractional bars between two musical times

◆ Serialize()

bool FMusicalTime::Serialize ( FArchive &  Ar)
inline

Serializes the given musical time from or into the specified archive

Friends And Related Symbol Documentation

◆ operator!=

UE_FORCEINLINE_HINT bool operator!= ( const FMusicalTime &  A,
const FMusicalTime &  B 
)
friend

◆ operator<

UE_FORCEINLINE_HINT bool operator< ( const FMusicalTime &  A,
const FMusicalTime &  B 
)
friend

◆ operator<<

FArchive & operator<< ( FArchive &  Ar,
FMusicalTime &  MusicalTime 
)
friend

◆ operator<=

UE_FORCEINLINE_HINT bool operator<= ( const FMusicalTime &  A,
const FMusicalTime &  B 
)
friend

◆ operator==

UE_FORCEINLINE_HINT bool operator== ( const FMusicalTime &  A,
const FMusicalTime &  B 
)
friend

◆ operator>

UE_FORCEINLINE_HINT bool operator> ( const FMusicalTime &  A,
const FMusicalTime &  B 
)
friend

◆ operator>=

UE_FORCEINLINE_HINT bool operator>= ( const FMusicalTime &  A,
const FMusicalTime &  B 
)
friend

Member Data Documentation

◆ Bar

int32 FMusicalTime::Bar

IMPORTANT: If you change the struct data, ensure that you also update the version in NoExportTypes.h

◆ TickInBar

int32 FMusicalTime::TickInBar

◆ TicksPerBar

int32 FMusicalTime::TicksPerBar

◆ TicksPerBeat

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