Class KeyframeBuilder

Builder pattern constructor for a Keyframe

Required:

position: number
trackSpeed: number
track: string
length: number

Hierarchy

KeyframeBuilder

Implements

Partial<TrackKeyframe>

Index

Constructors

Properties

hasPassedTrackEnd length? modelDirection position? track? trackSpeed? transitionType

Methods

build withHasPassedTrackEnd withLength withModelDirection withPosition withTrack withTrackSpeed withTransitionType

Constructors

constructor

new KeyframeBuilder(): KeyframeBuilder
Returns KeyframeBuilder
- Defined in src/keyframeBuilder.ts:25

Properties

hasPassedTrackEnd

hasPassedTrackEnd: Option<boolean>

`Optional` length

length?: number

modelDirection

modelDirection: boolean

`Optional` position

position?: number

`Optional` track

track?: string

`Optional` trackSpeed

trackSpeed?: number

transitionType

transitionType: TransitionType

Methods

build

build(): Result<TrackKeyframe, string>
Builds a Keyframe. Returns in a Result

Errors:
- position is undefined
- trackSpeed is undefined
- track is undefined
- length is undefined
Returns
Result<TrackKeyframe, string>
Returns Result<TrackKeyframe, string>
- Defined in src/keyframeBuilder.ts:49

withHasPassedTrackEnd

withHasPassedTrackEnd(direction: Option<boolean>): KeyframeBuilder
Parameters
- direction: Option<boolean>
Returns KeyframeBuilder
- Defined in src/keyframeBuilder.ts:116

withLength

withLength(length: number): KeyframeBuilder
Parameters
- length: number
Returns KeyframeBuilder
- Defined in src/keyframeBuilder.ts:98

withModelDirection

withModelDirection(direction: boolean): KeyframeBuilder
Parameters
- direction: boolean
Returns KeyframeBuilder
- Defined in src/keyframeBuilder.ts:110

withPosition

withPosition(position: number): KeyframeBuilder
Parameters
- position: number
Returns KeyframeBuilder
- Defined in src/keyframeBuilder.ts:80

withTrack

withTrack(track: string): KeyframeBuilder
Parameters
- track: string
Returns KeyframeBuilder
- Defined in src/keyframeBuilder.ts:92

withTrackSpeed

withTrackSpeed(speed: number): KeyframeBuilder
Parameters
- speed: number
Returns KeyframeBuilder
- Defined in src/keyframeBuilder.ts:86

withTransitionType

withTransitionType(transitionType: TransitionType): KeyframeBuilder
Parameters
- transitionType: TransitionType
Returns KeyframeBuilder
- Defined in src/keyframeBuilder.ts:104

Generated using TypeDoc