usdrt::UsdTimeCode
Defined in usdrt/scenegraph/usd/usd/timeCode.h
-
class UsdTimeCode
Represent a time value as a double.
This is a generic time measurement representing time sampled data.
Public Functions
-
inline constexpr UsdTimeCode(double t = 0.0) noexcept
Construct with optional time value.
- Parameters
t – time value as
double.
-
inline bool IsEarliestTime() const
- Returns
Return true if this time represents the lowest/earliest possible timeCode, false otherwise.
-
inline bool IsDefault() const
- Returns
Return true if this time represents the ‘default’ sentinel value, false otherwise. This is equivalent to !IsNumeric().
-
inline bool IsNumeric() const
- Returns
Return true if this time represents a numeric value, false otherwise. This is equivalent to !IsDefault().
-
inline double GetValue() const
Get the numeric value for this time.
- Returns
Return the numeric value for this time. If this time IsDefault(), return a quiet NaN value.
Public Static Functions
-
static inline UsdTimeCode EarliestTime()
Produce a UsdTimeCode representing the lowest/earliest possible timeCode.
-
static inline UsdTimeCode Default()
Produce a UsdTimeCode representing ‘default’.
Note
In inequality comparisons, Default() is considered less than any numeric TimeCode, including EarliestTime().
-
inline constexpr UsdTimeCode(double t = 0.0) noexcept