Class SimulationStateBuilder

Builder pattern constructor for EasingSimulationState

Hierarchy

recordUtil.SimulationStateBuilder
- SimulationStateBuilder

Implements

Partial<easingSimulator.SimulationState>

Constructors

constructor

new SimulationStateBuilder(): easingSimulator.SimulationStateBuilder
Returns easingSimulator.SimulationStateBuilder
Overrides SimulationStateBuilder.constructor
- Defined in src/easingSimulator/simulationStateBuilder.ts:30

Properties

`Optional` cframeTrack

cframeTrack?: CFrameTrack

clampPositionToTrackLength

clampPositionToTrackLength: boolean

`Optional` currentPosition

currentPosition?: number

`Optional` currentTime

currentTime?: number

`Optional` distance

distance?: number

`Optional` duration

duration?: number

`Optional` easingDirection

easingDirection?: EasingDirection

`Optional` easingStyle

easingStyle?: EasingStyle

`Optional` endTime

endTime?: number

hasPassedTrackEnd

hasPassedTrackEnd: boolean

modelDirection

modelDirection: boolean

`Optional` startPosition

startPosition?: number

timeInterval

timeInterval: number

`Optional` trackName

trackName?: string

Methods

build

build(): Result<easingSimulator.SimulationState, string>
Returns Result<easingSimulator.SimulationState, string>
Overrides SimulationStateBuilder.build
- Defined in src/easingSimulator/simulationStateBuilder.ts:51

withCFrameTrack

withCFrameTrack(track: CFrameTrack): easingSimulator.SimulationStateBuilder
Parameters
- track: CFrameTrack
Returns easingSimulator.SimulationStateBuilder
- Defined in src/easingSimulator/simulationStateBuilder.ts:115

withClampPositionToTrackLength

withClampPositionToTrackLength(value: boolean): easingSimulator.SimulationStateBuilder
Parameters
- value: boolean
Returns easingSimulator.SimulationStateBuilder
- Defined in src/easingSimulator/simulationStateBuilder.ts:143

withCurrentPosition

withCurrentPosition(position: number): easingSimulator.SimulationStateBuilder
Parameters
- position: number
Returns easingSimulator.SimulationStateBuilder
Inherited from SimulationStateBuilder.withCurrentPosition
- Defined in src/recordUtil/simulationStateBuilder.ts:45

withDistance

withDistance(value: number): easingSimulator.SimulationStateBuilder
Parameters
- value: number
Returns easingSimulator.SimulationStateBuilder
- Defined in src/easingSimulator/simulationStateBuilder.ts:137

withDuration

withDuration(value: number): easingSimulator.SimulationStateBuilder
Parameters
- value: number
Returns easingSimulator.SimulationStateBuilder
- Defined in src/easingSimulator/simulationStateBuilder.ts:149

withEasingDirection

withEasingDirection(value: EasingDirection): easingSimulator.SimulationStateBuilder
Parameters
- value: EasingDirection
Returns easingSimulator.SimulationStateBuilder
- Defined in src/easingSimulator/simulationStateBuilder.ts:131

withEasingStyle

withEasingStyle(value: EasingStyle): easingSimulator.SimulationStateBuilder
Parameters
- value: EasingStyle
Returns easingSimulator.SimulationStateBuilder
- Defined in src/easingSimulator/simulationStateBuilder.ts:125

withEndTime

withEndTime(value?: number): easingSimulator.SimulationStateBuilder
Parameters
- Optional value: number
Returns easingSimulator.SimulationStateBuilder
- Defined in src/easingSimulator/simulationStateBuilder.ts:161

withHasPassedTrackEnd

withHasPassedTrackEnd(value: boolean): easingSimulator.SimulationStateBuilder
Parameters
- value: boolean
Returns easingSimulator.SimulationStateBuilder
Inherited from SimulationStateBuilder.withHasPassedTrackEnd
- Defined in src/recordUtil/simulationStateBuilder.ts:69

withModelDirection

withModelDirection(direction: boolean): easingSimulator.SimulationStateBuilder
Parameters
- direction: boolean
Returns easingSimulator.SimulationStateBuilder
Inherited from SimulationStateBuilder.withModelDirection
- Defined in src/recordUtil/simulationStateBuilder.ts:51

withStartPosition

withStartPosition(position: number): easingSimulator.SimulationStateBuilder
Parameters
- position: number
Returns easingSimulator.SimulationStateBuilder
- Defined in src/easingSimulator/simulationStateBuilder.ts:109

withStartTime

withStartTime(value?: number): easingSimulator.SimulationStateBuilder
Parameters
- Optional value: number
Returns easingSimulator.SimulationStateBuilder
- Defined in src/easingSimulator/simulationStateBuilder.ts:155

withTimeInterval

withTimeInterval(interval: number): easingSimulator.SimulationStateBuilder
Parameters
- interval: number
Returns easingSimulator.SimulationStateBuilder
Inherited from SimulationStateBuilder.withTimeInterval
- Defined in src/recordUtil/simulationStateBuilder.ts:63

withTrackName

withTrackName(name: string): easingSimulator.SimulationStateBuilder
Parameters
- name: string
Returns easingSimulator.SimulationStateBuilder
Inherited from SimulationStateBuilder.withTrackName
- Defined in src/recordUtil/simulationStateBuilder.ts:57

Generated using TypeDoc