openspace.keyframeRecording

Functions overview

Name	Documentation
addCameraKeyframe	Adds a keyframe at the specified sequence-time
addScriptKeyframe	Adds a keyframe at the specified sequence-time
keyframes
loadSequence	Loads a sequence from the specified file
moveKeyframe	Move keyframe of index to the new specified sequenceTime
newSequence	Starts a new sequence of keyframes, any previously loaded sequence is discarded
pause	Pauses a playing sequence
play	Playback sequence optionally from the specified sequenceTime or if not specified starts playing from the current time set within the sequence
removeKeyframe	Removes a keyframe at the specified 0-based index
saveSequence	Saves the current sequence of keyframes to disk by the optionally specified filename
updateKeyframe	Update the camera position at keyframe specified by the 0-based index

Functions

addCameraKeyframe

Adds a keyframe at the specified sequence-time

Parameters

• sequenceTime Number

Return type: void

Signature

openspace.keyframeRecording.addCameraKeyframe(sequenceTime)

---

addScriptKeyframe

Adds a keyframe at the specified sequence-time

Parameters

• sequenceTime Number

• script String

Return type: void

Signature

openspace.keyframeRecording.addScriptKeyframe(sequenceTime, script)

---

keyframes

Return type: Table[]

Signature

openspace.keyframeRecording.keyframes()

---

loadSequence

Loads a sequence from the specified file

Parameters

• filename Path

Return type: void

Signature

openspace.keyframeRecording.loadSequence(filename)

---

moveKeyframe

Move keyframe of index to the new specified sequenceTime

Parameters

• index Integer

• sequenceTime Number

Return type: void

Signature

openspace.keyframeRecording.moveKeyframe(index, sequenceTime)

---

newSequence

Starts a new sequence of keyframes, any previously loaded sequence is discarded

Return type: void

Signature

openspace.keyframeRecording.newSequence()

---

pause

Pauses a playing sequence

Return type: void

Signature

openspace.keyframeRecording.pause()

---

play

Playback sequence optionally from the specified sequenceTime or if not specified starts playing from the current time set within the sequence

Parameters

• sequenceTime Number?

Return type: void

Signature

openspace.keyframeRecording.play(sequenceTime)

---

removeKeyframe

Removes a keyframe at the specified 0-based index

Parameters

• index Integer

Return type: void

Signature

openspace.keyframeRecording.removeKeyframe(index)

---

saveSequence

Saves the current sequence of keyframes to disk by the optionally specified filename.

Parameters

• filename Path

Return type: void

Signature

openspace.keyframeRecording.saveSequence(filename)

---

updateKeyframe

Update the camera position at keyframe specified by the 0-based index

Parameters

• index Integer

Return type: void

Signature

openspace.keyframeRecording.updateKeyframe(index)