ClutterPathCallback ()

void
(*ClutterPathCallback) (const ClutterPathNode *node,
                        gpointer data);

This function is passed to clutter_path_foreach() and will be called for each node contained in the path.

Since: 1.0

clutter_path_new ()

ClutterPath *
clutter_path_new (void);

Creates a new ClutterPath instance with no nodes.

The object has a floating reference so if you add it to a ClutterBehaviourPath then you do not need to unref it.

Since: 1.0

clutter_path_new_with_description ()

ClutterPath *
clutter_path_new_with_description (const gchar *desc);

Creates a new ClutterPath instance with the nodes described in desc . See clutter_path_add_string() for details of the format of the string.

The object has a floating reference so if you add it to a ClutterBehaviourPath then you do not need to unref it.

Since: 1.0

clutter_path_add_move_to ()

void
clutter_path_add_move_to (ClutterPath *path,
                          gint x,
                          gint y);

Adds a CLUTTER_PATH_MOVE_TO type node to the path. This is usually used as the first node in a path. It can also be used in the middle of the path to cause the actor to jump to the new coordinate.

Since: 1.0

clutter_path_add_rel_move_to ()

void
clutter_path_add_rel_move_to (ClutterPath *path,
                              gint x,
                              gint y);

Same as clutter_path_add_move_to() except the coordinates are relative to the previous node.

Since: 1.0

clutter_path_add_line_to ()

void
clutter_path_add_line_to (ClutterPath *path,
                          gint x,
                          gint y);

Adds a CLUTTER_PATH_LINE_TO type node to the path. This causes the actor to move to the new coordinates in a straight line.

Since: 1.0

clutter_path_add_rel_line_to ()

void
clutter_path_add_rel_line_to (ClutterPath *path,
                              gint x,
                              gint y);

Same as clutter_path_add_line_to() except the coordinates are relative to the previous node.

Since: 1.0

clutter_path_add_curve_to ()

void
clutter_path_add_curve_to (ClutterPath *path,
                           gint x_1,
                           gint y_1,
                           gint x_2,
                           gint y_2,
                           gint x_3,
                           gint y_3);

Adds a CLUTTER_PATH_CURVE_TO type node to the path. This causes the actor to follow a bezier from the last node to (x_3 , y_3 ) using (x_1 , y_1 ) and (x_2 ,y_2 ) as control points.

Since: 1.0

clutter_path_add_rel_curve_to ()

void
clutter_path_add_rel_curve_to (ClutterPath *path,
                               gint x_1,
                               gint y_1,
                               gint x_2,
                               gint y_2,
                               gint x_3,
                               gint y_3);

Same as clutter_path_add_curve_to() except the coordinates are relative to the previous node.

Since: 1.0

clutter_path_add_close ()

void
clutter_path_add_close (ClutterPath *path);

Adds a CLUTTER_PATH_CLOSE type node to the path. This creates a straight line from the last node to the last CLUTTER_PATH_MOVE_TO type node.

Since: 1.0

clutter_path_add_string ()

gboolean
clutter_path_add_string (ClutterPath *path,
                         const gchar *str);

Adds new nodes to the end of the path as described in str . The format is a subset of the SVG path format. Each node is represented by a letter and is followed by zero, one or three pairs of coordinates. The coordinates can be separated by spaces or a comma. The types are:

The M, L and C commands can also be specified in lower case which means the coordinates are relative to the previous node.

For example, to move an actor in a 100 by 100 pixel square centered on the point 300,300 you could use the following path:

1

M 250,350 l 0 -100 L 350,250 l 0 100 z

If the path description isn't valid FALSE will be returned and no nodes will be added.

Since: 1.0

clutter_path_add_node ()

void
clutter_path_add_node (ClutterPath *path,
                       const ClutterPathNode *node);

Adds node to the end of the path.

Since: 1.0

clutter_path_add_cairo_path ()

void
clutter_path_add_cairo_path (ClutterPath *path,
                             const cairo_path_t *cpath);

Add the nodes of the Cairo path to the end of path .

Since: 1.0

clutter_path_get_n_nodes ()

guint
clutter_path_get_n_nodes (ClutterPath *path);

Retrieves the number of nodes in the path.

Since: 1.0

clutter_path_get_node ()

void
clutter_path_get_node (ClutterPath *path,
                       guint index_,
                       ClutterPathNode *node);

Retrieves the node of the path indexed by index .

Since: 1.0

clutter_path_get_nodes ()

GSList *
clutter_path_get_nodes (ClutterPath *path);

Returns a GSList of ClutterPathNodes. The list should be freed with g_slist_free(). The nodes are owned by the path and should not be freed. Altering the path may cause the nodes in the list to become invalid so you should copy them if you want to keep the list.

Since: 1.0

clutter_path_foreach ()

void
clutter_path_foreach (ClutterPath *path,
                      ClutterPathCallback callback,
                      gpointer user_data);

Calls a function for each node of the path.

Since: 1.0

clutter_path_insert_node ()

void
clutter_path_insert_node (ClutterPath *path,
                          gint index_,
                          const ClutterPathNode *node);

Inserts node into the path before the node at the given offset. If index_ is negative it will append the node to the end of the path.

Since: 1.0

clutter_path_remove_node ()

void
clutter_path_remove_node (ClutterPath *path,
                          guint index_);

Removes the node at the given offset from the path.

Since: 1.0

clutter_path_replace_node ()

void
clutter_path_replace_node (ClutterPath *path,
                           guint index_,
                           const ClutterPathNode *node);

Replaces the node at offset index_ with node .

Since: 1.0

clutter_path_get_description ()

gchar *
clutter_path_get_description (ClutterPath *path);

Returns a newly allocated string describing the path in the same format as used by clutter_path_add_string().

Since: 1.0

clutter_path_set_description ()

gboolean
clutter_path_set_description (ClutterPath *path,
                              const gchar *str);

Replaces all of the nodes in the path with nodes described by str . See clutter_path_add_string() for details of the format.

If the string is invalid then FALSE is returned and the path is unaltered.

Since: 1.0

clutter_path_to_cairo_path ()

void
clutter_path_to_cairo_path (ClutterPath *path,
                            cairo_t *cr);

Add the nodes of the ClutterPath to the path in the Cairo context.

Since: 1.0

clutter_path_clear ()

void
clutter_path_clear (ClutterPath *path);

Removes all nodes from the path.

Since: 1.0

clutter_path_get_position ()

guint
clutter_path_get_position (ClutterPath *path,
                           gdouble progress,
                           ClutterKnot *position);

The value in progress represents a position along the path where 0.0 is the beginning and 1.0 is the end of the path. An interpolated position is then stored in position .

Since: 1.0

clutter_path_get_length ()

guint
clutter_path_get_length (ClutterPath *path);

Retrieves an approximation of the total length of the path.

Since: 1.0

clutter_path_node_copy ()

ClutterPathNode *
clutter_path_node_copy (const ClutterPathNode *node);

Makes an allocated copy of a node.

Since: 1.0

clutter_path_node_free ()

void
clutter_path_node_free (ClutterPathNode *node);

Frees the memory of an allocated node.

Since: 1.0

clutter_path_node_equal ()

gboolean
clutter_path_node_equal (const ClutterPathNode *node_a,
                         const ClutterPathNode *node_b);

Compares two nodes and checks if they are the same type with the same coordinates.

Since: 1.0

ClutterPath

typedef struct _ClutterPath ClutterPath;

The ClutterPath struct contains only private data and should be accessed with the functions below.

Since: 1.0

struct ClutterPathClass

struct ClutterPathClass {
};

The ClutterPathClass struct contains only private data.

Since: 1.0

enum ClutterPathNodeType

Types of nodes in a ClutterPath.

Since: 1.0

struct ClutterPathNode

struct ClutterPathNode {
  ClutterPathNodeType type;

  ClutterKnot points[3];
};

Represents a single node of a ClutterPath.

Some of the coordinates in points may be unused for some node types. CLUTTER_PATH_MOVE_TO and CLUTTER_PATH_LINE_TO use only one pair of coordinates, CLUTTER_PATH_CURVE_TO uses all three and CLUTTER_PATH_CLOSE uses none.

Since: 1.0

The “description” property

  “description”              gchar *

SVG-style description of the path.

Flags: Read / Write

Default value: ""

The “length” property

  “length”                   guint

An approximation of the total length of the path.

Flags: Read

Default value: 0