This file includes all the functions for working with key frames (keyframes system). More...

#include "basic.h"

Include dependency graph for keyframe.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	keyframe
	This structure represents an inserted key frame. More...
struct	mvalue
	This structure is generated for each animated variable. More...
Defines
#define	DelFrameData(a, b) DelFrameValue((a), (b))
#define	DelFrame(a, b) DelFrameValue((a), (b))
#define	MVALUE(x) ((mvalue*)x)
	Converts the frame of a layer (frame calculated from the beginning of the layer, with some adjustment in fps) for the composition frame (from the beginning of the composition)
#define	KEYFRAME(x) ((keyframe*)x)
	Converts a pointer to keyframe*.
Typedefs
typedef struct keyframe	keyframe
typedef struct mvalue	mvalue
Functions
gint	FrameComp (gconstpointer a, gconstpointer b)
	This function compares the number of frame, of two key frames.
gint	FrameFind (gconstpointer a, gconstpointer b)
	Checks if two keyframe structures are to the same frame.
gint	ValueFind (gconstpointer a, gconstpointer b)
	Checks if a pointer to gdouble (argument b) is contained in the structure mvalue (argument a)
gdouble *	AddAnimatedValue ()
	Returns a pointer, which is updated every frame, and support, insertion and deletion of key frames.
mvalue *	FindAnmFromD (const gdouble *d)
	Get the structure mvalue from mvalue::v.
void	AddFrameData (mvalue *value, guint32 frame, gpointer data, guint32 len)
	Adds a key frame, containing some custom data.
void	AddFrameValue (mvalue *value, guint32 frame, gdouble v)
	Adds a key frame containing a given value (floating point).
void	DelFrameValue (mvalue *value, guint32 frame)
	Deletes a key frame (keyframe), of structure mvalue.
void	InsertFrame (gdouble *d)
	Inserts the current value of the variable in a key frame, generated from the current frame.
void	InsertPluginFrame (iPlugin p, gdouble d)
	Insert a key frame, in the frame number of the layer (Layer::frame). Using the pointer to this layer (iPlugin::layer). The value to be inserted in, key frame, is "gdouble* d".
void	DelFramel (gdouble *d)
	Deletes the current frame (keyframe), of this, animated variable (if any).
void	DelPluginFrame (iPlugin p, gdouble d)
	Delete the current key frame , from a, animated variable.
void	AnimateValues (guint32 frame)
	Sets the value of all animated variables for a given frame.
void	PluginFrame ()
	Calls the function IPlugin::Frame, for all plugins. But also makes the necessary adjustments.
void	RenderFrame ()
	Merge the layers, considering its rotation, scaling and opacity.
void	Frame ()
	This function must be called every time you need to process a frame.

Detailed Description

This file includes all the functions for working with key frames (keyframes system).

This system allows you to create two types of variables, one is gdouble, and the other is a pointer to the stored memory. The data obtained on this system may change every frame. In the case of a gdouble, for example, if I insert 1 in the first frame and insert 2 for the tenth frame. If the fifth frame is being rendered, the value is 1.5. The value of this variable. in the first frame will be 1, and in the last frame, will be 2. This is done automatically by the key frames system. Besides the support gdouble, there is support for gpointer. Support for gpointer every frame instead of a number, put something customized in memory. For example: In the first frame insert John, Mary in the third. The first frame will be John, John in the second, and in the third frame, Mary. Remember that this file does not work only with keyframes, with other things related to frames, too. For more details, see Wikipedia: http://en.wikipedia.org/wiki/Keyframe

Define Documentation

#define DelFrame	(	a,
		b
	)	DelFrameValue((a), (b))

#define DelFrameData	(	a,
		b
	)	DelFrameValue((a), (b))

#define KEYFRAME ( x ) ((keyframe*)x)

Converts a pointer to keyframe*.

Author:: Fabio J. Gonzalez

#define MVALUE ( x ) ((mvalue*)x)

Converts the frame of a layer (frame calculated from the beginning of the layer, with some adjustment in fps) for the composition frame (from the beginning of the composition)

Author:: Fabio J. Gonzalez

Converts a pointer to mvalue*.

Author:: Fabio J. Gonzalez

Typedef Documentation

typedef struct keyframe keyframe

typedef struct mvalue mvalue

Function Documentation

gdouble* AddAnimatedValue ( )

Returns a pointer, which is updated every frame, and support, insertion and deletion of key frames.

Author:: Fabio J. Gonzalez

Here is the caller graph for this function:

void AddFrameData	(	mvalue *	value,
		guint32	frame,
		gpointer	data,
		guint32	len
	)

Adds a key frame, containing some custom data.

Author:: Fabio J. Gonzalez

Here is the call graph for this function:

Here is the caller graph for this function:

void AddFrameValue	(	mvalue *	value,
		guint32	frame,
		gdouble	v
	)

Adds a key frame containing a given value (floating point).

Author:: Fabio J. Gonzalez

Here is the call graph for this function:

Here is the caller graph for this function:

void AnimateValues ( guint32 frame )

Sets the value of all animated variables for a given frame.

This function is entered from the key frames, leaves all, animated variables, with the appropriate value for this frame (the value of key frames, or some intermediate point between them).

Author:: Fabio J. Gonzalez

Here is the caller graph for this function:

void DelFramel ( gdouble * d )

Deletes the current frame (keyframe), of this, animated variable (if any).

Author:: Fabio J. Gonzalez

Here is the call graph for this function:

void DelFrameValue	(	mvalue *	value,
		guint32	frame
	)

Deletes a key frame (keyframe), of structure mvalue.

Author:: Fabio J. Gonzalez

Here is the call graph for this function:

Here is the caller graph for this function:

void DelPluginFrame	(	iPlugin *	p,
		gdouble *	d
	)

Delete the current key frame , from a, animated variable.

Author:: Fabio J. Gonzalez

Here is the call graph for this function:

Here is the caller graph for this function:

mvalue* FindAnmFromD ( const gdouble * d )

Get the structure mvalue from mvalue::v.

Author:: Fabio J. Gonzalez

Here is the call graph for this function:

Here is the caller graph for this function:

void Frame ( )

This function must be called every time you need to process a frame.

In other words, this function is called every time you need to show a frame of the composition to User. As well, every frame that you need to write in a video file. Used only internally, the function Frame (IPlugin::Frame) of a plugin can not call. If the function of a Frame plugin (IPlugin::Frame) call, you can get in the loop without end.

Author:: Fabio J. Gonzalez

Here is the call graph for this function:

Here is the caller graph for this function:

gint FrameComp	(	gconstpointer	a,
		gconstpointer	b
	)

This function compares the number of frame, of two key frames.

Both arguments of this function must be pointers to key frames (keyframe structure). If the number of frame (keyframe::frame), the first keyframe, is less than the second, returns -1. If the number of the second frame is greater than the first, returns 1. If both are equal, it returns 0.

Author:: Fabio J. Gonzalez

Here is the caller graph for this function:

gint FrameFind	(	gconstpointer	a,
		gconstpointer	b
	)

Checks if two keyframe structures are to the same frame.

The advantage of using this structure is that we can find a key frame, and only frame number of it (aided by function, customized search, of glib). If the frames of the two key frames, are equal, it returns 0.

Author:: Fabio J. Gonzalez

Here is the caller graph for this function:

void InsertFrame ( gdouble * d )

Inserts the current value of the variable in a key frame, generated from the current frame.

Author:: Fabio J. Gonzalez

Here is the call graph for this function:

void InsertPluginFrame	(	iPlugin *	p,
		gdouble *	d
	)

Insert a key frame, in the frame number of the layer (Layer::frame). Using the pointer to this layer (iPlugin::layer). The value to be inserted in, key frame, is "gdouble* d".