A Keyframe stores the value of a parameter at the specified time. More...

#include <Keyframe.h>

Public Member Functions
bool	operator< (Keyframe other) const

	Keyframe ()
	Empty constructor.

	Keyframe (size_t time, shared_ptr< Lumiverse::LumiverseType > v, bool upv)
	Constructor with all values filled in. More...

	Keyframe (size_t time, string id, size_t offset)
	Constructs a nested Timeline Keyframe. More...

	Keyframe (size_t time)
	Constructor creates a blank keyframe at specified time.

	Keyframe (JSONNode node)
	Creates a keyframe from a JSON node.

JSONNode	toJSON ()
	Returns the JSON representation of this keyframe.

Public Attributes
size_t	t
	Time at which this keyframe is located. t=0 is start of timeline. More...

shared_ptr< Lumiverse::LumiverseType >	val
	Value of the keyframe at time t.

bool	useCurrentState
	If true, the value of this keyframe will be pulled from the state of the layer when playback starts. More...

string	timelineID
	If not blank, this keyframe pulls its value from the given keyframe at the given offset.

size_t	timelineOffset
	Start time for the Timeline referenced by timelineID.

Detailed Description

A Keyframe stores the value of a parameter at the specified time.

Keyframes can be set to use the current state of the layer it's being played back on. Useful for chaining timelines together, as in a series of cues.

Constructor & Destructor Documentation

Lumiverse::ShowControl::Keyframe::Keyframe	(	size_t	time,
		shared_ptr< Lumiverse::LumiverseType >	v,
		bool	upv
	)

inline

Constructor with all values filled in.

Parameters

time	Keyframe temporal location
v	Value at specified time
uct	Use Cue Timing (see useCueTiming member variable)

Lumiverse::ShowControl::Keyframe::Keyframe	(	size_t	time,
		string	id,
		size_t	offset
	)

inline

Constructs a nested Timeline Keyframe.

This type of keyframe pulls its value from the specified timeline starting at the given offset time

Parameters

time	Keyframe temporal location
id	Timeline id
offset	Start time for the timeline referenced by id.

size_t Lumiverse::ShowControl::Keyframe::t

Time at which this keyframe is located. t=0 is start of timeline.

The time is stored in terms of milliseconds (10e-3).

bool Lumiverse::ShowControl::Keyframe::useCurrentState

If true, the value of this keyframe will be pulled from the state of the layer when playback starts.

Note that the keyframe will still have a value, but it won't be used unless there is no previous cue.

The documentation for this struct was generated from the following files: