USDKit · IOS API REFERENCE

USDStage.TimeCode

struct · iOS 27.0+ · SDK 27.1

struct TimeCode

A unitless point in time, used with time-varying values authored in 3D scenes.

Members (11)

init · iOS 27.0+

init

TypeScript

static initPreTime(instant: number): USDStage_TimeCode

Swift declaration

init(preTime instant: Double)

The instant directly before the given time value. If a time-varying value is discontinuous at `instant`, pre-time refers to the value's limit approaching from the left.

init · iOS 27.0+

init

TypeScript

static initPreTime19859(timeCode: USDLayer_TimeCode): USDStage_TimeCode

Swift declaration

init(preTime timeCode: USDLayer.TimeCode)

The instant directly before the given time value.

get · iOS 27.0+

isPreTime

TypeScript

get isPreTime(): boolean

Swift declaration

var isPreTime: Bool { get }

A Boolean value that indicates whether this time code represents the limit of a value approaching from the left of a discontinuity.

get · iOS 27.0+

description

TypeScript

get description(): string

Swift declaration

var description: String { get }

A summary description of this time code.

init · iOS 27.0+

init

TypeScript

static initFloatLiteral(value: number): USDStage_TimeCode

Swift declaration

init(floatLiteral value: Double)

Creates an instance initialized to the specified floating-point value. Do not call this initializer directly. Instead, initialize a variable or constant using a floating-point literal. For example: let x = 21.5 In this example, the assignment to the `x` constant calls this floating-point literal initializer behind the scenes. - Parameter value: The value to create.

get · iOS 27.0+

value

TypeScript

get value(): (number) | null

Swift declaration

var value: Double? { get }

The numeric value of this time code, or `nil` if it is the default time code.

get · iOS 27.0+

default

TypeScript

static get default(): USDStage_TimeCode

Swift declaration

static var `default`: USDStage.TimeCode { get }

The time code used to author and read values that do not vary over time.

get · iOS 27.0+

earliest

TypeScript

static get earliest(): USDStage_TimeCode

Swift declaration

static var earliest: USDStage.TimeCode { get }

A sentinel time code that resolves to the earliest authored sample of a value.

static · iOS 27.0+

safeStep

TypeScript

static safeStep(maxValue?: number, maxCompression?: number): number

Swift declaration

static func safeStep(maxValue: Double = 1e6, maxCompression: Double = 10.0) -> Double

Returns a time delta small enough to represent a jump discontinuity, but large enough to survive scaling and shifting without collapsing to zero. Use it to author paired samples at `t` and `t + SafeStep()` that stay distinct for any `t` in [-maxValue, maxValue] under compression up to `maxCompression`. Equivalent to: `epsilon * maxValue * maxCompression * 2`.

init · iOS 27.0+

init

TypeScript

static init(instant: number): USDStage_TimeCode

Swift declaration

init(_ instant: Double)

A numeric time value.

init · iOS 27.0+

init

TypeScript

static init28332(timeCode: USDLayer_TimeCode): USDStage_TimeCode

Swift declaration

init(_ timeCode: USDLayer.TimeCode)

A numeric time value.

Skipped declarations

No declarations were skipped in this snapshot.

All USDKit types →