synfig::Keyframe Class Reference

Keyframe is used to record the state of the animation at that point (time_) More...

#include <keyframe.h>

Inheritance diagram for synfig::Keyframe:

Public Member Functions
	Keyframe ()
	Keyframe (const Time &time)
	~Keyframe ()
void	set_time (Time x)
Time	get_time () const
void	set_description (String x)
String	get_description () const
const GUID &	get_guid () const
void	set_guid (const GUID &x)
void	enable ()
	Enables the keframe (Making it active)
void	disable ()
	Disables the keyframe (Making it inactive)
void	set_active (bool x)
	Sets the 'active' flag for the LaKeyframe to the state described by x.
bool	active () const
	Returns the status of the 'active' flag.
bool	operator< (const Keyframe &rhs) const
bool	operator< (const Time &rhs) const
bool	operator== (const Time &rhs) const
bool	operator!= (const Time &rhs) const
const Waypoint::Model &	get_waypoint_model () const
void	apply_model (const Waypoint::Model &x)
	Keep a trace of the associated waypoint Model.
bool	has_model () const
	Returns the status of the 'waypoint model' flag.
Public Member Functions inherited from synfig::UniqueID
const int &	get_uid () const
	Returns the internal unique identifier for this object.
	UniqueID ()
void	make_unique ()
	operator bool () const
void	mimic (const UniqueID &x)
bool	operator== (const UniqueID &rhs) const
bool	operator!= (const UniqueID &rhs) const
bool	operator< (const UniqueID &rhs) const

Additional Inherited Members
Static Public Member Functions inherited from synfig::UniqueID
static const UniqueID	nil ()

Detailed Description

Keyframe is used to record the state of the animation at that point (time_)

A Keyframe can be described, actived or disabled and have an associated Waypoint::Model. Common comparison operators can be used for Keyframes operation ==, <, != .

See Also

Keyframe::set_description(String x), Keyframe::get_description(), Keyframe::enable(), Keyframe::disable ()

Constructor & Destructor Documentation

Keyframe::Keyframe

(

)

Keyframe::Keyframe

(

const Time &

time

)

Keyframe::~Keyframe

(

)

Member Function Documentation

void synfig::Keyframe::set_time ( Time  x )

inline

Time synfig::Keyframe::get_time ( ) const

inline

Referenced by encode_keyframe().

void synfig::Keyframe::set_description ( String  x )

inline

String synfig::Keyframe::get_description ( ) const

inline

Referenced by encode_keyframe().

const GUID& synfig::Keyframe::get_guid ( ) const

inline

void synfig::Keyframe::set_guid ( const GUID &  x )

inline

void synfig::Keyframe::enable ( )

inline

Enables the keframe (Making it active)

References set_active().

void synfig::Keyframe::disable ( )

inline

Disables the keyframe (Making it inactive)

When keyframe is disabled, it will be acting as time marker.

References set_active().

void Keyframe::set_active

(

bool

x

)

Sets the 'active' flag for the LaKeyframe to the state described by x.

When keyframe is disabled, it will be acting as time marker.

Referenced by disable(), and enable().

bool synfig::Keyframe::active ( ) const

inline

Returns the status of the 'active' flag.

Referenced by encode_keyframe().

bool synfig::Keyframe::operator< ( const Keyframe &  rhs ) const

inline

bool synfig::Keyframe::operator< ( const Time &  rhs ) const

inline

bool synfig::Keyframe::operator== ( const Time &  rhs ) const

inline

bool synfig::Keyframe::operator!= ( const Time &  rhs ) const

inline

const Waypoint::Model& synfig::Keyframe::get_waypoint_model ( ) const

inline

void Keyframe::apply_model

(

const Waypoint::Model &

x

)

Keep a trace of the associated waypoint Model.

References synfig::Waypoint::Model::get_after(), synfig::Waypoint::Model::get_before(), synfig::Waypoint::Model::get_bias(), synfig::Waypoint::Model::get_continuity(), synfig::Waypoint::Model::get_priority(), synfig::Waypoint::Model::get_temporal_tension(), synfig::Waypoint::Model::get_tension(), synfig::Waypoint::Model::set_after(), synfig::Waypoint::Model::set_before(), synfig::Waypoint::Model::set_bias(), synfig::Waypoint::Model::set_continuity(), synfig::Waypoint::Model::set_priority(), synfig::Waypoint::Model::set_temporal_tension(), and synfig::Waypoint::Model::set_tension().

bool synfig::Keyframe::has_model ( ) const

inline

Returns the status of the 'waypoint model' flag.

---

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

• keyframe.h
• keyframe.cpp