Back to Seed Clases

Clutter

Classes

Interfaces

Structs

Unions

Event

Enums

GObject.Object
parent-child marker GObject.InitiallyUnowned
Clutter.Path

Class Clutter.Path

Import line:	Clutter = imports.gi.Clutter;
GIR File:	Clutter-1.0.gir
C documentation:	ClutterPath
Class :	Path
Extends:	GObject.InitiallyUnowned

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

Properties
Properties		Defined By
	description : String	Clutter.Path
	g_type_instance : GObject.TypeInstance	GObject.InitiallyUnowned
	length : guint32 read only	Clutter.Path
	parent : GObject.InitiallyUnowned read only	Clutter.Path
	priv : Clutter.PathPrivate read only	Clutter.Path
	qdata : GLib.Data read only	GObject.InitiallyUnowned
	ref_count : guint32 read only	GObject.InitiallyUnowned

Methods / Constructors
Method / Constructor		Defined By
	new Clutter.Path (Object *properties) Create a new Clutter.Path Create a new Clutter.Path Parameters: Object properties*
	new Clutter.Path.with_description (String *desc) : Clutter.Path Create a new Clutter.Path Create a new Clutter.Path Parameters: String desc* Required (not null) a string describing the path Returns: Clutter.Path the newly created ClutterPath
	add_cairo_path (Path *cpath) : none Add the nodes of the Cairo path to the end of path. Add the nodes of the Cairo path to the end of path. Parameters: cairo.Path cpath* Required (not null) a Cairo path Returns: none	Clutter.Path
	add_close () : none Adds a CLUTTER_PATH_CLOSE type node to the 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. Returns: none	Clutter.Path
	add_curve_to (gint32 *x_1, gint32 y_1, gint32 x_2, gint32 y_2, gint32 x_3, gint32 y_3) : none Adds a CLUTTER_PATH_CURVE_TO* type node to the path. 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. Parameters: gint32 x_1 Required (not null) the x coordinate of the first control point gint32 y_1 Required (not null) the y coordinate of the first control point gint32 x_2 Required (not null) the x coordinate of the second control point gint32 y_2 Required (not null) the y coordinate of the second control point gint32 x_3 Required (not null) the x coordinate of the third control point gint32 y_3 Required (not null) the y coordinate of the third control point Returns: none	Clutter.Path
	add_line_to (gint32 x, gint32 y) : none Adds a CLUTTER_PATH_LINE_TO type node to the path. 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. Parameters: gint32 x Required (not null) the x coordinate gint32 y Required (not null) the y coordinate Returns: none	Clutter.Path
	add_move_to (gint32 x, gint32 y) : none Adds a CLUTTER_PATH_MOVE_TO type node to the path. 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. Parameters: gint32 x Required (not null) the x coordinate gint32 y Required (not null) the y coordinate Returns: none	Clutter.Path
	add_node (PathNode *node) : none Adds node* to the end of the path. Adds node to the end of the path. Parameters: Clutter.PathNode node Required (not null) a ClutterPathNode Returns: none	Clutter.Path
	add_rel_curve_to (gint32 *x_1, gint32 y_1, gint32 x_2, gint32 y_2, gint32 x_3, gint32 y_3) : none Same as clutter_path_add_curve_to() except the coordinates are relative to the previous node. Same as clutter_path_add_curve_to() except the coordinates are relative to the previous node. Parameters: gint32 x_1* Required (not null) the x coordinate of the first control point gint32 y_1 Required (not null) the y coordinate of the first control point gint32 x_2 Required (not null) the x coordinate of the second control point gint32 y_2 Required (not null) the y coordinate of the second control point gint32 x_3 Required (not null) the x coordinate of the third control point gint32 y_3 Required (not null) the y coordinate of the third control point Returns: none	Clutter.Path
	add_rel_line_to (gint32 x, gint32 y) : none Same as clutter_path_add_line_to() except the coordinates are relative to the previous node. Same as clutter_path_add_line_to() except the coordinates are relative to the previous node. Parameters: gint32 x Required (not null) the x coordinate gint32 y Required (not null) the y coordinate Returns: none	Clutter.Path
	add_rel_move_to (gint32 x, gint32 y) : none Same as clutter_path_add_move_to() except the coordinates are relative to the previous node. Same as clutter_path_add_move_to() except the coordinates are relative to the previous node. Parameters: gint32 x Required (not null) the x coordinate gint32 y Required (not null) the y coordinate Returns: none	Clutter.Path
	add_string (String *str) : gboolean Adds new nodes to the end of the path as described in 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: M Adds a CLUTTER_PATH_MOVE_TO* node. Takes one pair of coordinates. L Adds a CLUTTER_PATH_LINE_TO node. Takes one pair of coordinates. C Adds a CLUTTER_PATH_CURVE_TO node. Takes three pairs of coordinates. z Adds a CLUTTER_PATH_CLOSE node. No coordinates are needed. 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: 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. otherwise. Parameters: String str Required (not null) a string describing the new nodes Returns: gboolean TRUE is the path description was valid or FALSE	Clutter.Path
	clear () : none Removes all nodes from the path. Removes all nodes from the path. Returns: none	Clutter.Path
	foreach (Function *callback, void *user_data) : none Calls a function for each node of the path. Calls a function for each node of the path. Parameters: Function (PathNode node, void *data) : none Required (not null) the function to call with each node void user_data Required (not null) user data to pass to the function Returns: none	Clutter.Path
	get_description () : String Returns a newly allocated string describing the path in the same format as used by clutter_path_add_string(). Returns a newly allocated string describing the path in the same format as used by clutter_path_add_string(). Returns: String a string description of the path. Free with g_free().	Clutter.Path
	get_length () : guint32 Retrieves an approximation of the total length of the path. Retrieves an approximation of the total length of the path. Returns: guint32 the length of the path.	Clutter.Path
	get_n_nodes () : guint32 Retrieves the number of nodes in the path. Retrieves the number of nodes in the path. Returns: guint32 the number of nodes.	Clutter.Path
	get_node (guint32 *index_, PathNode node) : none Retrieves the node of the path indexed by index. Retrieves the node of the path indexed by index. Parameters: guint32 index_* Required (not null) the node number to retrieve Clutter.PathNode node Required (not null) a location to store a copy of the node Returns: none	Clutter.Path
	get_nodes () : Array Returns a GSList of ClutterPathNodes. 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. Returns: Array a list of nodes in the path.	Clutter.Path
	get_position (gdouble *progress, Knot position) : guint32 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. 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. Parameters: gdouble progress Required (not null) a position along the path as a fraction of its length Clutter.Knot position Required (not null) location to store the position Returns: guint32 index of the node used to calculate the position.	Clutter.Path
	insert_node (gint32 *index_, PathNode node) : none Inserts node* into the path before the node at the given offset. Inserts node into the path before the node at the given offset. If Parameters: gint32 index_ Required (not null) offset of where to insert the node Clutter.PathNode node Required (not null) the node to insert Returns: none	Clutter.Path
	remove_node (guint32 *index_) : none Removes the node at the given offset from the path. Removes the node at the given offset from the path. Parameters: guint32 index_* Required (not null) index of the node to remove Returns: none	Clutter.Path
	replace_node (guint32 *index_, PathNode node) : none Replaces the node at offset index_* with node. Replaces the node at offset index_ with node. Parameters: guint32 index_ Required (not null) index to the existing node Clutter.PathNode node Required (not null) the replacement node Returns: none	Clutter.Path
	set_description (String *str) : gboolean Replaces all of the nodes in the path with nodes described by If the string is invalid then FALSE* is returned and the path is unaltered. Replaces all of the nodes in the path with nodes described by If the string is invalid then FALSE is returned and the path is unaltered. Parameters: String str Required (not null) a string describing the path Returns: gboolean TRUE is the path was valid, FALSE otherwise.	Clutter.Path
	to_cairo_path (Context cr) : none Add the nodes of the ClutterPath to the path in the Cairo context. Add the nodes of the ClutterPath to the path in the Cairo context. Parameters: cairo.Context cr Required (not null) a Cairo context Returns: none	Clutter.Path

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Clutter.BehaviourPath Property	path : Clutter.Path
Clutter.BehaviourPath Method	new Clutter.BehaviourPath.c_new (Alpha *alpha, Path path*) : Clutter.Behaviour Create a new Clutter.BehaviourPath
Clutter.BehaviourPath Method	get_path () : Clutter.Path Get the current path of the behaviour
Clutter.BehaviourPath Method	set_path (Path *path*) : none Change the path that the actors will follow.
Clutter.PathConstraint Property	path : Clutter.Path
Clutter.PathConstraint Method	new Clutter.PathConstraint.c_new (Path *path, gfloat offset*) : Clutter.Constraint Create a new Clutter.PathConstraint
Clutter.PathConstraint Method	get_path () : Clutter.Path
Clutter.PathConstraint Method	set_path (Path *path*) : none

Un-official Seed Documentation

Clutter

Classes

Interfaces

Structs

Unions

Enums

Class Clutter.Path