cluttermm: Clutter::KeyFrameTransition Class Reference

Inheritance diagram for Clutter::KeyFrameTransition:

Collaboration diagram for Clutter::KeyFrameTransition:

Public Member Functions
virtual	~KeyFrameTransition ()

ClutterKeyframeTransition*	gobj ()
	Provides access to the underlying C GObject. More...

const ClutterKeyframeTransition*	gobj () const
	Provides access to the underlying C GObject. More...

ClutterKeyframeTransition*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

void	set_key_frames (guint index, const double* key_points)
	Sets the keys for each key frame inside transition. More...

void	set_modes (const std::vector< AnimationMode >& modes)
	Sets the easing modes for each key frame inside transition. More...

template<typename ValueType >
void	set_values (const std::vector< ValueType >& values)
	Sets the values for each key frame inside transition. More...

guint	get_n_key_frames () const
	Retrieves the number of key frames inside transition. More...

void	set_key_frame (guint index_, double key, AnimationMode mode, const Glib::ValueBase& value)
	Sets the details of the key frame at index inside transition. More...

void	clear ()
	Removes all key frames from transition. More...

Public Member Functions inherited from Clutter::PropertyTransition
virtual	~PropertyTransition ()

ClutterPropertyTransition*	gobj ()
	Provides access to the underlying C GObject. More...

const ClutterPropertyTransition*	gobj () const
	Provides access to the underlying C GObject. More...

ClutterPropertyTransition*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

void	set_property_name (const Glib::ustring& property_name)
	Sets the Clutter::PropertyTransition::property_property_name() property of transition. More...

Glib::ustring	get_property_name () const
	Retrieves the value of the Clutter::PropertyTransition::property_property_name() property. More...

Glib::PropertyProxy < Glib::ustring >	property_property_name ()
	The name of the property to animate. More...

Glib::PropertyProxy_ReadOnly < Glib::ustring >	property_property_name () const
	The name of the property to animate. More...

Public Member Functions inherited from Clutter::Transition
virtual	~Transition ()

ClutterTransition*	gobj ()
	Provides access to the underlying C GObject. More...

const ClutterTransition*	gobj () const
	Provides access to the underlying C GObject. More...

ClutterTransition*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

void	set_from_value (const Glib::ValueBase& value)
	Sets the initial value of the transition. More...

void	set_to_value (const Glib::ValueBase& value)
	Sets the final value of the transition. More...

template<class ValueType >
void	set_from (const ValueType& value)
	Set the initial value of the transition. More...

template<class ValueType >
void	set_to (const ValueType& value)
	Set the final value of the transition. More...

void	set_interval (const Glib::RefPtr< Interval >& interval)
	Sets the Clutter::Transition::property_interval() property using interval. More...

Glib::RefPtr< Interval >	get_interval ()
	Retrieves the interval set using set_interval() More...

Glib::RefPtr< const Interval >	get_interval () const
	Retrieves the interval set using set_interval() More...

void	set_animatable (const Glib::RefPtr< Animatable >& animatable)
	Sets the Clutter::Transition::property_animatable() property. More...

Glib::RefPtr< Animatable >	get_animatable ()
	Retrieves the Clutter::Animatable set using set_animatable(). More...

Glib::RefPtr< const Animatable >	get_animatable () const
	Retrieves the Clutter::Animatable set using set_animatable(). More...

void	set_remove_on_complete (bool remove_complete=true)
	Sets whether transition should be detached from the Clutter::Animatable set using set_animatable() when the Clutter::Timeline::signal_completed() signal is emitted. More...

bool	get_remove_on_complete () const
	Retrieves the value of the Clutter::Transition::property_remove_on_complete() property. More...

Glib::PropertyProxy < Glib::RefPtr< Animatable > >	property_animatable ()
	The animatable object. More...

Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Animatable > >	property_animatable () const
	The animatable object. More...

Glib::PropertyProxy < Glib::RefPtr< Interval > >	property_interval ()
	The interval of values to transition. More...

Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Interval > >	property_interval () const
	The interval of values to transition. More...

Glib::PropertyProxy< bool >	property_remove_on_complete ()
	Detach the transition when completed. More...

Glib::PropertyProxy_ReadOnly < bool >	property_remove_on_complete () const
	Detach the transition when completed. More...

Public Member Functions inherited from Clutter::Timeline
virtual	~Timeline ()

ClutterTimeline*	gobj ()
	Provides access to the underlying C GObject. More...

const ClutterTimeline*	gobj () const
	Provides access to the underlying C GObject. More...

ClutterTimeline*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

Glib::RefPtr< Timeline >	clone () const
	Create a new Clutter::Timeline instance which has property values matching that of supplied timeline. More...

void	set_duration (guint msecs)
	Sets the duration of the timeline, in milliseconds. More...

guint	get_duration () const
	Retrieves the duration of a Clutter::Timeline in milliseconds. More...

void	start ()
	Starts the Clutter::Timeline playing. More...

void	pause ()
	Pauses the Clutter::Timeline on current frame. More...

void	stop ()
	Stops the Clutter::Timeline and moves to frame 0. More...

void	set_auto_reverse (bool reverse=true)
	Sets whether timeline should reverse the direction after the emission of the Clutter::Timeline::signal_completed() signal. More...

bool	get_auto_reverse () const
	Retrieves the value set by set_auto_reverse(). More...

void	set_repeat_count (int count)
	Sets the number of times the timeline should repeat. More...

int	get_repeat_count () const
	Retrieves the number set using set_repeat_count(). More...

void	rewind ()
	Rewinds Clutter::Timeline to the first frame if its direction is Clutter::TIMELINE_FORWARD and the last frame if it is Clutter::TIMELINE_BACKWARD. More...

void	set_loop (bool loop=true)
	Sets whether timeline should loop. More...

bool	get_loop () const
	Gets whether timeline is looping. More...

void	skip (guint n_frames)
	Advance timeline by the requested time in milliseconds. More...

void	advance (guint frame_num)
	Advance timeline to the requested point. More...

guint	get_delta () const
	Retrieves the amount of time elapsed since the last ClutterTimeline::new-frame signal. More...

bool	is_playing () const
	Queries state of a Clutter::Timeline. More...

void	set_delay (guint msecs)
	Sets the delay, in milliseconds, before timeline should start. More...

guint	get_delay () const
	Retrieves the delay set using set_delay(). More...

guint	get_elapsed_time () const
	Request the current time position of the timeline. More...

double	get_progress () const
	The position of the timeline in a normalized [-1, 2] interval. More...

void	set_direction (TimelineDirection direction)
	Sets the direction of timeline, either Clutter::TIMELINE_FORWARD or Clutter::TIMELINE_BACKWARD. More...

TimelineDirection	get_direction () const
	Retrieves the direction of the timeline set with set_direction(). More...

std::vector< Glib::ustring >	list_markers (int frame_num) const
	Retrieves the list of markers at time msecs. More...

void	add_marker_at_time (const Glib::ustring& marker_name, guint msecs)
	Adds a named marker that will be hit when the timeline has been running for msecs milliseconds. More...

bool	has_marker (const Glib::ustring& marker_name)
	Checks whether timeline has a marker set with the given name. More...

void	remove_marker (const Glib::ustring& marker_name)
	Removes marker_name, if found, from timeline. More...

void	advance_to_marker (const Glib::ustring& marker_name)
	Advances timeline to the time of the given marker_name. More...

void	set_progress_mode (AnimationMode mode)
	Sets the progress function using a value from the Clutter::AnimationMode enumeration. More...

AnimationMode	get_progress_mode () const
	Retrieves the progress mode set using set_progress_mode() or set_progress_func(). More...

Glib::PropertyProxy< guint >	property_delay ()
	Delay before start. More...

Glib::PropertyProxy_ReadOnly < guint >	property_delay () const
	Delay before start. More...

Glib::PropertyProxy < TimelineDirection >	property_direction ()
	Direction of the timeline. More...

Glib::PropertyProxy_ReadOnly < TimelineDirection >	property_direction () const
	Direction of the timeline. More...

Glib::PropertyProxy< guint >	property_duration ()
	Duration of the timeline in milliseconds. More...

Glib::PropertyProxy_ReadOnly < guint >	property_duration () const
	Duration of the timeline in milliseconds. More...

Glib::PropertyProxy< bool >	property_loop ()
	Should the timeline automatically restart. More...

Glib::PropertyProxy_ReadOnly < bool >	property_loop () const
	Should the timeline automatically restart. More...

Glib::PropertyProxy< bool >	property_auto_reverse ()
	Whether the direction should be reversed when reaching the end. More...

Glib::PropertyProxy_ReadOnly < bool >	property_auto_reverse () const
	Whether the direction should be reversed when reaching the end. More...

Glib::PropertyProxy< int >	property_repeat_count ()
	How many times the timeline should repeat. More...

Glib::PropertyProxy_ReadOnly< int >	property_repeat_count () const
	How many times the timeline should repeat. More...

Glib::PropertyProxy < AnimationMode >	property_progress_mode ()
	How the timeline should compute the progress. More...

Glib::PropertyProxy_ReadOnly < AnimationMode >	property_progress_mode () const
	How the timeline should compute the progress. More...

Glib::SignalProxy0< void >	signal_completed ()

Glib::SignalProxy1< void, int >	signal_new_frame ()

Glib::SignalProxy0< void >	signal_paused ()

Glib::SignalProxy0< void >	signal_started ()

Glib::SignalProxy2< void, const Glib::ustring&, int >	signal_marker_reached ()

Public Member Functions inherited from Clutter::Animatable
virtual	~Animatable ()

ClutterAnimatable*	gobj ()
	Provides access to the underlying C GObject. More...

const ClutterAnimatable*	gobj () const
	Provides access to the underlying C GObject. More...

GParamSpec*	find_property (const Glib::ustring& property_name)
	Finds the ParamSpec for property_name. More...

void	get_initial_state_value (const Glib::ustring& property_name, Glib::ValueBase& value) const
	Retrieves the current state of property_name and sets value with it. More...

void	set_final_state_value (const Glib::ustring& property_name, const Glib::ValueBase& value)
	Sets the current state of property_name to value. More...

void	interpolate_value_value (const Glib::ustring& property_name, const Glib::RefPtr< const Interval >& interval, double progress, Glib::ValueBase& value)
	Asks a Clutter::Animatable implementation to interpolate a a named property between the initial and final values of a Clutter::Interval, using progress as the interpolation value, and store the result inside value. More...

template<class ValueType >
void	get_initial_state (const Glib::ustring& property_name, ValueType& value) const
	Gets the initial state of an animation. More...

template<class ValueType >
void	set_final_state (const Glib::ustring& property_name, const ValueType& value)
	Sets the final state for an animation. More...

template<class ValueType >
bool	interpolate (const Glib::ustring& property_name, const Glib::RefPtr< const Interval >& interval, double progress, ValueType& value)

Public Member Functions inherited from Clutter::Scriptable
virtual	~Scriptable ()

ClutterScriptable*	gobj ()
	Provides access to the underlying C GObject. More...

const ClutterScriptable*	gobj () const
	Provides access to the underlying C GObject. More...

void	set_id (const std::string& id)
	Sets id as the unique Clutter script it for this instance of Clutter::ScriptableIface. More...

std::string	get_id () const
	Retrieves the id of scriptable set using set_id(). More...

bool	parse_custom_node (const Glib::RefPtr< Script >& script, Glib::ValueBase& value, const Glib::ustring& name, JsonNode* node)
	Parses the passed JSON node. More...

void	set_custom_property (const Glib::RefPtr< Script >& script, const Glib::ustring& name, const Glib::ValueBase& value)
	Overrides the common properties setting. More...

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

static Glib::RefPtr < KeyFrameTransition >	create (const Glib::ustring& property_name)

Static Public Member Functions inherited from Clutter::PropertyTransition
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

static Glib::RefPtr < PropertyTransition >	create (const Glib::ustring& property_name)
	Creates a new PropertyTransition. More...

Static Public Member Functions inherited from Clutter::Transition
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

static Glib::RefPtr< Transition >	create ()

Static Public Member Functions inherited from Clutter::Timeline
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

static Glib::RefPtr< Timeline >	create (guint msecs)

Static Public Member Functions inherited from Clutter::Animatable
static void	add_interface (GType gtype_implementer)

static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

Static Public Member Functions inherited from Clutter::Scriptable
static void	add_interface (GType gtype_implementer)

static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

Protected Member Functions
	KeyFrameTransition (const Glib::ustring& property_name)

Protected Member Functions inherited from Clutter::PropertyTransition
	PropertyTransition (const Glib::ustring& property_name)

Protected Member Functions inherited from Clutter::Transition
	Transition ()

Protected Member Functions inherited from Clutter::Timeline
	Timeline (guint msecs)
	Creates a new Clutter::Timeline with a duration of msecs. More...

virtual void	on_completed ()
	This is a default handler for the signal signal_completed(). More...

virtual void	on_new_frame (int fram_num)
	This is a default handler for the signal signal_new_frame(). More...

virtual void	on_paused ()
	This is a default handler for the signal signal_paused(). More...

virtual void	on_started ()
	This is a default handler for the signal signal_started(). More...

virtual void	on_marker_reached (const Glib::ustring& marker_name, int frame_num)
	This is a default handler for the signal signal_marker_reached(). More...

Protected Member Functions inherited from Clutter::Animatable
	Animatable ()
	You should derive from this class to use it. More...

virtual GParamSpec*	find_property_vfunc (const Glib::ustring& property_name)

virtual void	get_initial_state_vfunc (const Glib::ustring& property_name, Glib::ValueBase& value)

virtual void	set_final_state_vfunc (const Glib::ustring& property_name, const Glib::ValueBase& value)

Protected Member Functions inherited from Clutter::Scriptable
	Scriptable ()
	You should derive from this class to use it. More...

virtual void	set_id_vfunc (const std::string& id)

virtual const char*	get_id_vfunc () const

virtual void	set_custom_property_vfunc (const Glib::RefPtr< Script >& script, const Glib::ustring& name, const Glib::ValueBase& value)

Related Functions
(Note that these are not member functions.)
Glib::RefPtr < Clutter::KeyFrameTransition >	wrap (ClutterKeyframeTransition* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Clutter::PropertyTransition
Glib::RefPtr < Clutter::PropertyTransition >	wrap (ClutterPropertyTransition* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Clutter::Transition
Glib::RefPtr< Clutter::Transition >	wrap (ClutterTransition* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Clutter::Timeline
Glib::RefPtr< Clutter::Timeline >	wrap (ClutterTimeline* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Clutter::Animatable
Glib::RefPtr< Clutter::Animatable >	wrap (ClutterAnimatable* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Clutter::Scriptable
Glib::RefPtr< Clutter::Scriptable >	wrap (ClutterScriptable* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Constructor & Destructor Documentation

virtual Clutter::KeyFrameTransition::~KeyFrameTransition ( )

virtual

Clutter::KeyFrameTransition::KeyFrameTransition ( const Glib::ustring & property_name)

explicitprotected

Member Function Documentation

void Clutter::KeyFrameTransition::clear ( )

Removes all key frames from transition.

Since cluttermm 1.12:

static Glib::RefPtr<KeyFrameTransition> Clutter::KeyFrameTransition::create ( const Glib::ustring & property_name)

static

guint Clutter::KeyFrameTransition::get_n_key_frames ( ) const

Retrieves the number of key frames inside transition.

Since cluttermm 1.12:

Returns: The number of key frames.

static GType Clutter::KeyFrameTransition::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

ClutterKeyframeTransition* Clutter::KeyFrameTransition::gobj ( )

inline

Provides access to the underlying C GObject.

const ClutterKeyframeTransition* Clutter::KeyFrameTransition::gobj ( ) const

inline

Provides access to the underlying C GObject.

ClutterKeyframeTransition* Clutter::KeyFrameTransition::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

void Clutter::KeyFrameTransition::set_key_frame	(	guint	index_,
		double	key,
		AnimationMode	mode,
		const Glib::ValueBase &	value
	)

Sets the details of the key frame at index inside transition.

The transition must already have a key frame at index, and index must be smaller than the number of key frames inside transition.

Since cluttermm 1.12:

Parameters

index	The index of the key frame.
key	The key of the key frame.
mode	The easing mode of the key frame.
value	A Value containing the value of the key frame.

void Clutter::KeyFrameTransition::set_key_frames	(	guint	index,
		const double *	key_points
	)

Sets the keys for each key frame inside transition.

If transition does not hold any key frame, n_key_frames key frames will be created; if transition already has key frames, key_frames must have at least as many elements as the number of key frames.

Since cluttermm 1.12:

Parameters

n_key_frames	The number of values.
key_frames	An array of keys between 0.0 and 1.0, one for each key frame.

void Clutter::KeyFrameTransition::set_modes ( const std::vector< AnimationMode >& modes)

Sets the easing modes for each key frame inside transition.

If transition does not hold any key frame, n_modes key frames will be created; if transition already has key frames, modes must have at least as many elements as the number of key frames.

Since cluttermm 1.12:

Parameters

n_modes	The number of easing modes.
modes	An array of easing modes, one for each key frame.

template <typename ValueType >

void Clutter::KeyFrameTransition::set_values ( const std::vector< ValueType > & values)

Sets the values for each key frame inside transition.

If transition does not hold any key frame, n_values key frames will be created; if transition already has key frames, values must have at least as many elements as the number of key frames.

Since cluttermm 1.12:

Parameters

n_values	The number of values.
values	An array of values, one for each key frame.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::KeyFrameTransition > wrap	(	ClutterKeyframeTransition *	object,
		bool	take_copy = `false`
	)

A Glib::wrap() method for this object.

Parameters

object	The C instance.
take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns: A C++ instance that wraps this C instance.

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

cluttermm/keyframe-transition.h

cluttermm: Clutter::KeyFrameTransition Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation